Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



IPvSoftDeviceGEVInfo Class Referenceabstract

Interface that is used to customize the identity of a software-based GigE Vision Device. More...

Public Member Functions

virtual ~IPvSoftDeviceGEVInfo ()
 Virtual destructor.
 
virtual const PvStringGetManufacturerName ()=0
 Returns the current manufacturer name. More...
 
virtual const PvStringGetModelName ()=0
 Returns the current model name. More...
 
virtual const PvStringGetDeviceVersion ()=0
 Returns the current PvSoftDeviceGEV version string. More...
 
virtual const PvStringGetDeviceFirmwareVersion ()=0
 Returns the current PvSoftDeviceGEV firmware version string. More...
 
virtual const PvStringGetManufacturerInformation ()=0
 Returns the current manufacturer information string. More...
 
virtual const PvStringGetSerialNumber ()=0
 Returns the current serial number string. More...
 
virtual PvResult SetManufacturerName (const PvString &aValue)=0
 Updates the manufacturer name string. More...
 
virtual PvResult SetModelName (const PvString &aValue)=0
 Updates the model name string. More...
 
virtual PvResult SetDeviceVersion (const PvString &aValue)=0
 Updates the device version string. More...
 
virtual PvResult SetDeviceFirmwareVersion (const PvString &aValue)=0
 Updates the device firmware version string. More...
 
virtual PvResult SetManufacturerInformation (const PvString &aValue)=0
 Updates the manufacturer information string. More...
 
virtual PvResult SetSerialNumber (const PvString &aValue)=0
 Updates the serial number string. More...
 
virtual uint16_t GetGenICamXMLVersionMajor () const =0
 Returns the GenICam XML file major version. More...
 
virtual uint16_t GetGenICamXMLVersionMinor () const =0
 Returns the GenICam XML file minor version. More...
 
virtual uint16_t GetGenICamXMLVersionSubMinor () const =0
 Returns the GenICam XML file subminor version. More...
 
virtual const PvStringGetGenICamXMLProductGUID ()=0
 Returns the GenICam XML file Product GUID. More...
 
virtual const PvStringGetGenICamXMLVersionGUID ()=0
 Returns the GenICam XML file Version GUID. More...
 
virtual PvResult SetGenICamXMLVersion (uint16_t aMajor, uint16_t aMinor, uint16_t aSubMinor)=0
 Sets the GenICam XML file version. More...
 
virtual PvResult SetGenICamXMLGUIDs (const PvString &aProduct, const PvString &aVersion)=0
 Sets the GenICam XML file version. More...
 

Detailed Description

Interface that is used to customize the identity of a software-based GigE Vision Device.

Can be retrieved from a PvSoftDeviceGEV to access device identity strings and GenICam XML version and GUIDs.

The device identity strings can be set before or after calling PvSoftDeviceGEV::Start. However, the GenICam XML version and GUIDs must be set before calling PvSoftDeviceGEV::Start.

Setting the GenICam XML version and GUIDs is recommended but not always required. Some non-Pleora software applications will use this information to manage the cached versions of the GenICam XML file and will not download a newer XML file from the device if the GenICam XML version GUID and/or version do not change.

The recommended practice is to always update the GenICam XML GUID and version when releasing a new version of your GigE Vision Device. We also recommend that all of your GigE Vision Device products use a different GenICam XML Product GUID.

Set your GenICam XML version with SetGenICamXMLVersion.

Set your GenICam XML GUIDs with SetGenICamXMLGUIDs.

This class cannot be instantiated and there is no use case where you would need to implement this interface.

Member Function Documentation

PvString IPvSoftDeviceGEVInfo::GetDeviceFirmwareVersion ( )
pure virtual

Returns the current PvSoftDeviceGEV firmware version string.

Maps to GigE Vision 0x3FFF0100 bootstrap register: 32 bytes, read-only.

Returns
PvSoftDeviceGEV firmware version string.
PvString IPvSoftDeviceGEVInfo::GetDeviceVersion ( )
pure virtual

Returns the current PvSoftDeviceGEV version string.

Maps to GigE Vision 0x0088 bootstrap register: 32 bytes, read-only.

Returns
PvSoftDeviceGEV version string.
PvString IPvSoftDeviceGEVInfo::GetGenICamXMLProductGUID ( )
pure virtual

Returns the GenICam XML file Product GUID.

See SetGenICamXMLGUIDs for more information.

Returns
Product GUID.
PvString IPvSoftDeviceGEVInfo::GetGenICamXMLVersionGUID ( )
pure virtual

Returns the GenICam XML file Version GUID.

See SetGenICamXMLGUIDs for more information.

Returns
Version GUID.
uint16_t IPvSoftDeviceGEVInfo::GetGenICamXMLVersionMajor ( ) const
pure virtual

Returns the GenICam XML file major version.

See SetGenICamXMLVersion for more information.

Returns
Major version.
uint16_t IPvSoftDeviceGEVInfo::GetGenICamXMLVersionMinor ( ) const
pure virtual

Returns the GenICam XML file minor version.

See SetGenICamXMLVersion for more information.

Returns
Minor version.
uint16_t IPvSoftDeviceGEVInfo::GetGenICamXMLVersionSubMinor ( ) const
pure virtual

Returns the GenICam XML file subminor version.

See SetGenICamXMLVersion for more information.

Returns
Subminor version.
PvString IPvSoftDeviceGEVInfo::GetManufacturerInformation ( )
pure virtual

Returns the current manufacturer information string.

Maps to GigE Vision 0x00A8 bootstrap register: 32 bytes, read-only.

Returns
Manufacturer information string.
PvString IPvSoftDeviceGEVInfo::GetManufacturerName ( )
pure virtual

Returns the current manufacturer name.

Maps to GigE Vision 0x0048 bootstrap register: 32 bytes, read-only.

Returns
Manufacturer name string.
PvString IPvSoftDeviceGEVInfo::GetModelName ( )
pure virtual

Returns the current model name.

Maps to GigE Vision 0x0068 bootstrap register: 32 bytes, read-only.

Returns
Model name string.
PvString IPvSoftDeviceGEVInfo::GetSerialNumber ( )
pure virtual

Returns the current serial number string.

Maps to GigE Vision 0x00D8 bootstrap register: 16 bytes, read-only.

Returns
Serial number string.
PvResult IPvSoftDeviceGEVInfo::SetDeviceFirmwareVersion ( const PvString aValue)
pure virtual

Updates the device firmware version string.

Maps to GigE Vision 0x3FFF0100 bootstrap register: 32 bytes, read-only.

Parameters
[in]aValueNew device version, maximum 31 characters (31 + NULL for 32 bytes).
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetDeviceVersion ( const PvString aValue)
pure virtual

Updates the device version string.

Maps to GigE Vision 0x0088 bootstrap register: 32 bytes, read-only.

Parameters
[in]aValueNew device version, maximum 31 characters (31 + NULL for 32 bytes).
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetGenICamXMLGUIDs ( const PvString aProduct,
const PvString aVersion 
)
pure virtual

Sets the GenICam XML file version.

A GUID (globally unique identifier) is a 128-bit number that is used to identify information in computer systems. The term UUID (universally unique identifier) can also be used.

Valid GUID example: CB9328DB-1273-42A3-90C7-EB3224537C39

You can generate unique GUIDs using the Create GUID tool in Visual Studio, which can be accessed from the Visual Studio Tools menu. It uses the system unique MAC address and date/time components to ensure uniqueness.

See the IPvSoftDeviceGEVInfo class description for usage and recommendations.

Parameters
[in]aProductProduct GUID for GenICam XML file header.
[in]aVersionVersion GUID for GenICam XML file header.
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetGenICamXMLVersion ( uint16_t  aMajor,
uint16_t  aMinor,
uint16_t  aSubMinor 
)
pure virtual

Sets the GenICam XML file version.

See the IPvSoftDeviceGEVInfo class description for usage and recommendations.

Parameters
[in]aMajorMajor version for GenICam XML file header.
[in]aMinorMinor version for GenICam XML file header.
[in]aSubMinorSubminor version for GenICam XML file header.
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetManufacturerInformation ( const PvString aValue)
pure virtual

Updates the manufacturer information string.

Maps to GigE Vision 0x00A8 bootstrap register: 48 bytes, read-only.

If the PvSoftDeviceGEV is running without a valid license, the manufacturer information is overridden to provide a warning that indicates that the device is unlicensed.

Parameters
[in]aValueNew device version, maximum 47 characters (47 + NULL for 48 bytes).
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetManufacturerName ( const PvString aValue)
pure virtual

Updates the manufacturer name string.

Maps to GigE Vision 0x0048 bootstrap register: 32 bytes, read-only.

Parameters
[in]aValueNew manufacturer name, maximum 31 characters (31 + NULL).
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetModelName ( const PvString aValue)
pure virtual

Updates the model name string.

Maps to GigE Vision 0x0068 bootstrap register: 32 bytes, read-only.

Parameters
[in]aValueNew model name, maximum 31 characters (31 + NULL for 32 bytes).
Returns
Includes:
PvResult IPvSoftDeviceGEVInfo::SetSerialNumber ( const PvString aValue)
pure virtual

Updates the serial number string.

Maps to GigE Vision 0x00D8 bootstrap register: 16 bytes, read-only.

Parameters
[in]aValueNew serial number, maximum 15 characters (15 + NULL for 16 bytes).
Returns
Includes:

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

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