GenICamDevice Class Reference

A device representing a GenICam compliant device. More...

#include <cvb/driver/genicam_device.hpp>

Inherits Device.

Public Member Functions
template<class T >
std::shared_ptr< T >	Stream (int index) const
	Get the stream for this device by index. More...
template<class T >
std::shared_ptr< T >	Stream () const
	Get the first stream for this device. More...
StreamPtr	Stream () const override
	Get the stream for this device. More...
Public Member Functions inherited from Device
void *	Handle () const noexcept
	Classic API device handle. More...
String	ResourceLocator () const noexcept
	Gets the access token or path of the file name including its extension. More...
DeviceControlPtr	DeviceControl () const
	Gets the DeviceControl interface if present. More...
DigitalIOPtr	DigitalIO () const
	Gets the DigitalIO interface if present. More...
SoftwareTriggerPtr	SoftwareTrigger () const
	Gets the SoftwareTrigger interface if present. More...
ImageRectPtr	ImageRect () const
	Gets the ImageRect interface if present. More...
virtual StreamPtr	Stream () const
	Get the stream for this device. More...
int	StreamCount () const noexcept
	Get the number of streams. More...
template<class T >
std::shared_ptr< T >	DeviceImage () const
	Gets, if available, the device image pointing to the last synchronized image. More...
DeviceImagePtr	DeviceImage () const
	Gets, if available, the device image pointing to the latest synchronized image. More...
NodeMapPtr	NodeMap (const String &name) const
	Gets the NodeMap with the given name. More...
std::map< String, NodeMapPtr >	NodeMaps () const
	Gets the dictionary holding all available NodeMaps. More...
NotifyObservablePtr	NotifyObservable (int id) const
	Get the observable for a given id. More...
Cvb::ConnectionState	ConnectionState () const noexcept
	brief Gets the current Cvb::ConnectionState of this Device object.
EventCookie	RegisterConnectionStateChangedEvent (std::function< void()> handler)
	Register a listener to the OnDisconnect event. More...
void	UnregisterConnectionStateChangedEvent (EventCookie eventCookie) noexcept
	Manually unregister a listener to the OnDisconnect event. More...

Detailed Description

A device representing a GenICam compliant device.

GenICam devices require a transport layer to acquire data.

Member Function Documentation

Stream() [1/3]

std::shared_ptr< T > Stream ( ) const

inlinevirtual

Get the first stream for this device.

Note

This method is only supported by GenICamDevice

Returns

Pointer to the stream object.

Exceptions

Any	exception derived from std::exception including CvbException.

Reimplemented from Device.

Stream() [2/3]

StreamPtr Stream ( ) const

inlineoverridevirtual

Get the stream for this device.

Note

This method is not supported by GenICamDevice.

Deprecated:

This method is deprecated for all technologies providing a GenTL. Use the template version with ImageStream, PointCloudStream or CompositeStream instead.

Returns

Pointer to the stream object.

Exceptions

Any	exception derived from std::exception including CvbException.

Reimplemented from Device.

Stream() [3/3]

std::shared_ptr< T > Stream ( int  index ) const

inline

Get the stream for this device by index.

Note

This method is only supported by GenICamDevice

Returns

Pointer to the stream object.

Exceptions

Any	exception derived from std::exception including CvbException.