Generic CVB physical device. More...
Inherits object.
Inherited by EmuDevice, GenICamDevice, NonStreamingDevice, VideoDevice, and VinDevice.
Public Member Functions | |
None | close (self) |
Closes the device and releases all hardware resources held. More... | |
cvb.EventCookie | register_connection_state_changed_event (self, Callable[[], None] handler) |
Register a listener to node updated event. More... | |
Union[cvb.ImageStream, cvb.PointCloudStream, cvb.CompositeStream] | stream (self, Type[cvb.ImageStream|cvb.PointCloudStream|cvb.CompositeStream] stream_type, int index=0) |
Gets the stream for this device by index. More... | |
Optional[Union[cvb.Stream, cvb.IndexedStream]] | stream (self) |
Gets the legacy stream for this device. More... | |
None | unregister_connection_state_changed_event (self, cvb.EventCookie event_cookie) |
Manually unregister a listener to the node updated event. More... | |
Properties | |
connection_state = property | |
int: Gets the current connection state (see cvb.ConnectionState). | |
device_control = property | |
Optional[cvb.DeviceControl]: Gets the DeviceControl interface if present. | |
device_image = property | |
Optional[cvb.DeviceImage]: Gets, if available, the device image pointing to the last synchronized image. | |
digital_io = property | |
Optional[cvb.DigitalIO]: Gets the DigitalIO interface if present. | |
image_rect = property | |
Optional[cvb.ImageRect]: Gets the ImageRect interface if present. | |
node_maps = property | |
Dict[str, Optional[cvb.NodeMap]]: Gets the dictionary holding all available NodeMaps. More... | |
resource_locator = property | |
str: Gets the access token or path of the file name including its extension. | |
software_trigger = property | |
Optional[cvb.SoftwareTrigger]: Gets the SoftwareTrigger interface if present. | |
stream_count = property | |
int: Get the number of streams. | |
Generic CVB physical device.
A device may provide an image stream or just expose a configuration interface.
See cvb.DeviceFactory for creating instances of this object.
None close | ( | self | ) |
Closes the device and releases all hardware resources held.
This will leave the python object as empty shell. Any further access, that requires resources, will throw.
cvb.EventCookie register_connection_state_changed_event | ( | self, | |
Callable[[], None] | handler | ||
) |
Register a listener to node updated event.
handler : Callable[[], None] Listener, to node updated event.
cvb.EventCookie Event cookie, to manually unregister the listener.
Optional[Union[cvb.Stream, cvb.IndexedStream]] stream | ( | self | ) |
Gets the legacy stream for this device.
Optional[Union[cvb.Stream, cvb.IndexedStream]] The stream object.
Union[cvb.ImageStream, cvb.PointCloudStream, cvb.CompositeStream] stream | ( | self, | |
Type[cvb.ImageStream| cvb.PointCloudStream| cvb.CompositeStream] | stream_type, | ||
int | index = 0 |
||
) |
Gets the stream for this device by index.
stream_type : Type[cvb.ImageStream| cvb.PointCloudStream| cvb.CompositeStream] Casts the result to this datatype.
index : int The index of the stream.
Union[cvb.ImageStream, cvb.PointCloudStream, cvb.CompositeStream] The stream object.
None unregister_connection_state_changed_event | ( | self, | |
cvb.EventCookie | event_cookie | ||
) |
Manually unregister a listener to the node updated event.
event_cookie : cvb.EventCookie Event cookie, obtained from registering the listener.
|
static |
Dict[str, Optional[cvb.NodeMap]]: Gets the dictionary holding all available NodeMaps.
Access a node map using cvb.NodeMapID, e.g. the GenTL device node map: