Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvSoftDeviceGEV Class Reference

Implements a software-based GigE Vision Device with full GVCP and GVSP support. More...

Public Member Functions

 PvSoftDeviceGEV ()
 Constructor.
 
virtual ~PvSoftDeviceGEV ()
 Destructor.
 
IPvSoftDeviceGEVInfoGetInfo ()
 Obtains the information interface of the PvSoftDeviceGEV. More...
 
PvResult AddStream (IPvStreamingChannelSource *aSource)
 Adds a new stream to the PvSoftDeviceGEV. More...
 
PvResult SetUserSetCount (uint32_t aCount)
 
PvResult SetPassthru (bool aPassthruEnabled, PvString aPassthruDevice)
 Create the device in Passthru mode. More...
 
PvResult SetMalformedXMLFile (PvString aMalformedXMLFile)
 Set a destination for malformed xml files. More...
 
PvResult SetTCPTransportEnabled (bool aEnabled)
 Enables experimental TCP transport. More...
 
PvResult SetRTPProtocolEnabled (bool aEnabled)
 Enables the option of using RTP for streaming. More...
 
PvResult SetStreamTimestamping (bool aEnabled)
 Enables stream timestamping on all sources. 'True' by default. More...
 
IPvRegisterMapGetRegisterMap ()
 Obtains the register map interface of the PvSoftDeviceGEV. More...
 
PvResult Start (const PvString &aMACAddress)
 Starts the PvSoftDeviceGEV. More...
 
PvResult Stop ()
 Stops the PvSoftDeviceGEV. More...
 
IPvSoftDeviceGEVStatisticsGetStatistics ()
 Obtains the statistics interface of the PvSoftDeviceGEV. More...
 
IPvMessageChannelGetMessagingChannel ()
 Obtains the messaging channel interface of the PvSoftDeviceGEV. More...
 
PvResult RegisterEventSink (IPvSoftDeviceGEVEventSink *aEventSink)
 Registers an event sink to receive notifications from the PvSoftDeviceGEV. More...
 
PvResult UnregisterEventSink (IPvSoftDeviceGEVEventSink *aEventSink)
 Unregisters a previously registered event sink. More...
 
PvResult GetGenICamXMLFile (PvString &aString) const
 Returns the GenICam XML file of the device. More...
 
- Public Member Functions inherited from IPvSoftDeviceGEV
virtual ~IPvSoftDeviceGEV ()
 Virtual destructor.
 

Protected Member Functions

 PvSoftDeviceGEV (PvVirtualDeviceLib::IFactory *aFactory)
 Protected Constructor. More...
 

Detailed Description

Implements a software-based GigE Vision Device with full GVCP and GVSP support.

Basic GigE Vision Device setup:

A more advanced GigE Vision Device setup:

Constructor & Destructor Documentation

◆ PvSoftDeviceGEV()

PvSoftDeviceGEV::PvSoftDeviceGEV ( PvVirtualDeviceLib::IFactory *  aFactory)
protected

Protected Constructor.

Parameters
[in]aFactoryThe factory object to instantiate the PvSoftDeviceGEV.

Member Function Documentation

◆ AddStream()

PvResult PvSoftDeviceGEV::AddStream ( IPvStreamingChannelSource aSource)
virtual

Adds a new stream to the PvSoftDeviceGEV.

All streams must be added before starting the PvSoftDeviceGEV.

Parameters
[in]aSourceInterface to a user-provided source.
Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ GetGenICamXMLFile()

PvResult PvSoftDeviceGEV::GetGenICamXMLFile ( PvString aString) const
virtual

Returns the GenICam XML file of the device.

Can be used to retrieve the GenICam XML file of the device after the Start method has been called. Can be used on success or failure of the Start method.

Parameters
aString[out] String where the XML file is copied.
Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ GetInfo()

IPvSoftDeviceGEVInfo * PvSoftDeviceGEV::GetInfo ( )
virtual

Obtains the information interface of the PvSoftDeviceGEV.

Only available after the PvSoftDeviceGEV has been started.

IPvSoftDeviceGEVInfo is used to set the information strings in the read-only bootstrap registers of the PvSoftDeviceGEV, such as Model Name, Vendor Name, etc.

Returns
Information interface of the PvSoftDeviceGEV or NULL if the device is not running.

Implements IPvSoftDeviceGEV.

◆ GetMessagingChannel()

IPvMessageChannel * PvSoftDeviceGEV::GetMessagingChannel ( )
virtual

Obtains the messaging channel interface of the PvSoftDeviceGEV.

The IPvMessageChannel interface can be used to send events on the messaging channel when a GigE Vision controller is connected to the PvSoftDeviceGEV and has properly set up a destination for messaging channel events.

See also
IPvMessageChannel

Only available after the PvSoftDeviceGEV has been started.

Returns
Messaging channel interface of the PvSoftDeviceGEV or NULL if the device is not running.

Implements IPvSoftDeviceGEV.

◆ GetRegisterMap()

IPvRegisterMap * PvSoftDeviceGEV::GetRegisterMap ( )
virtual

Obtains the register map interface of the PvSoftDeviceGEV.

Only available after the PvSoftDeviceGEV has been started.

IPvRegisterMap can be used to directly access the register map of the PvSoftDeviceGEV. It is also possible to subscribe to register read/write events using IPvSoftDeviceGEVEventSink.

See IPvSoftDeviceGEVEventSink::OnCreateCustomRegisters for information about adding custom registers to a PvSoftDeviceGEV.

Returns
Register map interface of the PvSoftDeviceGEV or NULL if the device is not running.

Implements IPvSoftDeviceGEV.

◆ GetStatistics()

IPvSoftDeviceGEVStatistics * PvSoftDeviceGEV::GetStatistics ( )
virtual

Obtains the statistics interface of the PvSoftDeviceGEV.

Only available after the PvSoftDeviceGEV has been started.

Returns
Statistics interface of the PvSoftDeviceGEV or NULL if the device is not running.

Implements IPvSoftDeviceGEV.

◆ RegisterEventSink()

PvResult PvSoftDeviceGEV::RegisterEventSink ( IPvSoftDeviceGEVEventSink aEventSink)
virtual

Registers an event sink to receive notifications from the PvSoftDeviceGEV.

This method can be called before the PvSoftDeviceGEV is started.

See also
IPvVirtualDeviceEventSink
Parameters
[in]aEventSinkPointer to a PvSoftDeviceGEV event sink.
Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ SetMalformedXMLFile()

PvResult PvSoftDeviceGEV::SetMalformedXMLFile ( PvString  aMalformedXMLFile)
virtual

Set a destination for malformed xml files.

Parameters
[in]aMaformedXMLFileFull path to where to store malformed xml file

Implements IPvSoftDeviceGEV.

◆ SetPassthru()

PvResult PvSoftDeviceGEV::SetPassthru ( bool  aPassthruEnabled,
PvString  aPassthruDevice 
)
virtual

Create the device in Passthru mode.

Parameters
[in]aPassthruEnbledSet to true to enable passthru behaviour.
[in]aPassthruDeviceDescription of Remote Device for passthru

Implements IPvSoftDeviceGEV.

◆ SetRTPProtocolEnabled()

PvResult PvSoftDeviceGEV::SetRTPProtocolEnabled ( bool  aEnabled)
virtual

Enables the option of using RTP for streaming.

PvSoftDeviceGEV supports optional RTP protocol for GigE Vision devices.

When RTP is enabled it can be selected as the protocol used to data transmission at the stream channel level of the GenApi interface of the device.

RTP supported is not covered by the GigE Vision specification. A GigE Vision Device actively streaming using RTP goes beyond the bounds covered by the GigE Vision standard.

The RTP implementation is however compliant with the RTP RFCs covering the transport of images (RFC 4175) and H.264 data (RFC 6184).

When a stream transmits using the RTP protocol, the stream is announced on a multicast channel (224.2.127.254:9875) using the SAP protocol with a SDP descriptor as required by the DEFSTAN 0082 specification.

Parameters
[in]aEnabledToggles RTP support.
Returns
PvResult::Code::OK

Implements IPvSoftDeviceGEV.

◆ SetStreamTimestamping()

PvResult PvSoftDeviceGEV::SetStreamTimestamping ( bool  aEnabled)

Enables stream timestamping on all sources. 'True' by default.

Buffers are timestamped by the acquisition manager. This method can be called with a 'False' value to skip timestamping when placing the buffers into the queue.

This method can be useful in a scenario where the original timestamp of the buffer needs to be preserved, or if the timestamp is updated externally (in the application). Doing so will prevent the acquisition manager to override the timestamp before transmission.

The method does not affect GenICam registers or message channel timestamps.

Parameters
[in]aEnabledToggles stream timestamping.
Returns
PvResult::Code::OK

◆ SetTCPTransportEnabled()

PvResult PvSoftDeviceGEV::SetTCPTransportEnabled ( bool  aEnabled)
virtual

Enables experimental TCP transport.

PvSoftDeviceGEV supports optional, experimental TCP transport for GigE Vision devices. It affects GVCP control, GVCP messaging channel and GVSP streaming.

When TCP is enabled the device still respond to UDP requests as usual. Additional TCP sockets are opened to optionally accept TCP connections from the host.

As long as TCP is not fully ratified by the GigE Vision specification, enabling TCP could and most likely will break GigE Vision compliance. It also means only the eBUS PvDeviceGEV and PvStreamGEV can be used to interact with the device when using TCP transport.

Parameters
[in]aEnabledToggles TCP support.
Returns
PvResult::Code::OK

Implements IPvSoftDeviceGEV.

◆ SetUserSetCount()

PvResult PvSoftDeviceGEV::SetUserSetCount ( uint32_t  aCount)
virtual

Selected registers handling in pseudo-code:

  • Save current selector of interest values
  • Set selectors to 1st combination
  • Call IPvRegisterStore::Persist with register and unique name suffix representing selector of interest values
  • Set selectors to 2nd combination
  • Call IPvRegisterStore::Persist with register and unique name suffix representing selector of interest values
  • ...
  • Restore selector values

The IPvRegisterStore::Persist method loads or saves the register content in the store using the feature name and provided suffix.

On startup the default user-set is always updated in the store from the fresh device status. If the UserSetDefault GenApi feature is assigned to a user-set other than Default, the user-set is automatically loaded on device startup.

The UserSetDefault GenApi feature is special: it is not saved to a user-set but is immediately and automatically persistent to the store whenever changed.

User-sets can be saved and loaded explicitly using the UserSetSelector, UserSetSave, and UserSetLoad GenApi features.

The UserSetFeatureSelector and UserSetFeatureEnable GenApi features can be used to control which features are saved to the user-sets. All features defined as Streamable when creating the GenICam XML file of the device should be available under the UserSetFeatureSelector enum feature.

Parameters
[in]aCountCount of user-sets supported, in addition to the default user-set.
Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ Start()

PvResult PvSoftDeviceGEV::Start ( const PvString aMACAddress)
virtual

Starts the PvSoftDeviceGEV.

Both GVCP and GVSP are operated from a background thread. Even though the Start method returns, the device is running in your process until you call Stop or until the object is destroyed.

Parameters
[in]aMACAddressMAC address of the interface to bind the PvSoftDeviceGEV to.
Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ Stop()

PvResult PvSoftDeviceGEV::Stop ( )
virtual

Stops the PvSoftDeviceGEV.

Returns
Includes:

Implements IPvSoftDeviceGEV.

◆ UnregisterEventSink()

PvResult PvSoftDeviceGEV::UnregisterEventSink ( IPvSoftDeviceGEVEventSink aEventSink)
virtual

Unregisters a previously registered event sink.

This method can be called before the PvSoftDeviceGEV is started and after it has been stopped.

Parameters
[in]aEventSinkPointer to a PvSoftDeviceGEV event sink.
Returns
Includes:

Implements IPvSoftDeviceGEV.


The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com