LTKCPP-- LLRP Toolkit C Plus Plus Library
Classes | Typedefs | Enumerations | Functions | Variables
LLRP Namespace Reference

Classes

class  CConnection
 LLRP connection class. More...
 
class  CDecoder
 LTK LLRP Decoder class. More...
 
class  CDecoderStream
 Class that decodes messages into internal LTK CElements. More...
 
class  CElement
 This is the base class for all parameter and message types. More...
 
class  CEncoder
 LTK LLRP Encoder class. More...
 
class  CEncoderStream
 Class that encodes internal LTK CElements into messages. More...
 
class  CErrorDetails
 Class to return error details in LTKCPP operations. More...
 
class  CFieldDescriptor
 Describes a single field inside an LTKCPP message or parameters. More...
 
class  CMessage
 Base Class for All LLRP LTK Messages. More...
 
class  CNamespaceDescriptor
 Describes the namespae information for converting LLRP messages to LTK-XML. More...
 
class  CParameter
 Base Class for All LLRP LTK Parameters. More...
 
class  CTypeDescriptor
 Describes a message or parameter type. More...
 
class  CTypeRegistry
 A collection of pointers to CTypeDescriptors. More...
 
class  CVendorDescriptor
 Describes the vendor information for vendor extension classes. More...
 
class  llrp_bytesToEnd_t
 Class for LLRP basic type bytesToEnd (vector of unsigned bytes) More...
 
class  llrp_s16v_t
 Class for LLRP basic type s16v (List of signed 16-bit values) More...
 
class  llrp_s32v_t
 Class for LLRP basic type s32v (vector of signed 32-bit values) More...
 
class  llrp_s64v_t
 Class for LLRP basic type s64v (vector of signed 64-bit values) More...
 
class  llrp_s8v_t
 Class for LLRP basic type s8v (List of signed 8-bit values) More...
 
class  llrp_u16v_t
 Class for LLRP basic type u16v (List of unsigned 16-bit values) More...
 
class  llrp_u1v_t
 Class for LLRP basic type u1v (vector of unsigned 1-bit values) More...
 
class  llrp_u32v_t
 Class for LLRP basic type u32v (vector of unsigned 32-bit values) More...
 
class  llrp_u64v_t
 Class for LLRP basic type u64v (vector of unsigned 64-bit values) More...
 
class  llrp_u8v_t
 Class for LLRP basic type u8v (List of unsigned 8-bit values) More...
 
class  llrp_u96_t
 Class for LLRP basic type u96 (96-bit value) More...
 
class  llrp_utf8v_t
 Class for LLRP basic type utf8v (vector of utf-8 encoded characters) More...
 

Typedefs

typedef std::list< CParameter * > tListOfParameters
 
typedef struct NamespaceList tNamespaceList
 

Enumerations

enum  EResultCode {
  RC_OK = 0, RC_MiscError = 100, RC_Botch, RC_SendIOError,
  RC_RecvIOError, RC_RecvEOF, RC_RecvTimeout, RC_RecvFramingError,
  RC_RecvBufferOverflow, RC_BadVersion, RC_MissingResponseType, RC_UnknownMessageType,
  RC_UnknownParameterType, RC_ExcessiveLength, RC_InvalidLength, RC_FieldUnderrun,
  RC_ReservedBitsUnderrun, RC_FieldOverrun, RC_ReservedBitsOverrun, RC_UnalignedBitField,
  RC_UnalignedReservedBits, RC_MessageAllocationFailed, RC_ParameterAllocationFailed, RC_FieldAllocationFailed,
  RC_ExtraBytes, RC_MissingParameter, RC_UnexpectedParameter, RC_InvalidChoiceMember,
  RC_EnrollBadTypeNumber, RC_NotAllowedAtExtensionPoint, RC_XMLInvalidNodeType, RC_XMLMissingField,
  RC_XMLExtraNode, RC_XMLInvalidFieldCharacters, RC_XMLOutOfRange
}
 Error result codes for LTK operations. More...
 

Functions

CTypeRegistrygetTheTypeRegistry (void)
 
EResultCode toXMLString (const CElement *pElement, char *pBuffer, int nBuffer)
 

Variables

CFieldDescriptor g_fdMessageHeader_Type
 
CFieldDescriptor g_fdMessageHeader_Length
 
CFieldDescriptor g_fdMessageHeader_MessageID
 
CFieldDescriptor g_fdMessageHeader_VendorPEN
 
CFieldDescriptor g_fdMessageHeader_Subtype
 
CFieldDescriptor g_fdParameterHeader_TVType
 
CFieldDescriptor g_fdParameterHeader_TLVType
 
CFieldDescriptor g_fdParameterHeader_TLVLength
 
CFieldDescriptor g_fdParameterHeader_VendorPEN
 
CFieldDescriptor g_fdParameterHeader_Subtype
 

Detailed Description

\brief The namespace for the LTKCPP library

The namespace for the LTKCPP library

Enumeration Type Documentation

◆ EResultCode

Error result codes for LTK operations.

These error codes are common across many LTKCPP functions.

Enumerator
RC_OK 

Success

RC_MiscError 

Error

RC_Botch 

Error

RC_SendIOError 

Error

RC_RecvIOError 

Error

RC_RecvEOF 

Error

RC_RecvTimeout 

Error

RC_RecvFramingError 

Error

RC_RecvBufferOverflow 

Error

RC_BadVersion 

Error

RC_MissingResponseType 

Error

RC_UnknownMessageType 

Error

RC_UnknownParameterType 

Error

RC_ExcessiveLength 

Error

RC_InvalidLength 

Error

RC_FieldUnderrun 

Error

RC_ReservedBitsUnderrun 

Error

RC_FieldOverrun 

Error

RC_ReservedBitsOverrun 

Error

RC_UnalignedBitField 

Error

RC_UnalignedReservedBits 

Error

RC_MessageAllocationFailed 

Error

RC_ParameterAllocationFailed 

Error

RC_FieldAllocationFailed 

Error

RC_ExtraBytes 

Error

RC_MissingParameter 

Error

RC_UnexpectedParameter 

Error

RC_InvalidChoiceMember 

Error

RC_EnrollBadTypeNumber 

Error

RC_NotAllowedAtExtensionPoint 

Error

RC_XMLInvalidNodeType 

Error

RC_XMLMissingField 

Error

RC_XMLExtraNode 

Error

RC_XMLInvalidFieldCharacters 

Error

RC_XMLOutOfRange 

Error

Definition at line 583 of file ltkcpp_base.h.

Variable Documentation

◆ g_fdMessageHeader_Length

CFieldDescriptor LLRP::g_fdMessageHeader_Length
Initial value:
=
{
CFieldDescriptor::FT_U32,
CFieldDescriptor::FMT_NORMAL,
"MessageHeader.Length",
NULL
}

Definition at line 35 of file ltkcpp_hdrfd.cpp.

◆ g_fdMessageHeader_MessageID

CFieldDescriptor LLRP::g_fdMessageHeader_MessageID
Initial value:
=
{
CFieldDescriptor::FT_U32,
CFieldDescriptor::FMT_NORMAL,
"MessageHeader.MessageID",
NULL
}

Definition at line 44 of file ltkcpp_hdrfd.cpp.

◆ g_fdMessageHeader_Subtype

CFieldDescriptor LLRP::g_fdMessageHeader_Subtype
Initial value:
=
{
CFieldDescriptor::FT_U8,
CFieldDescriptor::FMT_NORMAL,
"MessageHeader.CustomSubtype",
NULL
}

Definition at line 62 of file ltkcpp_hdrfd.cpp.

◆ g_fdMessageHeader_Type

CFieldDescriptor LLRP::g_fdMessageHeader_Type
Initial value:
=
{
CFieldDescriptor::FT_U16,
CFieldDescriptor::FMT_NORMAL,
"MessageHeader.Type",
NULL
}

Definition at line 26 of file ltkcpp_hdrfd.cpp.

◆ g_fdMessageHeader_VendorPEN

CFieldDescriptor LLRP::g_fdMessageHeader_VendorPEN
Initial value:
=
{
CFieldDescriptor::FT_U32,
CFieldDescriptor::FMT_NORMAL,
"MessageHeader.CustomVendorPEN",
NULL
}

Definition at line 53 of file ltkcpp_hdrfd.cpp.

◆ g_fdParameterHeader_Subtype

CFieldDescriptor LLRP::g_fdParameterHeader_Subtype
Initial value:
=
{
CFieldDescriptor::FT_U32,
CFieldDescriptor::FMT_NORMAL,
"ParameterHeader.CustomSubtype",
NULL
}

Definition at line 107 of file ltkcpp_hdrfd.cpp.

◆ g_fdParameterHeader_TLVLength

CFieldDescriptor LLRP::g_fdParameterHeader_TLVLength
Initial value:
=
{
CFieldDescriptor::FT_U16,
CFieldDescriptor::FMT_NORMAL,
"ParameterHeader.TLVLength",
NULL
}

Definition at line 89 of file ltkcpp_hdrfd.cpp.

◆ g_fdParameterHeader_TLVType

CFieldDescriptor LLRP::g_fdParameterHeader_TLVType
Initial value:
=
{
CFieldDescriptor::FT_U16,
CFieldDescriptor::FMT_NORMAL,
"ParameterHeader.TLVType",
NULL
}

Definition at line 80 of file ltkcpp_hdrfd.cpp.

◆ g_fdParameterHeader_TVType

CFieldDescriptor LLRP::g_fdParameterHeader_TVType
Initial value:
=
{
CFieldDescriptor::FT_U8,
CFieldDescriptor::FMT_NORMAL,
"ParameterHeader.TVType",
NULL
}

Definition at line 71 of file ltkcpp_hdrfd.cpp.

◆ g_fdParameterHeader_VendorPEN

CFieldDescriptor LLRP::g_fdParameterHeader_VendorPEN
Initial value:
=
{
CFieldDescriptor::FT_U32,
CFieldDescriptor::FMT_NORMAL,
"ParameterHeader.CustomVendorPEN",
NULL
}

Definition at line 98 of file ltkcpp_hdrfd.cpp.