All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
CLProtocol::CXMLID Class Reference

Helper class which can split XMLIDs strings into tokens. More...

#include <XMLID.h>

Public Member Functions

 CXMLID ()
 Constructor. More...
 
bool FromString (const GENICAM_NAMESPACE::gcstring &XMLID)
 Parses the XML ID. More...
 
 GENICAM_DEPRECATED (static const char *GetTokenSeperator())
 returns the token separator string More...
 
GENICAM_NAMESPACE::gcstring GetDeviceIDTemplate () const
 retrieves the schema version of the XML file More...
 
CVersion GetDeviceVersion () const
 retrieves the schema version of the XML file More...
 
CVersion GetSchemaVersion () const
 retrieves the schema version of the XML file More...
 
bool operator> (CXMLID &XMLID)
 Comparison (for sorting) More...
 
GENICAM_NAMESPACE::gcstring ToString ()
 Returns the original XML ID. More...
 

Static Public Member Functions

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

Private Types

enum  EXMLIDIndex { xidSchemaVersion = 0, xidDeviceIDTemplate = 1, xidDeviceVersion = 2 }
 The positions of the tokens within the XMLID string. More...
 

Private Attributes

GENICAM_NAMESPACE::gcstring m_DeviceIDTemplate
 The middle part of the XML ID. More...
 
CVersion m_DeviceVersion
 The last part of the XML ID. More...
 
CVersion m_SchemaVersion
 The first part of the XML ID. More...
 
GENICAM_NAMESPACE::gcstring m_XMLID
 The original string. More...
 

Detailed Description

Helper class which can split XMLIDs strings into tokens.

Definition at line 40 of file XMLID.h.

Member Enumeration Documentation

◆ EXMLIDIndex

The positions of the tokens within the XMLID string.

Enumerator
xidSchemaVersion 
xidDeviceIDTemplate 
xidDeviceVersion 

Definition at line 74 of file XMLID.h.

Constructor & Destructor Documentation

◆ CXMLID()

CLProtocol::CXMLID::CXMLID ( )

Constructor.

Member Function Documentation

◆ FromString()

bool CLProtocol::CXMLID::FromString ( const GENICAM_NAMESPACE::gcstring XMLID)

Parses the XML ID.

◆ GENICAM_DEPRECATED()

CLProtocol::CXMLID::GENICAM_DEPRECATED ( static const char *  GetTokenSeperator())

returns the token separator string

Deprecated:
This function has been declared deprecated because of a typo in the functions name.

Use CXMLID::GetTokenSeparator() instead.

◆ GetDeviceIDTemplate()

GENICAM_NAMESPACE::gcstring CLProtocol::CXMLID::GetDeviceIDTemplate ( ) const

retrieves the schema version of the XML file

◆ GetDeviceVersion()

CVersion CLProtocol::CXMLID::GetDeviceVersion ( ) const

retrieves the schema version of the XML file

◆ GetSchemaVersion()

CVersion CLProtocol::CXMLID::GetSchemaVersion ( ) const

retrieves the schema version of the XML file

◆ GetTokenSeparator()

static const char* CLProtocol::CXMLID::GetTokenSeparator ( )
static

returns the token separator string

◆ operator>()

bool CLProtocol::CXMLID::operator> ( CXMLID XMLID)

Comparison (for sorting)

◆ ToString()

GENICAM_NAMESPACE::gcstring CLProtocol::CXMLID::ToString ( )

Returns the original XML ID.

Member Data Documentation

◆ m_DeviceIDTemplate

GENICAM_NAMESPACE::gcstring CLProtocol::CXMLID::m_DeviceIDTemplate
private

The middle part of the XML ID.

Definition at line 85 of file XMLID.h.

◆ m_DeviceVersion

CVersion CLProtocol::CXMLID::m_DeviceVersion
private

The last part of the XML ID.

Definition at line 91 of file XMLID.h.

◆ m_SchemaVersion

CVersion CLProtocol::CXMLID::m_SchemaVersion
private

The first part of the XML ID.

Definition at line 88 of file XMLID.h.

◆ m_XMLID

GENICAM_NAMESPACE::gcstring CLProtocol::CXMLID::m_XMLID
private

The original string.

Definition at line 82 of file XMLID.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:12