CLProtocol 3.5.1
Public Member Functions | Static Public Member Functions | List of all members
CDeviceID Class Reference

Helper class which can split DeviceIDs strings into tokens.

#include <DeviceID.h>

Public Member Functions

 GENICAM_DEPRECATED (static const char *GetTokenSeperator())
 returns the token separator string
 
 CDeviceID ()
 Constructor.
 
bool FromString (const GENICAM_NAMESPACE::gcstring &DeviceID)
 parse string
 
GENICAM_NAMESPACE::gcstring GetDriverDirectory (const bool ReplaceEnvironmentVariables=true) const
 retrieves the directory the CL protocol driver is located in
 
GENICAM_NAMESPACE::gcstring GetDriverFileName () const
 retrieves the file name of the CL protocol driver
 
GENICAM_NAMESPACE::gcstring GetDriverPath () const
 retrieves the path of the CL protocol driver is located in
 
GENICAM_NAMESPACE::gcstring GetCameraManufacturer () const
 retrieves the manufacturer name of the camera
 
GENICAM_NAMESPACE::gcstring GetCameraFamily () const
 retrieves the camera family (may return empty string in case of a template)
 
GENICAM_NAMESPACE::gcstring GetCameraModel () const
 retrieves the camera model (may return empty string in case of a template)
 
GENICAM_NAMESPACE::gcstring GetCameraVersion () const
 retrieves the camera model's version in any format (may return empty string in case of a template)
 
GENICAM_NAMESPACE::gcstring GetCameraSerialNumber () const
 retrieves the camera model's serial number in any format (may return empty string in case of a template)
 
GENICAM_NAMESPACE::gcstring GetShortDeviceID () const
 retrieves the ShortDeviceID/DeviceIDTemplate without the DriverDriectory and the Driver FileName in front
 
GENICAM_NAMESPACE::gcstring GetDeviceID (const bool ReplaceEnvironmentVariables=true) const
 retrieves the DeviceID without the DriverDriectory and the Driver FileName in front
 

Static Public Member Functions

static const char * GetTokenSeparator ()
 returns the token separator string
 

Member Function Documentation

◆ GENICAM_DEPRECATED()

GENICAM_DEPRECATED ( static const char * GetTokenSeperator())

◆ GetDriverDirectory()

GENICAM_NAMESPACE::gcstring GetDriverDirectory ( const bool ReplaceEnvironmentVariables = true) const
Parameters
ReplaceEnvironmentVariablesIf true environment variables like are replaced by their value.