Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvVirtualDeviceGEV Class Reference

Virtual GigE Vision device. More...

Public Member Functions

 PvVirtualDeviceGEV ()
 Constructor.
 
 ~PvVirtualDeviceGEV ()
 Destructor.
 
PvResult SetGEVSpecificationVersion (uint16_t aMajor, uint16_t aMinor)
 Set the version of the GigE Vision standard for the virtual GigE Vision device to use. More...
 
PvResult GetGEVSpecificationVersion (uint16_t &aMajor, uint16_t &aMinor)
 Get the current version of the GigE Vision standard that is being used by the virtual GigE Vision device. More...
 
PvResult SetGVCPCapabilityPacketResendCommandSupported (bool aValue)
 Configure the virtual GigE Vision device to support the packet resend command. More...
 
bool GetGVCPCapabilityPacketResendCommandSupported ()
 Get the current configuration for the packet resend command support. More...
 
PvResult SetDeviceVersion (const PvString &aDeviceVersion)
 Set the device version. More...
 
PvString GetDeviceVersion ()
 Get the device version. More...
 
PvResult SetSerialNumber (const PvString &aSerialNumber)
 Set the serial number string. More...
 
PvString GetSerialNumber ()
 Get the serial number. More...
 
PvResult SetManufacturerName (const PvString &aManufacturerName)
 Set the manufacturer name string. More...
 
PvString GetManufacturerName ()
 Get the manufacturer name. More...
 
PvResult SetModelName (const PvString &aModelName)
 Set the model name string. More...
 
PvString GetModelName ()
 Get the model name. More...
 
PvResult AddTransmitterGEV (IPvTransmitterGEV *aTransmitterGEV)
 Add the GVSP transmitter that will issue the resend requests. More...
 
PvResult StartListening (PvString aIPAddress)
 Begin responding to GVCP traffic on the specified network interface. More...
 
void StopListening ()
 Stop responding to GVCP traffic and close the connection.
 
uint32_t GetDevicePortThreadPriority () const
 Get the priority of the thread used for GigE Vision control channel. More...
 
PvResult SetDevicePortThreadPriority (uint32_t aPriority)
 Set the priority of the thread used for GigE Vision control channel. More...
 

Detailed Description

Virtual GigE Vision device.

Used to provide basic GigE Vision device capabilities such as device discovery. Can complement the PvTransmitterGEV class by allowing one to open a data receiver connection to it using PvStream.

For a full Software GigE Vision Device implementation, look at PvSoftDeviceGEV.

Proper use of the PvVirtualDeviceGEV class is demonstrated in all transmitter samples.

Member Function Documentation

◆ AddTransmitterGEV()

PvResult PvVirtualDeviceGEV::AddTransmitterGEV ( IPvTransmitterGEV aTransmitterGEV)

Add the GVSP transmitter that will issue the resend requests.

The order of addition will enforce the stream index.

Parameters
[in]aTransmitterGEVInstance of PvTransmitterGEV.
Note
Must be set before calling the StartListening function.
Returns
Includes:

◆ GetDevicePortThreadPriority()

uint32_t PvVirtualDeviceGEV::GetDevicePortThreadPriority ( ) const

Get the priority of the thread used for GigE Vision control channel.

See SetDevicePortThreadPriority for details about the meaning of the values returned

Returns
The priority of the thread

◆ GetDeviceVersion()

PvString PvVirtualDeviceGEV::GetDeviceVersion ( )

Get the device version.

See SetDeviceVersion for information about the return values.

Returns
A string containing the device version.

◆ GetGEVSpecificationVersion()

PvResult PvVirtualDeviceGEV::GetGEVSpecificationVersion ( uint16_t &  aMajor,
uint16_t &  aMinor 
)

Get the current version of the GigE Vision standard that is being used by the virtual GigE Vision device.

Parameters
[in]aMajorMajor version.
[in]aMinorMinor version.
Returns
Includes:

◆ GetGVCPCapabilityPacketResendCommandSupported()

bool PvVirtualDeviceGEV::GetGVCPCapabilityPacketResendCommandSupported ( )

Get the current configuration for the packet resend command support.

See SetGVCPCapabilityPacketResendCommandSupported for information about the return values.

Returns
Includes:

◆ GetManufacturerName()

PvString PvVirtualDeviceGEV::GetManufacturerName ( )

Get the manufacturer name.

Returns
A string containing the manufacturer name.

◆ GetModelName()

PvString PvVirtualDeviceGEV::GetModelName ( )

Get the model name.

Returns
A string containing the model name.

◆ GetSerialNumber()

PvString PvVirtualDeviceGEV::GetSerialNumber ( )

Get the serial number.

Returns
A string containing the serial number.

◆ SetDevicePortThreadPriority()

PvResult PvVirtualDeviceGEV::SetDevicePortThreadPriority ( uint32_t  aPriority)

Set the priority of the thread used for GigE Vision control channel.

This thread listening for the virtual device on the GigE Vision control channel. Handles read register, device discoveries, etc.

If you change the thread priorities, it may alterate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities.

See GetDevicePortThreadPriority

Parameters
[in]aPrioritySee PvPipeline::SetBufferHandlingThreadPriority for description of the supported values
Returns
Includes:

◆ SetDeviceVersion()

PvResult PvVirtualDeviceGEV::SetDeviceVersion ( const PvString aDeviceVersion)

Set the device version.

Only the first 32 bytes will be used.

Parameters
[in]aDeviceVersionNew version number.
Note
Must be set before calling the StartListening function.
Returns
Includes:

◆ SetGEVSpecificationVersion()

PvResult PvVirtualDeviceGEV::SetGEVSpecificationVersion ( uint16_t  aMajor,
uint16_t  aMinor 
)

Set the version of the GigE Vision standard for the virtual GigE Vision device to use.

By default, version 2.0 of the standard is used. This version of the standard provides access to the latest features, including extended chunk data.

Note
Must be set before calling the StartListening function.
Parameters
[in]aMajorMajor version number of the GigE Vision standard.
[in]aMinorMinor version number of the GigE Vision standard.
Returns
Includes:

◆ SetGVCPCapabilityPacketResendCommandSupported()

PvResult PvVirtualDeviceGEV::SetGVCPCapabilityPacketResendCommandSupported ( bool  aValue)

Configure the virtual GigE Vision device to support the packet resend command.

This parameter can only be used for virtual GigE Vision devices that use version 2.0 (or later) of the GigE Vision standard. By default, the native ID types for the GigE Vision standard are always used.

Note
Must be set before calling the StartListening function.
Parameters
[in]aValueTrue to support packet resend commands.
Returns
Includes:

◆ SetManufacturerName()

PvResult PvVirtualDeviceGEV::SetManufacturerName ( const PvString aManufacturerName)

Set the manufacturer name string.

Only the first 32 bytes will be used.

Parameters
[in]aManufacturerNameManufacturer name string.
Note
Must be set before calling the StartListening function.
Returns
Includes:

◆ SetModelName()

PvResult PvVirtualDeviceGEV::SetModelName ( const PvString aModelName)

Set the model name string.

Only the first 32 bytes will be used.

Parameters
[in]aModelNameModel name string.
Note
Must be set before calling the StartListening function.
Returns
Includes:

◆ SetSerialNumber()

PvResult PvVirtualDeviceGEV::SetSerialNumber ( const PvString aSerialNumber)

Set the serial number string.

Only the first 16 bytes will be used.

Parameters
[in]aSerialNumberSerial number.
Note
Must be set before calling the StartListening function.
Returns
Includes:

◆ StartListening()

PvResult PvVirtualDeviceGEV::StartListening ( PvString  aIPAddress)

Begin responding to GVCP traffic on the specified network interface.

Parameters
[in]aIPAddressIP address the virtual device listens on. Use the form 192.168.1.114.

Note: A PvVirtualDeviceGEV object listens for traffic on one socket at a time. To listen for GVCP traffic on more than one network interface, instantiate another PvVirtualDeviceGEV object.

Returns
PvResult::Code::OK if successful.

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

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