All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
XMLID.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // (c) 2008 by Basler Vision Technologies
3 // Section: Vision Components
4 // Project: GenApi
5 // Author: Fritz Dierks
6 // $Header$
7 //
8 // License: This file is published under the license of the EMVA GENICAM_NAMESPACE Standard Group.
9 // A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
10 // If for some reason you are missing this file please contact the EMVA or visit the website
11 // (http://www.GENICAM_NAMESPACE.org) for a full copy.
12 //
13 // THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM_NAMESPACE STANDARD GROUP "AS IS"
14 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM_NAMESPACE STANDARD GROUP
17 // OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 // POSSIBILITY OF SUCH DAMAGE.
24 //-----------------------------------------------------------------------------
28 #ifndef CLPROTOCOL_XMLID_H
29 #define CLPROTOCOL_XMLID_H
30 
31 #include <Base/GCBase.h>
32 #include <Base/GCUtilities.h>
33 #include <CLProtocol/CVersion.h>
34 
35 namespace CLProtocol
36 {
37 
39 
41  {
42  public:
44  static const char* GetTokenSeparator();
45 
47 
49  GENICAM_DEPRECATED( static const char* GetTokenSeperator() );
50 
52  CXMLID();
53 
55  bool FromString(const GENICAM_NAMESPACE::gcstring &XMLID);
56 
59 
61  CVersion GetSchemaVersion() const;
62 
64  CVersion GetDeviceVersion() const;
65 
67  GENICAM_NAMESPACE::gcstring GetDeviceIDTemplate() const;
68 
70  bool operator>(CXMLID& XMLID);
71 
72  private:
74  typedef enum
75  {
76  xidSchemaVersion = 0,
77  xidDeviceIDTemplate = 1,
78  xidDeviceVersion = 2
79  } EXMLIDIndex;
80 
83 
86 
89 
92  };
93 
95 
96  inline bool CompareCXMLID( CXMLID *pA, CXMLID *pB )
97  {
98  return *pA > *pB;
99  }
100 }
101 #endif // CLPROTOCOL_XMLID_H
GENAPI_NAMESPACE::ToString
virtual GENICAM_NAMESPACE::gcstring ToString()=0
Returns a string representation of the digit.
CLProtocol
Definition: CLAllAdapter.h:64
CLProtocol::CompareCXMLID
bool CompareCXMLID(CXMLID *pA, CXMLID *pB)
for sorting a vector of pointers to CXMLID objects
Definition: XMLID.h:96
CVersion.h
C++ class wrapping CLSerialAll and CLProtocolDriver.
GENICAM_NAMESPACE::gcstring
A string class which is a clone of std::string.
Definition: GCString.h:52
CLProtocol::CVersion
Encapsulates a version number.
Definition: CVersion.h:40
GENAPI_NAMESPACE::GetSchemaVersion
virtual void GetSchemaVersion(Version_t &Version)=0
Get the schema version number.
CLProtocol::CXMLID
Helper class which can split XMLIDs strings into tokens.
Definition: XMLID.h:40
GENICAM_DEPRECATED
#define GENICAM_DEPRECATED(FUNCTION)
Definition: GCUtilities.h:220
GCUtilities.h
GenICam common utilities.
CLPROTOCOL_DECL
#define CLPROTOCOL_DECL
Definition: CLProtocol.h:64
CLProtocol::CXMLID::m_DeviceIDTemplate
GENICAM_NAMESPACE::gcstring m_DeviceIDTemplate
The middle part of the XML ID.
Definition: XMLID.h:85
GENAPI_NAMESPACE::GetDeviceVersion
virtual void GetDeviceVersion(Version_t &Version)=0
Get the version of the device description file.
GCBase.h
Common GenICam base include file.
CLProtocol::CXMLID::m_DeviceVersion
CVersion m_DeviceVersion
The last part of the XML ID.
Definition: XMLID.h:91
CLProtocol::CXMLID::m_XMLID
GENICAM_NAMESPACE::gcstring m_XMLID
The original string.
Definition: XMLID.h:82
CLProtocol::CXMLID::m_SchemaVersion
CVersion m_SchemaVersion
The first part of the XML ID.
Definition: XMLID.h:88
GENAPI_NAMESPACE::FromString
virtual void FromString(const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true)=0
Set content of the node as string.


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