Helper class which can split DeviceIDs strings into tokens. More...
#include <DeviceID.h>
Public Member Functions | |
CDeviceID () | |
Constructor. More... | |
bool | FromString (const GENICAM_NAMESPACE::gcstring &DeviceID) |
parse string More... | |
GENICAM_DEPRECATED (static const char *GetTokenSeperator()) | |
returns the token separator string More... | |
GENICAM_NAMESPACE::gcstring | GetCameraFamily () const |
retrieves the camera family (may return empty string in case of a template) More... | |
GENICAM_NAMESPACE::gcstring | GetCameraManufacturer () const |
retrieves the manufacturer name of the camera More... | |
GENICAM_NAMESPACE::gcstring | GetCameraModel () const |
retrieves the camera model (may return empty string in case of a template) More... | |
GENICAM_NAMESPACE::gcstring | GetCameraSerialNumber () const |
retrieves the camera model's serial number in any format (may return empty string in case of a template) More... | |
GENICAM_NAMESPACE::gcstring | GetCameraVersion () const |
retrieves the camera model's version in any format (may return empty string in case of a template) More... | |
GENICAM_NAMESPACE::gcstring | GetDeviceID (const bool ReplaceEnvironmentVariables=true) const |
retrieves the DeviceID without the DriverDriectory and the Driver FileName in front More... | |
GENICAM_NAMESPACE::gcstring | GetDriverDirectory (const bool ReplaceEnvironmentVariables=true) const |
retrieves the directory the CL protocol driver is located in More... | |
GENICAM_NAMESPACE::gcstring | GetDriverFileName () const |
retrieves the file name of the CL protocol driver More... | |
GENICAM_NAMESPACE::gcstring | GetDriverPath () const |
retrieves the path of the CL protocol driver is located in More... | |
GENICAM_NAMESPACE::gcstring | GetShortDeviceID () const |
retrieves the ShortDeviceID/DeviceIDTemplate without the DriverDriectory and the Driver FileName in front More... | |
Static Public Member Functions | |
static const char * | GetTokenSeparator () |
returns the token separator string More... | |
Private Types | |
enum | EDeviceIDIndex { didDriverDirectory = 0, didDriverFileName = 1, didCameraManufacturer = 2, didCameraFamily = 3, didCameraModel = 4, didCameraVersion = 5, didCameraSerialNumber = 6 } |
The positions of the tokens within the DeviceID string. More... | |
Private Attributes | |
GENICAM_NAMESPACE::gcstring_vector | m_DeviceIDTokens |
The tokens which form the DeviceID. More... | |
Helper class which can split DeviceIDs strings into tokens.
Definition at line 46 of file DeviceID.h.
|
private |
The positions of the tokens within the DeviceID string.
Enumerator | |
---|---|
didDriverDirectory | |
didDriverFileName | |
didCameraManufacturer | |
didCameraFamily | |
didCameraModel | |
didCameraVersion | |
didCameraSerialNumber |
Definition at line 100 of file DeviceID.h.
CLProtocol::CDeviceID::CDeviceID | ( | ) |
Constructor.
bool CLProtocol::CDeviceID::FromString | ( | const GENICAM_NAMESPACE::gcstring & | DeviceID | ) |
parse string
CLProtocol::CDeviceID::GENICAM_DEPRECATED | ( | static const char * | GetTokenSeperator() | ) |
returns the token separator string
Use CDeviceID::GetTokenSeparator() instead.
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetCameraFamily | ( | ) | const |
retrieves the camera family (may return empty string in case of a template)
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetCameraManufacturer | ( | ) | const |
retrieves the manufacturer name of the camera
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetCameraModel | ( | ) | const |
retrieves the camera model (may return empty string in case of a template)
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetCameraSerialNumber | ( | ) | const |
retrieves the camera model's serial number in any format (may return empty string in case of a template)
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetCameraVersion | ( | ) | const |
retrieves the camera model's version in any format (may return empty string in case of a template)
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetDeviceID | ( | const bool | ReplaceEnvironmentVariables = true | ) | const |
retrieves the DeviceID without the DriverDriectory and the Driver FileName in front
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetDriverDirectory | ( | const bool | ReplaceEnvironmentVariables = true | ) | const |
retrieves the directory the CL protocol driver is located in
ReplaceEnvironmentVariables | If true environment variables like are replaced by their value. |
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetDriverFileName | ( | ) | const |
retrieves the file name of the CL protocol driver
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetDriverPath | ( | ) | const |
retrieves the path of the CL protocol driver is located in
GENICAM_NAMESPACE::gcstring CLProtocol::CDeviceID::GetShortDeviceID | ( | ) | const |
retrieves the ShortDeviceID/DeviceIDTemplate without the DriverDriectory and the Driver FileName in front
|
static |
returns the token separator string
|
private |
The tokens which form the DeviceID.
Definition at line 112 of file DeviceID.h.