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 PvString & | GetManufacturerName ()=0 |
Returns the current manufacturer name. More... | |
virtual const PvString & | GetModelName ()=0 |
Returns the current model name. More... | |
virtual const PvString & | GetDeviceVersion ()=0 |
Returns the current PvSoftDeviceGEV version string. More... | |
virtual const PvString & | GetDeviceFirmwareVersion ()=0 |
Returns the current PvSoftDeviceGEV firmware version string. More... | |
virtual const PvString & | GetManufacturerInformation ()=0 |
Returns the current manufacturer information string. More... | |
virtual const PvString & | GetSerialNumber ()=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 PvString & | GetGenICamXMLProductGUID ()=0 |
Returns the GenICam XML file Product GUID. More... | |
virtual const PvString & | GetGenICamXMLVersionGUID ()=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... | |
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.
|
pure virtual |
Returns the current PvSoftDeviceGEV firmware version string.
Maps to GigE Vision 0x3FFF0100 bootstrap register: 32 bytes, read-only.
|
pure virtual |
Returns the current PvSoftDeviceGEV version string.
Maps to GigE Vision 0x0088 bootstrap register: 32 bytes, read-only.
|
pure virtual |
Returns the GenICam XML file Product GUID.
See SetGenICamXMLGUIDs for more information.
|
pure virtual |
Returns the GenICam XML file Version GUID.
See SetGenICamXMLGUIDs for more information.
|
pure virtual |
Returns the GenICam XML file major version.
See SetGenICamXMLVersion for more information.
|
pure virtual |
Returns the GenICam XML file minor version.
See SetGenICamXMLVersion for more information.
|
pure virtual |
Returns the GenICam XML file subminor version.
See SetGenICamXMLVersion for more information.
|
pure virtual |
Returns the current manufacturer information string.
Maps to GigE Vision 0x00A8 bootstrap register: 32 bytes, read-only.
|
pure virtual |
Returns the current manufacturer name.
Maps to GigE Vision 0x0048 bootstrap register: 32 bytes, read-only.
|
pure virtual |
Returns the current model name.
Maps to GigE Vision 0x0068 bootstrap register: 32 bytes, read-only.
|
pure virtual |
Returns the current serial number string.
Maps to GigE Vision 0x00D8 bootstrap register: 16 bytes, read-only.
Updates the device firmware version string.
Maps to GigE Vision 0x3FFF0100 bootstrap register: 32 bytes, read-only.
[in] | aValue | New device version, maximum 31 characters (31 + NULL for 32 bytes). |
Updates the device version string.
Maps to GigE Vision 0x0088 bootstrap register: 32 bytes, read-only.
[in] | aValue | New device version, maximum 31 characters (31 + NULL for 32 bytes). |
|
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.
[in] | aProduct | Product GUID for GenICam XML file header. |
[in] | aVersion | Version GUID for GenICam XML file header. |
|
pure virtual |
Sets the GenICam XML file version.
See the IPvSoftDeviceGEVInfo class description for usage and recommendations.
[in] | aMajor | Major version for GenICam XML file header. |
[in] | aMinor | Minor version for GenICam XML file header. |
[in] | aSubMinor | Subminor version for GenICam XML file header. |
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.
[in] | aValue | New device version, maximum 47 characters (47 + NULL for 48 bytes). |
Updates the manufacturer name string.
Maps to GigE Vision 0x0048 bootstrap register: 32 bytes, read-only.
[in] | aValue | New manufacturer name, maximum 31 characters (31 + NULL). |
Updates the model name string.
Maps to GigE Vision 0x0068 bootstrap register: 32 bytes, read-only.
[in] | aValue | New model name, maximum 31 characters (31 + NULL for 32 bytes). |
Updates the serial number string.
Maps to GigE Vision 0x00D8 bootstrap register: 16 bytes, read-only.
[in] | aValue | New serial number, maximum 15 characters (15 + NULL for 16 bytes). |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com