Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
GENAPI_NAMESPACE Namespace Reference

Part of the generic device API. More...

Namespaces

 detail
 

Classes

class  _autovector_impl
 
struct  AttachStatistics_t
 Delivers information about the attached chunks and nodes. More...
 
class  AutoLock
 
class  BaseT
 Implementation of the IBase interface. More...
 
class  BooleanT
 Implementation of the IBoolean interface. More...
 
class  CBaseRefT
 
class  CBoolean
 
class  CBooleanImpl
 IBoolean implementation. More...
 
class  CBooleanPolyRef
 A reference to a bool which can bei either an bool variable, or a pointer to an IInteger, an IEnumeration, or an IBoolean. More...
 
class  CBooleanRefT
 
class  CCategory
 
class  CCategoryImpl
 Holds a list of features and sub-categories. More...
 
class  CCategoryRefT
 
class  CChunkAdapter
 Connects a chunked buffer to a node map. More...
 
class  CChunkAdapterDcam
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterGeneric
 Connects a generic chunked buffer to a node map. More...
 
class  CChunkAdapterGEV
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterU3V
 Connects a chunked U3V buffer to a node map. More...
 
class  CChunkPort
 Port attachable to a chunk in a buffer. More...
 
class  CCommand
 
class  CCommandImpl
 ICommand implementation. More...
 
class  CCommandRefT
 
class  CConverter
 class implementing the converter object More...
 
class  CConverterImpl
 IFloat implementation with integrated conversion. More...
 
class  CDcamAccessCtrlReg
 
class  CDcamAccessCtrlRegImpl
 Implements the IIDC DCAM Access Control Register for Advanced Features. More...
 
class  CEnumEntry
 Implements the EnumEntry node. More...
 
class  CEnumEntryImpl
 Mapping of Enum Values to symbolic values. More...
 
class  CEnumEntryRefT
 
class  CEnumeration
 
class  CEnumerationImpl
 
class  CEnumerationTRef
 
class  CEnumSelectorDigit
 A selector set counter digit formed by an enumeration. More...
 
class  CEventAdapter
 Delivers Events to ports. More...
 
class  CEventAdapter1394
 Distribute the events to the node map. More...
 
class  CEventAdapterCL
 Connects a U3V Event to a node map. More...
 
class  CEventAdapterGeneric
 Connects a generic event to a node map. More...
 
class  CEventAdapterGEV
 Connects a GigE Event to a node map. More...
 
class  CEventAdapterU3V
 Connects a U3V Event to a node map. More...
 
class  CEventPort
 Port attachable to an event. More...
 
class  CFeatureBag
 Bag holding streamable features of a nodetree. More...
 
class  CFeatureBagger
 Class use to bag features. More...
 
class  CFloat
 Float node implementation. More...
 
class  CFloatImpl
 Core pf the Float node implementation. More...
 
class  CFloatPolyRef
 A reference to a float which can be either a double variable, or a pointer to an IFloat, IInteger, or an IEnumeration interface. More...
 
class  CFloatPtr
 SmartPointer for IFloat interface pointer. More...
 
class  CFloatRefT
 
class  CFltReg
 the clkass implementing the FltReg node More...
 
class  CFltRegImpl
 IFloat implementation for a register. More...
 
class  CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
 
class  CIEEE1212Parser
 
class  CIEEE1212ParserImpl
 
class  CIntConverter
 class implementingthe converter object More...
 
class  CIntConverterImpl
 IInteger implementation with integrated conversion. More...
 
class  CInteger
 Integer node implementation. More...
 
class  CIntegerImpl
 Core of the Integer node implementation. More...
 
class  CIntegerOffsetPolyRef
 
class  CIntegerPolyRef
 A reference to an int64 which can bei either an int64 variable, or a pointer to an IInteger, an IEnumeration, an IBoolean, or a IFloat. More...
 
class  CIntegerRefT
 
class  CIntKey
 
class  CIntKeyImpl
 IInteger implementation for IEEE1212 integer entries. More...
 
class  CIntReg
 implements the IntReg node More...
 
class  CIntRegImpl
 IInteger implementation for a register. More...
 
class  CIntSelectorDigit
 A selector set counter digit formed by an integer. More...
 
class  CIntSwissKnife
 
class  CIntSwissKnifeImpl
 IInteger implementation for a SwissKnife used for formula evaluation. More...
 
struct  CL_COMMAND_HEADER
 CL/GenCP command header. More...
 
struct  CL_EVENT_DATA
 CL/GenCP EVENT_CMD specific command data WITHOUT event specific data. More...
 
struct  CL_EVENT_DATA1
 CL/GenCP EVENT_CMD specific command data WITH event specific data. More...
 
struct  CL_EVENT_MESSAGE
 Entire event data message. More...
 
class  CLock
 A lock class. More...
 
class  CLockEx
 This class is for testing purposes only. More...
 
class  CMaskedIntReg
 
class  CMaskedIntRegImpl
 IInteger implementation for a masked register. More...
 
class  CNodeCallback
 callback body instance for INode pointers More...
 
class  CNodeImpl
 Standard implementation for the INode and the ISelector interface. More...
 
class  CNodeMap
 Hold a map of all nodes. More...
 
class  CNodeMapFactory
 The node map factory is used for creating node maps from camera description files. More...
 
class  CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
 
class  CNodeMapRefT
 Smartpointer template for NodeMaps with create function. More...
 
class  CommandT
 Implementation of the ICommand interface. More...
 
class  Counter
 
class  CPointer
 Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...
 
class  CPort
 
class  CPortImpl
 Standard implementation for a port ! More...
 
class  CPortImplIntern
 Standard IPort implementation. More...
 
class  CPortRecorderRefT
 
class  CPortRefT
 
class  CPortWriteList
 Container holding a list of port write commands. More...
 
class  CReferenceT
 Reference to an IBase derived pointer. More...
 
class  CRegister
 
class  CRegisterImpl
 Standard IRegister implementation Provides a chunk of memory which acts as a proxy to the register. More...
 
class  CRegisterRefT
 
class  CRegisterSetHelper
 Copies data from buffer to variables in a typesafe manner. More...
 
class  CSelectorRefT
 
class  CSelectorSet
 The set of selectors selecting a given node. More...
 
class  CSmartFeature
 
class  CSmartFeatureImpl
 Implements the Basler Smart Feature class. More...
 
class  CStringNode
 
class  CStringNodeImpl
 Implements a floating string node. More...
 
class  CStringPolyRef
 A reference to a gcstring which can be either a gcstring variable, or a pointer to an IString. More...
 
class  CStringRefT
 
class  CStringRegister
 
class  CStringRegisterImpl
 Implements a simple string register. More...
 
class  CSwissKnife
 
class  CSwissKnifeImpl
 Specialized SwissKnife for float nodes. More...
 
class  CTestPortStruct
 Implements a register spaces based on a C++ struct. More...
 
class  CTestValueNode
 Generic Node with dummy IValue implementation. More...
 
class  CTxtKey
 
class  CTxtKeyImpl
 IString implementation for IEEE1212 string entries. More...
 
class  CValueCache
 Cache for Registervalues. More...
 
class  CValueNodeImpl
 
class  CValueRefT
 
struct  DCAM_CHECKSUM
 
struct  DCAM_CHUNK_TRAILER
 
class  double_autovector_t
 Vector of doubles with reference counting. More...
 
class  EAccessModeClass
 EAccessModeClass holds conversion methods for the access mode enumeration. More...
 
class  ECachingModeClass
 ECachingModeClass holds conversion methods for the caching mode enumeration. More...
 
class  EDisplayNotationClass
 Holds conversion methods for the notation type of floats. More...
 
class  EEndianessClass
 EEndianessClass holds conversion methods for the endianess enumeration. More...
 
class  EGenApiSchemaVersionClass
 helper class converting EGenApiSchemaVersion from and to string More...
 
class  EInputDirectionClass
 Holds conversion methods for the notation type of floats. More...
 
class  EMethodClass
 
class  ENameSpaceClass
 Holds conversion methods for the namespace enumeration. More...
 
class  EnumerationT
 Implementation of the IEnumeration Interface. More...
 
class  ERepresentationClass
 ERepresentationClass holds conversion methods for the representation enumeration. More...
 
class  ESignClass
 ESignClass holds conversion methods for the sign enumeration. More...
 
class  ESlopeClass
 Holds conversion methods for the converter formulas. More...
 
class  EStandardNameSpaceClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  EVisibilityClass
 EVisibilityClass holds conversion methods for the visibility enumeration. More...
 
class  ExceptionReporterNode
 
class  EYesNoClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  FileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...
 
class  FloatT
 Implementation of the IFloat Interface. More...
 
class  Function_NodeCallback
 Container for a function pointer. More...
 
struct  GVCP_CHUNK_TRAILER
 header of a GVCP request packet More...
 
struct  GVCP_EVENT_ITEM
 layout of a GVCP event item (Extended ID flag not set) More...
 
struct  GVCP_EVENT_ITEM_BASIC
 layout of a GVCP event item (common to all types) More...
 
struct  GVCP_EVENT_ITEM_EXTENDED_ID
 layout of a GVCP event item (Extended ID flag set) More...
 
struct  GVCP_EVENT_REQUEST
 Layout of a GVCP event request packet (Extended ID flag not set) More...
 
struct  GVCP_EVENT_REQUEST_EXTENDED_ID
 Layout of a GVCP event request packet (Extended ID flag set) More...
 
struct  GVCP_EVENTDATA_REQUEST
 Layout of a GVCP event data request packet (Extended ID flag not set) More...
 
struct  GVCP_EVENTDATA_REQUEST_EXTENDED_ID
 Layout of a GVCP event data request packet (Extended ID flag set) More...
 
struct  GVCP_REQUEST_HEADER
 header of a GVCP request packet More...
 
class  IDevFileStreamBase
 
class  IDevFileStreamBuf
 
class  int64_autovector_t
 Vector of integers with reference counting. More...
 
class  IntegerT
 Implementation of the IInteger Interface. More...
 
class  LockableObject
 Instance-Lock for an object. More...
 
class  Member_NodeCallback
 Container for a member function pointer. More...
 
class  MyAlloc
 
class  NodeT
 Implementation of the INode interface. More...
 
class  ODevFileStreamBase
 
class  ODevFileStreamBuf
 
class  RegisterT
 Implementation of the IRegister interface. More...
 
struct  SingleChunkData_t
 
struct  SingleChunkDataStr_t
 
class  StringT
 Implementation of the IString interface. More...
 
class  SwissKnifeT
 Implementation of the SwissKnife Interface. More...
 
struct  U3V_CHUNK_TRAILER
 header of a GVCP request packet More...
 
struct  U3V_COMMAND_HEADER
 U3V/GenCP command header. More...
 
struct  U3V_EVENT_DATA
 U3V/GenCP EVENT_CMD specific command data. More...
 
struct  U3V_EVENT_MESSAGE
 Entire event data message (without the variable-sized data field) More...
 
class  ValueT
 Implementation of the IValue interface. More...
 

Typedefs

typedef struct GENAPI_NAMESPACE::AttachStatistics_t AttachStatistics_t
 Delivers information about the attached chunks and nodes. More...
 
typedef intptr_t CallbackHandleType
 the callback handle for nodes More...
 
typedef CPointer< IBaseCBasePtr
 SmartPointer for IBase interface pointer. More...
 
typedef CBaseRefT< IBaseCBaseRef
 Reference to an IBase pointer. More...
 
typedef CPointer< IBooleanCBooleanPtr
 SmartPointer for IBoolean interface pointer. More...
 
typedef CBooleanRefT< IBooleanCBooleanRef
 Reference to an IBoolean pointer. More...
 
typedef CPointer< ICategoryCCategoryPtr
 SmartPointer for ICategory interface pointer. More...
 
typedef CCategoryRefT< ICategoryCCategoryRef
 Reference to an ICategory pointer. More...
 
typedef CPointer< IChunkPortCChunkPortPtr
 SmartPointer for IChunkPort interface pointer. More...
 
typedef CPointer< ICommandCCommandPtr
 SmartPointer for ICommand interface pointer. More...
 
typedef CCommandRefT< ICommandCCommandRef
 Reference to an ICommand pointer. More...
 
typedef CPointer< IDeviceInfo, INodeMapCDeviceInfoPtr
 SmartPointer for IDeviceInfo interface pointer. More...
 
typedef CPointer< IEnumEntryCEnumEntryPtr
 SmartPointer for IEnumEntry interface pointer. More...
 
typedef CEnumEntryRefT< IEnumEntryCEnumEntryRef
 Reference to an IEnumEntry pointer. More...
 
typedef CPointer< IEnumerationCEnumerationPtr
 SmartPointer for IEnumeration interface pointer. More...
 
typedef CFloatRefT< IFloatCFloatRef
 Reference to an IFloat pointer. More...
 
typedef CPointer< IIntegerCIntegerPtr
 SmartPointer for IInteger interface pointer. More...
 
typedef CIntegerRefT< IIntegerCIntegerRef
 Reference to an IInteger pointer. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::CL_COMMAND_HEADER CL_COMMAND_HEADER
 CL/GenCP command header. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::CL_EVENT_DATA CL_EVENT_DATA
 CL/GenCP EVENT_CMD specific command data WITHOUT event specific data. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::CL_EVENT_DATA1 CL_EVENT_DATA1
 CL/GenCP EVENT_CMD specific command data WITH event specific data. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::CL_EVENT_MESSAGE CL_EVENT_MESSAGE
 Entire event data message. More...
 
typedef CPointer< INodeMapPrivateCNodeMapPrivatePtr
 SmartPointer for INodeMapPrivate interface pointer. More...
 
typedef CPointer< INodeMap, INodeMapCNodeMapPtr
 SmartPointer for INodeMap interface pointer. More...
 
typedef CPointer< IUserData, INodeMapCNodeMapUserDataPtr
 SmartPointer for IUserData interface pointer. More...
 
typedef CPointer< INodePrivateCNodePrivatePtr
 SmartPointer for INodePrivate interface pointer. More...
 
typedef CPointer< INodeCNodePtr
 SmartPointer for INode interface pointer. More...
 
typedef CPointer< IUserDataCNodeUserDataPtr
 SmartPointer for IUserData interface pointer. More...
 
typedef CPointer< IPortConstructCPortConstructPtr
 SmartPointer for IPortConstruct interface pointer. More...
 
typedef CPointer< IPortCPortPtr
 SmartPointer for IPort interface pointer. More...
 
typedef CPointer< IPortRecorderCPortRecorderPtr
 SmartPointer for IPortRecorder interface pointer. More...
 
typedef CPortRecorderRefT< IPortRecorderCPortRecorderRef
 Reference to an IPortRecorder pointer. More...
 
typedef CPortRefT< IPortCPortRef
 Reference to an IEnumEntry pointer. More...
 
typedef CPointer< IPortReplayCPortReplayPtr
 SmartPointer for IPortReplay interface pointer. More...
 
typedef CPointer< IPortWriteList, IPortWriteListCPortWriteListPtr
 SmartPointer for IPortWriteList interface pointer. More...
 
typedef INodeMap *(__cdecl * Create_f) (const char *pDeviceName)
 Function prototype for the create function implemented by GenApi DLLs. More...
 
typedef INodePrivate *(* CreateFunc_t) (const GENICAM_NAMESPACE::gcstring &)
 
typedef CPointer< IRegisterCRegisterPtr
 SmartPointer for IRegister interface pointer. More...
 
typedef CRegisterRefT< IRegisterCRegisterRef
 Reference to an IRegister pointer. More...
 
typedef CPointer< ISelectorCSelectorPtr
 SmartPointer for ISelector interface pointer. More...
 
typedef CSelectorRefT< ISelectorCSelectorRef
 Reference to an ISelector pointer. More...
 
typedef CPointer< IStringCStringPtr
 SmartPointer for IString interface pointer. More...
 
typedef CStringRefT< IStringCStringRef
 Reference to an IString pointer. More...
 
typedef CPointer< IValueCValuePtr
 SmartPointer for IValue interface pointer. More...
 
typedef CValueRefT< IValueCValueRef
 Reference to an IValue pointer. More...
 
typedef struct GENAPI_NAMESPACE::DCAM_CHECKSUM DCAM_CHECKSUM
 
typedef struct GENAPI_NAMESPACE::DCAM_CHUNK_TRAILER DCAM_CHUNK_TRAILER
 
typedef _autovector_impl< double, double_autovector_tdouble_autovector_impl
 
typedef enum GENAPI_NAMESPACE::_EAccessMode EAccessMode
 access mode of a node More...
 
typedef enum GENAPI_NAMESPACE::_ECachingMode ECachingMode
 caching mode of a register More...
 
typedef enum GENAPI_NAMESPACE::_ECallbackType ECallbackType
 the type of callback More...
 
typedef enum GENAPI_NAMESPACE::_EDisplayNotation EDisplayNotation
 typedef for float notation More...
 
typedef enum GENAPI_NAMESPACE::_EEndianess EEndianess
 Endianess of a value in a register. More...
 
typedef enum GENAPI_NAMESPACE::_EGenApiSchemaVersion EGenApiSchemaVersion
 GenApi schema version. More...
 
typedef enum GENAPI_NAMESPACE::_EIncMode EIncMode
 typedef for increment mode More...
 
typedef enum GENAPI_NAMESPACE::_EInputDirection EInputDirection
 typedef for link type More...
 
typedef enum GENAPI_NAMESPACE::_EInterfaceType EInterfaceType
 typedef for interface type More...
 
typedef enum GENAPI_NAMESPACE::_ELinkType ELinkType
 typedef for link type More...
 
typedef enum GENAPI_NAMESPACE::_ENameSpace ENameSpace
 Defines if a node name is standard or custom. More...
 
typedef enum GENAPI_NAMESPACE::_ERepresentation ERepresentation
 recommended representation of a node value More...
 
typedef enum GENAPI_NAMESPACE::_ESign ESign
 signed or unsigned integers More...
 
typedef enum GENAPI_NAMESPACE::_ESlope ESlope
 typedef for formula type More...
 
typedef enum GENAPI_NAMESPACE::_EStandardNameSpace EStandardNameSpace
 Defines from which standard namespace a node name comes from. More...
 
typedef enum GENAPI_NAMESPACE::_EVisibility EVisibility
 recommended visibility of a node More...
 
typedef enum GENAPI_NAMESPACE::_EXMLValidation EXMLValidation
 typedef describing the different validity checks which can be performed on an XML file More...
 
typedef enum GENAPI_NAMESPACE::_EYesNo EYesNo
 Defines the choices of a Yes/No alternatives. More...
 
typedef void(__cdecl * GetGenApiVersion_f) (Version_t &Version)
 Function prototype for checking the DLL's GenApi version. More...
 
typedef struct GENAPI_NAMESPACE::GVCP_CHUNK_TRAILER GVCP_CHUNK_TRAILER
 header of a GVCP request packet More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENT_ITEM GVCP_EVENT_ITEM
 layout of a GVCP event item (Extended ID flag not set) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENT_ITEM_BASIC GVCP_EVENT_ITEM_BASIC
 layout of a GVCP event item (common to all types) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENT_ITEM_EXTENDED_ID GVCP_EVENT_ITEM_EXTENDED_ID
 layout of a GVCP event item (Extended ID flag set) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENT_REQUEST GVCP_EVENT_REQUEST
 Layout of a GVCP event request packet (Extended ID flag not set) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENT_REQUEST_EXTENDED_ID GVCP_EVENT_REQUEST_EXTENDED_ID
 Layout of a GVCP event request packet (Extended ID flag set) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENTDATA_REQUEST GVCP_EVENTDATA_REQUEST
 Layout of a GVCP event data request packet (Extended ID flag not set) More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_EVENTDATA_REQUEST_EXTENDED_ID GVCP_EVENTDATA_REQUEST_EXTENDED_ID
 Layout of a GVCP event data request packet (Extended ID flag set) More...
 
typedef enum GENAPI_NAMESPACE::GVCP_MESSAGE_TAGS GVCP_MESSAGE_TAGS
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::GVCP_REQUEST_HEADER GVCP_REQUEST_HEADER
 header of a GVCP request packet More...
 
typedef IDevFileStreamBase< char, std::char_traits< char > > IDevFileStream
 
typedef _autovector_impl< int64_t, int64_autovector_tint64_autovector_impl
 
typedef std::list< int64_tInt64List_t
 
typedef std::list< IInteger * > IntegerList_t
 List of Integer-node references. More...
 
typedef node_vector NodeList_t
 a list of node references More...
 
typedef std::vector< INodePrivate * > NodePrivateVector_t
 a vector of node references using the INodePrivate interface More...
 
typedef ODevFileStreamBase< char, std::char_traits< char > > ODevFileStream
 
typedef std::list< int64_t * > pInt64List_t
 
typedef std::list< uint64_t * > pUInt64List_t
 
typedef struct GENAPI_NAMESPACE::SingleChunkData_t SingleChunkData_t
 
typedef struct GENAPI_NAMESPACE::SingleChunkDataStr_t SingleChunkDataStr_t
 
typedef GENICAM_NAMESPACE::gcstring_vector StringList_t
 A list of strings. More...
 
typedef struct GENAPI_NAMESPACE::U3V_CHUNK_TRAILER U3V_CHUNK_TRAILER
 header of a GVCP request packet More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::U3V_COMMAND_HEADER U3V_COMMAND_HEADER
 U3V/GenCP command header. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::U3V_EVENT_DATA U3V_EVENT_DATA
 U3V/GenCP EVENT_CMD specific command data. More...
 
typedef struct PACK_STRUCT GENAPI_NAMESPACE::U3V_EVENT_MESSAGE U3V_EVENT_MESSAGE
 Entire event data message (without the variable-sized data field) More...
 
typedef std::list< uint64_t > UInt64List_t
 
typedef void * UserData_t
 
typedef std::list< IValue * > ValueList_t
 List of EnumInt-node references. More...
 

Enumerations

enum  _EAccessMode {
  NI, NA, WO, RO,
  RW, _UndefinedAccesMode, _CycleDetectAccesMode
}
 access mode of a node More...
 
enum  _ECachingMode { NoCache, WriteThrough, WriteAround, _UndefinedCachingMode }
 caching mode of a register More...
 
enum  _ECallbackType { cbPostInsideLock = 1, cbPostOutsideLock = 2 }
 the type of callback More...
 
enum  _EDisplayNotation { fnAutomatic, fnFixed, fnScientific, _UndefinedEDisplayNotation }
 typedef for float notation More...
 
enum  _EEndianess { BigEndian, LittleEndian, _UndefinedEndian }
 Endianess of a value in a register. More...
 
enum  _EGenApiSchemaVersion { v1_0 = 1, v1_1 = 2, _Undefined = -1 }
 GenApi schema version. More...
 
enum  _EIncMode { noIncrement, fixedIncrement, listIncrement }
 typedef for increment mode More...
 
enum  _EInputDirection { idFrom, idTo, idNone }
 typedef for link type More...
 
enum  _EInterfaceType {
  intfIValue, intfIBase, intfIInteger, intfIBoolean,
  intfICommand, intfIFloat, intfIString, intfIRegister,
  intfICategory, intfIEnumeration, intfIEnumEntry, intfIPort
}
 typedef for interface type More...
 
enum  _ELinkType {
  ctParentNodes, ctReadingChildren, ctWritingChildren, ctInvalidatingChildren,
  ctDependingNodes, ctTerminalNodes, ctValueChangingChildren
}
 typedef for link type More...
 
enum  _ENameSpace { Custom, Standard, _UndefinedNameSpace }
 Defines if a node name is standard or custom. More...
 
enum  _ERepresentation {
  Linear, Logarithmic, Boolean, PureNumber,
  HexNumber, IPV4Address, MACAddress, _UndefinedRepresentation
}
 recommended representation of a node value More...
 
enum  _ESign { Signed, Unsigned, _UndefinedSign }
 signed or unsigned integers More...
 
enum  _ESlope {
  Increasing, Decreasing, Varying, Automatic,
  _UndefinedESlope
}
 typedef for formula type More...
 
enum  _EStandardNameSpace {
  None, GEV, IIDC, CL,
  USB, _UndefinedStandardNameSpace
}
 Defines from which standard namespace a node name comes from. More...
 
enum  _EVisibility {
  Beginner = 0, Expert = 1, Guru = 2, Invisible = 3,
  _UndefinedVisibility = 99
}
 recommended visibility of a node More...
 
enum  _EXMLValidation {
  xvLoad = 0x00000001L, xvCycles = 0x00000002L, xvSFNC = 0x00000004L, xvDefault = 0x00000000L,
  xvAll = 0xffffffffL, _UndefinedEXMLValidation = 0x8000000L
}
 typedef describing the different validity checks which can be performed on an XML file More...
 
enum  _EYesNo { Yes = 1, No = 0, _UndefinedYesNo = 2 }
 Defines the choices of a Yes/No alternatives. More...
 
enum  ECacheUsage_t { CacheUsage_Automatic, CacheUsage_ForceWrite, CacheUsage_ForceRead, CacheUsage_Ignore }
 Lists the cache usage strategies. More...
 
enum  EContentType_t { ContentType_Xml, ContentType_ZippedXml }
 Lists the processable file types. More...
 
enum  EMethod {
  meUndefined, meGetAccessMode, meToString, meFromString,
  meGetValue, meSetValue, meGetMin, meGetMax,
  meGetInc, meExecute, meIsDone, meSetIntValue,
  meGetIntValue, meSet, meGet, meGetIncMode,
  meGetListOfValidValues
}
 denotes through which method call the node tree was entered More...
 
enum  ESetInvalidMode { simOnlyMe, simAll }
 Three different modes of operation for INodePrivate::SetInvalid() More...
 
enum  GVCP_MESSAGE_TAGS { TAG_EVENT_CMD = 0xc0, TAG_EVENTDATA_CMD = 0xc2 }
 

Functions

double abs (double x)
 
virtual EYesNo CacheChunkData () const =0
 Indicates if the chunk a adapter must hold a cached version of the chunk data. More...
 
GENAPI_DECL IDestroyCastToIDestroy (INodeMap *pNodeMap)
 makes sure the dynamic_cast operator is implemented in the DLL (due to a Linux bug) More...
 
virtual bool closeFile (const char *pFileName)=0
 
virtual void CollectCallbacksToFire (std::list< CNodeCallback * > &CallbacksToFire, bool allDependents=false)=0
 Update the registered callbacks. More...
 
EAccessMode Combine (EAccessMode Peter, EAccessMode Paul)
 Computes which access mode the two guards allow together. More...
 
EVisibility Combine (EVisibility Peter, EVisibility Paul)
 Computes which visibility the two guards allow together. More...
 
ECachingMode Combine (ECachingMode Peter, ECachingMode Paul)
 Computes which CachingMode results from a combination. More...
 
virtual bool Connect (IPort *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const =0
 Connects a port to a port node with given name. More...
 
virtual bool Connect (IPort *pPort) const =0
 Connects a port to the standard port "Device". More...
 
void DeAllocate (void *)
 
void DeleteDoubleCallbacks (std::list< CNodeCallback * > &CallbackList)
 deletes double callbacks from list More...
 
bool DeleteDoubleCallbacksCompare (GENAPI_NAMESPACE::CNodeCallback *pA, GENAPI_NAMESPACE::CNodeCallback *pB)
 Helper function for DeleteDoubleCallbacks. More...
 
virtual bool deleteFile (const char *pFileName)=0
 
GENAPI_DECL void Deregister (GENAPI_NAMESPACE::CallbackHandleType pCallbackInfo)
 Unregistering callback by handle. More...
 
virtual bool DeregisterCallback (CallbackHandleType hCallback)=0
 De register change callback. More...
 
std::istream & EatComments (std::istream &is)
 Helper function ignoring lines starting with comment character '#'. More...
 
virtual void ExtractIndependentSubtree (const GENICAM_NAMESPACE::gcstring &XMLData, const GENICAM_NAMESPACE::gcstring &InjectXMLData, const GENICAM_NAMESPACE::gcstring &SubTreeRootNodeName, GENICAM_NAMESPACE::gcstring &ExtractedSubtree)=0
 Extract independent subtree. More...
 
virtual void FinalConstruct (bool DetermineDependencies)=0
 finalizes construction of the node map More...
 
virtual void FinalConstruct ()=0
 Finalizes the creation of a node object. More...
 
virtual void FromString (const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true)=0
 Set content of the node as string. More...
 
GENAPI_DECL void GenApiTerminate ()
 Frees static resources hold by GenApi. More...
 
virtual void Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)=0
 Fills a buffer with the register's contents. More...
 
virtual int64_t GetAddress ()=0
 Retrieves the Address of the register. More...
 
virtual INodeGetAlias () const =0
 Retrieves the a node which describes the same feature in a different way. More...
 
virtual CounterGetBathometer ()=0
 Returns the object which counts the depth of SetValue() call-chains. More...
 
virtual int64_t getBufSize (const char *pFileName, std::ios_base::openmode mode)=0
 
virtual ECachingMode GetCachingMode () const =0
 Get Caching Mode. More...
 
virtual INodeGetCastAlias () const =0
 Retrieves the a node which describes the same feature so that it can be casted. More...
 
virtual void GetChildren (GENAPI_NAMESPACE::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const =0
 Get all nodes this node directly depends on. More...
 
virtual int64_t GetCookie ()=0
 Gets the cookie a port implementation may have set for caching a command list. More...
 
virtual IEnumEntryGetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0
 Get the current entry. More...
 
virtual GENICAM_NAMESPACE::gcstring GetDescription () const =0
 Get a long description of the node. More...
 
virtual GENICAM_NAMESPACE::gcstring GetDeviceName () const =0
 Get a name of the device. More...
 
virtual void GetDeviceVersion (Version_t &Version)=0
 Get the version of the device description file. More...
 
virtual GENICAM_NAMESPACE::gcstring GetDisplayName () const =0
 Get a name string for display. More...
 
virtual EDisplayNotation GetDisplayNotation () const =0
 Get the way the float should be converted to a string. More...
 
virtual int64_t GetDisplayPrecision () const =0
 Get the precision to be used when converting the float to a string. More...
 
virtual GENICAM_NAMESPACE::gcstring GetDocuURL () const =0
 Gets a URL pointing to the documentation of that feature. More...
 
virtual void GetEntries (NodeList_t &Entries)=0
 Get list of entry nodes. More...
 
virtual IEnumEntryGetEntry (const EnumT Value)=0
 returns the EnumEntry object belonging to the Value More...
 
virtual IEnumEntryGetEntry (const int64_t IntValue)=0
 Get an entry node by its IntValue. More...
 
virtual IEnumEntryGetEntryByName (const GENICAM_NAMESPACE::gcstring &Symbolic)=0
 Get an entry node by name. More...
 
virtual GENICAM_NAMESPACE::gcstring GetEntryPoint ()=0
 Returns the node and the method the client call has entered the node map. More...
 
GENICAM_NAMESPACE::gcstring getEntryPoint (INodeMap *nodeMap)
 
virtual GENICAM_NAMESPACE::gcstring GetEventID () const =0
 Get the EventId of the node. More...
 
virtual void GetGenApiVersion (Version_t &Version, uint16_t &Build)=0
 Get the version of the DLL's GenApi implementation. More...
 
virtual double GetInc ()=0
 Get the constant increment if there is any. More...
 
virtual EIncMode GetIncMode ()=0
 Get increment mode. More...
 
GENICAM_NAMESPACE::gcstring GetInterfaceName (IBase *pBase)
 Returns the name of the main interface as string DEPRECATED, use IBase::GetPrincipalInterfaceType() instead. More...
 
virtual int64_t GetIntValue (bool Verify=false, bool IgnoreCache=false)=0
 Get integer node value. More...
 
virtual int64_t GetLength ()=0
 Retrieves the Length of the register [Bytes]. More...
 
virtual double_autovector_t GetListOfValidValues (bool bounded=true)=0
 Get list of valid value. More...
 
virtual CLockGetLock () const =0
 Returns the lock which guards the node map. More...
 
virtual double GetMax ()=0
 Get maximum value allowed. More...
 
virtual int64_t GetMaxLength ()=0
 Retrieves the maximum length of the string in bytes. More...
 
virtual double GetMin ()=0
 Get minimum value allowed. More...
 
virtual GENAPI_NAMESPACE::ENameSpace GetNameSpace () const =0
 Get name space. More...
 
virtual INodeGetNode (const GENICAM_NAMESPACE::gcstring &Name) const =0
 Retrieves the node from the central map by Name. More...
 
virtual INodePrivateGetNodeByID (NodeID_t NodeID)=0
 Retrieves t Node given the NodeID. More...
 
virtual NodeID_t GetNodeID ()=0
 Reads back the node id. More...
 
virtual INodeMapGetNodeMap () const =0
 Retrieves the central node map. More...
 
virtual CNodeData::ENodeType_t GetNodeType ()=0
 Reads back the node type. More...
 
virtual double GetNumericValue ()=0
 Get double number associated with the entry. More...
 
virtual uint64_t GetNumNodes () const =0
 Get the number of nodes in the map. More...
 
virtual void GetParents (GENAPI_NAMESPACE::NodeList_t &Parents) const =0
 Gets all nodes this node is directly depending on. More...
 
virtual int64_t GetPollingTime () const =0
 recommended polling time (for not cachable nodes) More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const =0
 Get the type of the main interface of a node. More...
 
virtual GENICAM_NAMESPACE::gcstring GetProductGuid ()=0
 Get the Guid describing the product. More...
 
virtual bool GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const =0
 Retrieves a property from the node map itself. More...
 
virtual bool GetProperty (const GENICAM_NAMESPACE::gcstring &PropertyName, GENICAM_NAMESPACE::gcstring &ValueStr, GENICAM_NAMESPACE::gcstring &AttributeStr)=0
 Retrieves a property plus an additional attribute by name. More...
 
virtual void GetPropertyNames (GENICAM_NAMESPACE::gcstring_vector &PropertyNames) const =0
 Returns a list of the names all properties set during initialization. More...
 
virtual ERepresentation GetRepresentation ()=0
 Get recommended representation. More...
 
virtual void GetSchemaVersion (Version_t &Version)=0
 Get the schema version number. More...
 
virtual void GetSelectedFeatures (FeatureList_t &) const =0
 retrieve the group of selected features More...
 
virtual void GetSelectingFeatures (FeatureList_t &) const =0
 retrieve the group of features selecting this node More...
 
virtual void GetSelectorList (GENAPI_NAMESPACE::FeatureList_t &SelectorList, bool Incremental=false)=0
 Retrieves an ordered list of selectors. More...
 
virtual GENICAM_NAMESPACE::gcstring GetStandardNameSpace ()=0
 Get the standard name space. More...
 
virtual void GetSupportedSchemaVersions (GENICAM_NAMESPACE::gcstring_vector &SchemaVersions)=0
 Gets a list of supported schema versions. More...
 
virtual EYesNo GetSwapEndianess ()=0
 Determines if the port adapter must perform an endianess swap. More...
 
virtual GENICAM_NAMESPACE::gcstring GetSymbolic () const =0
 Get symbolic enum value. More...
 
virtual void GetTerminalNodes (NodeList_t &) const =0
 Returns the list of all terminal nodes a write access to this node will eventually write to. More...
 
virtual GENICAM_NAMESPACE::gcstring GetToolTip ()=0
 Get tool tip. More...
 
virtual GENICAM_NAMESPACE::gcstring GetUnit () const =0
 Get the physical unit name. More...
 
virtual bool GetValue (bool Verify=false, bool IgnoreCache=false) const =0
 Get node value. More...
 
virtual GENICAM_NAMESPACE::gcstring GetVendorName ()=0
 Get the vendor name. More...
 
virtual GENICAM_NAMESPACE::gcstring GetVersionGuid ()=0
 Get the Guid describing the product version. More...
 
virtual EVisibility GetVisibility () const =0
 Get the recommended visibility of the node. More...
 
virtual bool HasInc ()=0
 True if the float has a constant increment. More...
 
char Hex2Byte (uint8_t Hex)
 Converts an ASCII hex digit to a char value. More...
 
virtual void ImposeAccessMode (EAccessMode ImposedAccessMode)=0
 Imposes an access mode to the natural access mode of the node. More...
 
virtual void ImposeMax (int64_t Value)=0
 Restrict maximum value. More...
 
virtual void ImposeMax (double Value)=0
 Restrict maximum value. More...
 
virtual void ImposeMin (int64_t Value)=0
 Restrict minimum value. More...
 
virtual void ImposeMin (double Value)=0
 Restrict minimum value. More...
 
virtual void ImposeVisibility (EVisibility ImposedVisibility)=0
 Imposes a visibility to the natural visibility of the node. More...
 
virtual void InvalidateNode ()=0
 Indicates that the node's value may have changed. More...
 
virtual void InvalidateNodes () const =0
 Invalidates all nodes. More...
 
virtual EYesNo IsAccessModeCacheable () const =0
 True if the AccessMode can be cached. More...
 
bool IsAvailable (EAccessMode AccessMode)
 Tests if available. More...
 
bool IsAvailable (const IBase *p)
 Checks if a node is available. More...
 
bool IsAvailable (const IBase &r)
 Checks if a node is available. More...
 
template<class T , class B >
bool IsAvailable (const CPointer< T, B > &ptr)
 Checks if a node is Available. More...
 
virtual bool IsCachable () const =0
 Is the node value cachable. More...
 
bool IsCacheable (ECachingMode CachingMode)
 Tests Cacheability. More...
 
virtual bool IsDeprecated () const =0
 True if the node should not be used any more. More...
 
virtual bool IsDone (bool Verify=true)=0
 Query whether the command is executed. More...
 
virtual bool IsFeature () const =0
 True if the node can be reached via category nodes from a category node named "Root". More...
 
virtual bool IsGenApiDeviceLoggingEnabled ()=0
 Indicates if the GenApi.Device logging is enabled. More...
 
virtual bool IsGenApiLoggingEnabled ()=0
 Indicates if the GenApi logging is enabled. More...
 
bool IsImplemented (EAccessMode AccessMode)
 Tests if implemented. More...
 
bool IsImplemented (const IBase *p)
 Checks if a node is implemented. More...
 
bool IsImplemented (const IBase &r)
 Checks if a node is implemented. More...
 
template<class T , class B >
bool IsImplemented (const CPointer< T, B > &ptr)
 Checks if a node is Implemented. More...
 
bool IsReadable (EAccessMode AccessMode)
 Tests if readable. More...
 
bool IsReadable (const IBase *p)
 Checks if a node is readable. More...
 
bool IsReadable (const IBase &r)
 Checks if a node is readable. More...
 
template<class T , class B >
bool IsReadable (const CPointer< T, B > &ptr)
 Checks if a node is readable. More...
 
virtual bool IsSelfClearing ()=0
 Indicates if the corresponding EnumEntry is self clearing. More...
 
virtual bool IsStreamable () const =0
 True if the node is streamable. More...
 
virtual bool IsTerminalNode () const =0
 Returns true, if this node is terminal. More...
 
virtual bool IsValueCacheValid () const =0
 Checks if the value comes from cache or is requested from another node. More...
 
bool IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
 Tests Visibility. More...
 
bool IsWritable (EAccessMode AccessMode)
 Tests if writable. More...
 
bool IsWritable (const IBase *p)
 Checks if a node is writable. More...
 
bool IsWritable (const IBase &r)
 Checks if a node is writable. More...
 
template<class T , class B >
bool IsWritable (const CPointer< T, B > &ptr)
 Checks if a node is Writable. More...
 
virtual void LoadXMLFromFile (const GENICAM_NAMESPACE::gcstring &FileName)=0
 Loads an XML from a file. More...
 
virtual void LoadXMLFromFileInject (const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectFileName)=0
 Loads an XML from a file with injection. More...
 
virtual void LoadXMLFromString (const GENICAM_NAMESPACE::gcstring &XMLData)=0
 Loads an XML from a string. More...
 
virtual void LoadXMLFromStringInject (const GENICAM_NAMESPACE::gcstring &TargetXMLData, const GENICAM_NAMESPACE::gcstring &InjectXMLData)=0
 Loads an XML from a string with injection. More...
 
virtual void LoadXMLFromZIPData (const void *zipData, size_t zipSize)=0
 Loads an XML from a ZIP data buffer. More...
 
virtual void LoadXMLFromZIPFile (const GENICAM_NAMESPACE::gcstring &ZipFileName)=0
 Loads an XML from a ZIP file. More...
 
template<class Function >
CNodeCallbackmake_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType)
 make a new callback object for C functions More...
 
template<class Client , class Member >
CNodeCallbackmake_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType)
 make a new callback object for member functions More...
 
virtual void MergeXMLFiles (const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectedFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName)=0
 Injects an XML file into a target file. More...
 
void * MyAllocate (std::size_t)
 
virtual bool openFile (const char *pFileName, std::ios_base::openmode mode)=0
 
template<class T1 , class T2 >
bool operator!= (const MyAlloc< T1 > &, const MyAlloc< T2 > &) throw ()
 
virtual bool operator() () const
 Get node value. More...
 
virtual GENICAM_NAMESPACE::gcstring operator* ()=0
 Get string node value. More...
 
std::ostream & operator<< (std::ostream &os, const CFeatureBag &FeatureBag)
 writes out persistent data to a stream More...
 
std::ostream & operator<< (std::ostream &os, const CFeatureBagger &featureBagger)
 writes out persistent data to a stream More...
 
virtual IEnumerationoperator= (EnumT Value)=0
 Set node value. More...
 
virtual IFloatoperator= (double Value)=0
 Set node value. More...
 
virtual IIntegeroperator= (int64_t Value)=0
 Set node value. More...
 
virtual void operator= (bool Value)
 Set node value. More...
 
virtual IEnumerationoperator= (const GENICAM_NAMESPACE::gcstring &ValueStr)=0
 Set string node value. More...
 
template<class T1 , class T2 >
bool operator== (const MyAlloc< T1 > &, const MyAlloc< T2 > &) throw ()
 
std::istream & operator>> (std::istream &is, CFeatureBag &FeatureBag)
 reads in persistent data from a stream More...
 
std::istream & operator>> (std::istream &is, CFeatureBagger &featureBagger)
 reads back persistent data from a stream More...
 
virtual bool ParseSwissKnifes (GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL) const =0
 Parse all Swissknife equations. More...
 
virtual void PersistFeature (IValue &item)=0
 Stores a feature. More...
 
virtual bool Poll (int64_t ElapsedTime)=0
 Invalidates the node if the polling time has elapsed. More...
 
virtual void PreprocessXMLFromFile (const GENICAM_NAMESPACE::gcstring &XMLFileName, const GENICAM_NAMESPACE::gcstring &StyleSheetFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0
 Loads an XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file. More...
 
virtual void PreprocessXMLFromZIPFile (const GENICAM_NAMESPACE::gcstring &XMLFileName, const GENICAM_NAMESPACE::gcstring &StyleSheetFileName, const GENICAM_NAMESPACE::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0
 Loads a Zipped XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file. More...
 
virtual GenICam_streamsize read (char *buf, int64_t offs, GenICam_streamsize len, const char *pFileName)=0
 
template<class Function >
intptr_t Register (INode *pNode, Function f, ECallbackType CallbackType=cbPostInsideLock)
 Register a C-function as a callback. More...
 
template<class Client , class Member >
intptr_t Register (INode *pNode, Client &c, Member m, ECallbackType CallbackType=cbPostInsideLock)
 Register a C++-member function a callback. More...
 
virtual CallbackHandleType RegisterCallback (CNodeCallback *pCallback)=0
 Register change callback. More...
 
void ReplaceEnvironmentVariables (GENICAM_NAMESPACE::gcstring &Buffer)
 
virtual void Replay (IPort *pPort)=0
 Replays the write command to the given port interface. More...
 
virtual void ResetEntryPoint ()=0
 Sets the entry point to undefined. More...
 
virtual void Restore ()=0
 Restores the selectors' values found at creation. More...
 
int64_t round (double x)
 
void GENAPI_DECL SET_GUID (GUID &name, uint32_t l, uint16_t w1, uint16_t w2, uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4, uint8_t b5, uint8_t b6, uint8_t b7, uint8_t b8)
 
virtual void SetCookie (const int64_t Value)=0
 Sets a cookie in case the port implementation want to cache a command list. More...
 
virtual void SetEntryPoint (EMethod EntryMethod, const INodePrivate *pEntryNode, bool IgnoreCache)=0
 Sets the node and the method the client call has entered the node map. More...
 
virtual void SetIntValue (int64_t Value, bool Verify=true)=0
 Set integer node value. More...
 
virtual void SetInvalid (ESetInvalidMode simMode)=0
 Invalidate the node resp. the node and all of its dependents. More...
 
virtual bool SetNext (bool Tick=true)=0
 Sets digit to next value. More...
 
virtual void SetNumEnums (int NumEnums)=0
 sets the number of enum vallues More...
 
virtual void SetNumNodes (size_t NumNodes)=0
 Presets the number of nodes in order to resize the containers. More...
 
virtual void SetProperty (CProperty &Property)=0
 Sets a property to the node map itself. More...
 
virtual UserData_t SetUserData (UserData_t userdata)=0
 Stores user defined data without taking ownership. Returns the previously stored value. More...
 
virtual void StopRecording ()=0
 stops recording More...
 
template<typename T >
bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, T *Value)
 Converts a string to an T property. More...
 
GENAPI_DECL bool String2Value (const char *ValueStr, int64_t *Value, ERepresentation Representation=PureNumber)
 Converts a string to an int64_t property taking representation hints. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, CIntegerPolyRef *Value)
 Converts a string to a CIntegerPolyRef. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, CBooleanPolyRef *Value)
 Converts a string to a CBooleanPolyRef. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, CFloatPolyRef *Value)
 Converts a string to a CFloatPolyRef. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, CStringPolyRef *Value)
 Converts a string to a CStringPolyRef. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, GUID *Value)
 Converts a string to a GUID property. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, uint8_t *pValue, int64_t len)
 Converts a string to a byte array. More...
 
GENAPI_DECL bool String2Value (const GENICAM_NAMESPACE::gcstring &ValueStr, bool *pValue)
 Converts a string to a bool value. More...
 
virtual GENICAM_NAMESPACE::gcstring ToString ()=0
 Returns a string representation of the digit. More...
 
virtual GENICAM_NAMESPACE::gcstring ToString (bool Verify=false, bool IgnoreCache=false)=0
 Get content of the node as string. More...
 
template<typename T >
void Value2String (T Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts an T property to a string. More...
 
GENAPI_DECL void Value2String (int64_t Value, GENICAM_NAMESPACE::gcstring &ValueStr, ERepresentation Representation=PureNumber)
 Converts an int64_t property to a string taking representation hints. More...
 
GENAPI_DECL void Value2String (CIntegerPolyRef Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts a CIntegerPolyRef to a string. More...
 
GENAPI_DECL void Value2String (CBooleanPolyRef Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts a CBooleanPolyRef to a string. More...
 
GENAPI_DECL void Value2String (CFloatPolyRef Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts a CFloatPolyRef to a string. More...
 
GENAPI_DECL void Value2String (CStringPolyRef Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts a CStringPolyRef to a string. More...
 
GENAPI_DECL void Value2String (const GUID &Value, GENICAM_NAMESPACE::gcstring &ValueStr)
 Converts a GUID property tp a string. More...
 
GENAPI_DECL void Value2String (uint8_t *pValue, GENICAM_NAMESPACE::gcstring &ValueStr, int64_t len)
 Converts a byte array property to a string. More...
 
template<typename T >
void Values2String (const T &Values, GENICAM_NAMESPACE::gcstring &ValueStr)
 Dump a value container into a string. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)=0
 Writes a chunk of bytes to the port. More...
 
virtual GenICam_streamsize write (const char *buf, int64_t offs, int64_t len, const char *pFileName)=0
 
virtual ~IBase ()=0
 Virtual destructor enforcing virtual destructor on all derived classes. More...
 
virtual ~ISelectorDigit ()=0
 Virtual destructor enforcing virtual destructor on all derived classes. More...
 

Variables

interface GENAPI_DECL_ABSTRACT int64_t Address
 
const size_t CL_COMMAND_HEADER_SIZE = sizeof (CL_COMMAND_HEADER)
 
const size_t CL_EVENT_BASIC_SIZE = sizeof (CL_EVENT_MESSAGE)
 
const uint16_t CL_EVENT_CMD_ID = 0x0C00
 
const uint16_t CL_EVENT_PREAMBLE = 0x0100
 
const uint8_t COMMAND_MAGIC = 0x42
 
const size_t GENCP_COMMAND_HEADER_SIZE = sizeof (U3V_COMMAND_HEADER)
 
const size_t GENCP_EVENT_BASIC_SIZE = sizeof (U3V_EVENT_MESSAGE)
 
const uint16_t GENCP_EVENT_CMD_ID = 0x0C00
 
interface GENAPI_DECL_ABSTRACT IBase
 Base interface common to all nodes. More...
 
interface GENAPI_DECL_ABSTRACT IBoolean
 Interface for Boolean properties. More...
 
interface GENAPI_DECL_ABSTRACT ICategory
 Gives access to a category node. More...
 
interface GENAPI_DECL_ABSTRACT IChunkPort
 Interface for ports attached to a chunk. More...
 
interface GENAPI_DECL_ABSTRACT ICommand
 Interface for command like properties. More...
 
interface GENAPI_DECL_ABSTRACT IDestroy
 Interface to destroy an object. More...
 
interface GENAPI_DECL_ABSTRACT IDeviceInfo
 Interface to get information about the device (= nodemap) More...
 
interface GENAPI_DECL_ABSTRACT IEnumEntry
 Interface of single enum value. More...
 
interface GENAPI_DECL_ABSTRACT IEnumeration
 Interface for enumeration properties. More...
 
interface GENAPI_DECL_ABSTRACT IEnumReference
 Interface to construct an enum reference. More...
 
interface GENAPI_DECL_ABSTRACT IFileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...
 
interface GENAPI_DECL_ABSTRACT IFloat
 Interface for float properties. More...
 
interface GENAPI_DECL_ABSTRACT IInteger
 Interface for integer properties. More...
 
interface GENAPI_DECL_ABSTRACT INode
 Interface common to all nodes. More...
 
interface GENAPI_DECL_ABSTRACT INodeMap
 Interface to access the node map. More...
 
interface GENAPI_DECL_ABSTRACT INodeMapDyn
 Interface to access the node map. More...
 
interface GENAPI_DECL_ABSTRACT INodeMapPrivate
 NodeMap functions used for initialization. More...
 
interface GENAPI_DECL_ABSTRACT INodePrivate
 Interface including the methods for node construction common to all nodes. More...
 
interface GENAPI_DECL_ABSTRACT bool Invalidate = true ) = 0
 
interface GENAPI_DECL_ABSTRACT IPersistScript
 Basic interface to persist values to. More...
 
interface GENAPI_DECL_ABSTRACT IPort
 Interface for ports. More...
 
interface GENAPI_DECL_ABSTRACT IPortConstruct
 Interface for ports. More...
 
interface GENAPI_DECL_ABSTRACT IPortRecorder
 Interface for recording write commands on a port. More...
 
interface GENAPI_DECL_ABSTRACT IPortReplay
 Interface for replaying write commands on a port. More...
 
interface GENAPI_DECL_ABSTRACT IPortWriteList
 
interface GENAPI_DECL_ABSTRACT IReference
 Interface to construct a reference. More...
 
interface GENAPI_DECL_ABSTRACT IRegister
 Interface for registers. More...
 
interface GENAPI_DECL_ABSTRACT ISelector
 Interface for groups of features selected by a single one. More...
 
interface GENAPI_DECL_ABSTRACT ISelectorDigit
 Interface of a "digit" of the "counter" formed by the selector set. More...
 
interface GENAPI_DECL_ABSTRACT IString
 Interface for string properties. More...
 
interface GENAPI_DECL_ABSTRACT IUserData
 Interface to manage user data stored in nodes or nodemaps. More...
 
interface GENAPI_DECL_ABSTRACT IValue
 Interface for value properties. More...
 
interface GENAPI_DECL_ABSTRACT int64_t int64_t Length = 0
 
interface GENAPI_DECL_ABSTRACT CNodeData::ENodeType_t NodeID_t NodeID = 0
 
interface GENAPI_DECL_ABSTRACT CNodeData::ENodeType_t NodeType
 
const uint32_t U3V_EVENT_PREFIX = 0x45563355
 
interface GENAPI_DECL_ABSTRACT bool Verify = true) = 0
 

Detailed Description

Part of the generic device API.

Typedef Documentation

the callback handle for nodes

Definition at line 58 of file INode.h.

CL/GenCP command header.

CL/GenCP EVENT_CMD specific command data WITHOUT event specific data.

CL/GenCP EVENT_CMD specific command data WITH event specific data.

Entire event data message.

typedef INodePrivate*(* GENAPI_NAMESPACE::CreateFunc_t) (const GENICAM_NAMESPACE::gcstring &)

Definition at line 52 of file NodeMap.h.

Definition at line 132 of file AutovectorImpl.h.

the type of callback

GenApi schema version.

header of a GVCP request packet

layout of a GVCP event item (Extended ID flag not set)

layout of a GVCP event item (common to all types)

layout of a GVCP event item (Extended ID flag set)

Layout of a GVCP event request packet (Extended ID flag not set)

Layout of a GVCP event request packet (Extended ID flag set)

Layout of a GVCP event data request packet (Extended ID flag not set)

Layout of a GVCP event data request packet (Extended ID flag set)

header of a GVCP request packet

typedef IDevFileStreamBase<char, std::char_traits<char> > GENAPI_NAMESPACE::IDevFileStream

Definition at line 746 of file Filestream.h.

Definition at line 131 of file AutovectorImpl.h.

Definition at line 41 of file PrivateTypes.h.

List of Integer-node references.

Definition at line 45 of file PrivateTypes.h.

typedef node_vector GENAPI_NAMESPACE::NodeList_t

a list of node references

Definition at line 55 of file INode.h.

a vector of node references using the INodePrivate interface

Definition at line 58 of file INodePrivate.h.

typedef ODevFileStreamBase<char, std::char_traits<char> > GENAPI_NAMESPACE::ODevFileStream

Definition at line 745 of file Filestream.h.

Definition at line 42 of file PrivateTypes.h.

typedef std::list<uint64_t*> GENAPI_NAMESPACE::pUInt64List_t

Definition at line 40 of file PrivateTypes.h.

header of a GVCP request packet

U3V/GenCP command header.

U3V/GenCP EVENT_CMD specific command data.

Entire event data message (without the variable-sized data field)

typedef std::list<uint64_t> GENAPI_NAMESPACE::UInt64List_t

Definition at line 39 of file PrivateTypes.h.

Definition at line 24 of file IUserData.h.

typedef std::list<IValue *> GENAPI_NAMESPACE::ValueList_t

List of EnumInt-node references.

Definition at line 48 of file Register.h.

Enumeration Type Documentation

the type of callback

Enumerator
cbPostInsideLock 
cbPostOutsideLock 

callback is fired on leaving the tree inside the lock-guarded area

Definition at line 45 of file NodeCallback.h.

GenApi schema version.

Enumerator
v1_0 
v1_1 
_Undefined 

Definition at line 239 of file Types.h.

denotes through which method call the node tree was entered

Enumerator
meUndefined 
meGetAccessMode 
meToString 
meFromString 
meGetValue 
meSetValue 
meGetMin 
meGetMax 
meGetInc 
meExecute 
meIsDone 
meSetIntValue 
meGetIntValue 
meSet 
meGet 
meGetIncMode 
meGetListOfValidValues 

Definition at line 40 of file Exception.h.

Three different modes of operation for INodePrivate::SetInvalid()

Enumerator
simOnlyMe 

Invalidate only the node itself.

simAll 

Invalidate the node and all of its dependents.

Definition at line 91 of file INodePrivate.h.

Enumerator
TAG_EVENT_CMD 
TAG_EVENTDATA_CMD 

Definition at line 129 of file EventAdapterGEV.h.

Function Documentation

double GENAPI_NAMESPACE::abs ( double  x)
inline

Definition at line 61 of file PolyReference.h.

virtual EYesNo GENAPI_NAMESPACE::CacheChunkData ( ) const
pure virtual

Indicates if the chunk a adapter must hold a cached version of the chunk data.

GENAPI_DECL IDestroy* GENAPI_NAMESPACE::CastToIDestroy ( INodeMap pNodeMap)

makes sure the dynamic_cast operator is implemented in the DLL (due to a Linux bug)

virtual bool GENAPI_NAMESPACE::closeFile ( const char *  pFileName)
pure virtual
virtual void GENAPI_NAMESPACE::CollectCallbacksToFire ( std::list< CNodeCallback * > &  CallbacksToFire,
bool  allDependents = false 
)
pure virtual

Update the registered callbacks.

virtual bool GENAPI_NAMESPACE::Connect ( IPort pPort,
const GENICAM_NAMESPACE::gcstring PortName 
) const
pure virtual

Connects a port to a port node with given name.

virtual bool GENAPI_NAMESPACE::Connect ( IPort pPort) const
pure virtual

Connects a port to the standard port "Device".

void GENAPI_NAMESPACE::DeAllocate ( void *  )
void GENAPI_NAMESPACE::DeleteDoubleCallbacks ( std::list< CNodeCallback * > &  CallbackList)

deletes double callbacks from list

bool GENAPI_NAMESPACE::DeleteDoubleCallbacksCompare ( GENAPI_NAMESPACE::CNodeCallback pA,
GENAPI_NAMESPACE::CNodeCallback pB 
)

Helper function for DeleteDoubleCallbacks.

virtual bool GENAPI_NAMESPACE::deleteFile ( const char *  pFileName)
pure virtual
GENAPI_DECL void GENAPI_NAMESPACE::Deregister ( GENAPI_NAMESPACE::CallbackHandleType  pCallbackInfo)

Unregistering callback by handle.

virtual bool GENAPI_NAMESPACE::DeregisterCallback ( CallbackHandleType  hCallback)
pure virtual

De register change callback.

Destroys CNodeCallback object

Returns
true if the callback handle was valid
std::istream& GENAPI_NAMESPACE::EatComments ( std::istream &  is)
inline

Helper function ignoring lines starting with comment character '#'.

Definition at line 119 of file Persistence.h.

virtual void GENAPI_NAMESPACE::ExtractIndependentSubtree ( const GENICAM_NAMESPACE::gcstring XMLData,
const GENICAM_NAMESPACE::gcstring InjectXMLData,
const GENICAM_NAMESPACE::gcstring SubTreeRootNodeName,
GENICAM_NAMESPACE::gcstring ExtractedSubtree 
)
pure virtual

Extract independent subtree.

Parameters
InjectXMLData

The XML data the subtree is extracted from.

SubTreeRootNodeName

Optional XML data that is injected before extracting the subtree. No effect if an empty string is passed.

ExtractedSubtree

The name of the node that represents the root of the subtree that shall be extracted.> The returned extracted subtree as string.

virtual void GENAPI_NAMESPACE::FinalConstruct ( bool  DetermineDependencies)
pure virtual

finalizes construction of the node map

virtual void GENAPI_NAMESPACE::FinalConstruct ( )
pure virtual

Finalizes the creation of a node object.

virtual void GENAPI_NAMESPACE::FromString ( const GENICAM_NAMESPACE::gcstring ValueStr,
bool  Verify = true 
)
pure virtual

Set content of the node as string.

Parameters
ValueStrThe value to set
VerifyEnables AccessMode and Range verification (default = true)
GENAPI_DECL void GENAPI_NAMESPACE::GenApiTerminate ( )

Frees static resources hold by GenApi.

Frees all dynamically loaded DLLs held by the DLLManager

virtual void GENAPI_NAMESPACE::Get ( uint8_t *  pBuffer,
int64_t  Length,
bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Fills a buffer with the register's contents.

Parameters
pBufferThe buffer receiving the data to read
LengthThe number of bytes to retrieve
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
virtual int64_t GENAPI_NAMESPACE::GetAddress ( )
pure virtual

Retrieves the Address of the register.

virtual INode* GENAPI_NAMESPACE::GetAlias ( ) const
pure virtual

Retrieves the a node which describes the same feature in a different way.

virtual Counter& GENAPI_NAMESPACE::GetBathometer ( )
pure virtual

Returns the object which counts the depth of SetValue() call-chains.

virtual int64_t GENAPI_NAMESPACE::getBufSize ( const char *  pFileName,
std::ios_base::openmode  mode 
)
pure virtual
virtual ECachingMode GENAPI_NAMESPACE::GetCachingMode ( ) const
pure virtual

Get Caching Mode.

virtual INode* GENAPI_NAMESPACE::GetCastAlias ( ) const
pure virtual

Retrieves the a node which describes the same feature so that it can be casted.

virtual void GENAPI_NAMESPACE::GetChildren ( GENAPI_NAMESPACE::NodeList_t Children,
ELinkType  LinkType = ctReadingChildren 
) const
pure virtual

Get all nodes this node directly depends on.

Parameters
[out]ChildrenList of children nodes
LinkTypeThe link type
virtual int64_t GENAPI_NAMESPACE::GetCookie ( )
pure virtual

Gets the cookie a port implementation may have set for caching a command list.

IEnumEntry * GENAPI_NAMESPACE::GetCurrentEntry ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Get the current entry.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDescription ( ) const
pure virtual

Get a long description of the node.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDeviceName ( )
pure virtual

Get a name of the device.

Get device name.

The device name identifies a device instance, e.g. for debugging purposes. The default ist "Device".

virtual void GENAPI_NAMESPACE::GetDeviceVersion ( Version_t Version)
pure virtual

Get the version of the device description file.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDisplayName ( ) const
pure virtual

Get a name string for display.

virtual EDisplayNotation GENAPI_NAMESPACE::GetDisplayNotation ( ) const
pure virtual

Get the way the float should be converted to a string.

virtual int64_t GENAPI_NAMESPACE::GetDisplayPrecision ( ) const
pure virtual

Get the precision to be used when converting the float to a string.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetDocuURL ( ) const
pure virtual

Gets a URL pointing to the documentation of that feature.

virtual void GENAPI_NAMESPACE::GetEntries ( NodeList_t Entries)
pure virtual

Get list of entry nodes.

virtual IEnumEntry* GENAPI_NAMESPACE::GetEntry ( const EnumT  Value)
pure virtual

returns the EnumEntry object belonging to the Value

virtual IEnumEntry* GENAPI_NAMESPACE::GetEntry ( const int64_t  IntValue)
pure virtual

Get an entry node by its IntValue.

virtual IEnumEntry* GENAPI_NAMESPACE::GetEntryByName ( const GENICAM_NAMESPACE::gcstring Symbolic)
pure virtual

Get an entry node by name.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetEntryPoint ( )
pure virtual

Returns the node and the method the client call has entered the node map.

Returns
true it this information is available, false otherwise
GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::getEntryPoint ( INodeMap nodeMap)
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetEventID ( ) const
pure virtual

Get the EventId of the node.

virtual void GENAPI_NAMESPACE::GetGenApiVersion ( Version_t Version,
uint16_t &  Build 
)
pure virtual

Get the version of the DLL's GenApi implementation.

int64_t GENAPI_NAMESPACE::GetInc ( )
pure virtual

Get the constant increment if there is any.

Get increment.

EIncMode GENAPI_NAMESPACE::GetIncMode ( )
pure virtual

Get increment mode.

virtual int64_t GENAPI_NAMESPACE::GetIntValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Get integer node value.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read
virtual int64_t GENAPI_NAMESPACE::GetLength ( )
pure virtual

Retrieves the Length of the register [Bytes].

int64_autovector_t GENAPI_NAMESPACE::GetListOfValidValues ( bool  bounded = true)
pure virtual

Get list of valid value.

virtual CLock& GENAPI_NAMESPACE::GetLock ( ) const
pure virtual

Returns the lock which guards the node map.

int64_t GENAPI_NAMESPACE::GetMax ( )
pure virtual

Get maximum value allowed.

virtual int64_t GENAPI_NAMESPACE::GetMaxLength ( )
pure virtual

Retrieves the maximum length of the string in bytes.

int64_t GENAPI_NAMESPACE::GetMin ( )
pure virtual

Get minimum value allowed.

virtual GENAPI_NAMESPACE::ENameSpace GENAPI_NAMESPACE::GetNameSpace ( ) const
pure virtual

Get name space.

virtual INode* GENAPI_NAMESPACE::GetNode ( const GENICAM_NAMESPACE::gcstring Name) const
pure virtual

Retrieves the node from the central map by Name.

virtual INodePrivate* GENAPI_NAMESPACE::GetNodeByID ( NodeID_t  NodeID)
pure virtual

Retrieves t Node given the NodeID.

virtual NodeID_t GENAPI_NAMESPACE::GetNodeID ( )
pure virtual

Reads back the node id.

virtual INodeMap* GENAPI_NAMESPACE::GetNodeMap ( ) const
pure virtual

Retrieves the central node map.

virtual CNodeData::ENodeType_t GENAPI_NAMESPACE::GetNodeType ( )
pure virtual

Reads back the node type.

virtual double GENAPI_NAMESPACE::GetNumericValue ( )
pure virtual

Get double number associated with the entry.

virtual uint64_t GENAPI_NAMESPACE::GetNumNodes ( ) const
pure virtual

Get the number of nodes in the map.

virtual void GENAPI_NAMESPACE::GetParents ( GENAPI_NAMESPACE::NodeList_t Parents) const
pure virtual

Gets all nodes this node is directly depending on.

Parameters
[out]ParentsList of parent nodes
virtual int64_t GENAPI_NAMESPACE::GetPollingTime ( ) const
pure virtual

recommended polling time (for not cachable nodes)

virtual EInterfaceType GENAPI_NAMESPACE::GetPrincipalInterfaceType ( ) const
pure virtual

Get the type of the main interface of a node.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetProductGuid ( )
pure virtual

Get the Guid describing the product.

bool GENAPI_NAMESPACE::GetProperty ( CNodeDataMap *  pNodeDataMap,
CPropertyID::EProperty_ID_t  PropertyID,
CNodeData::PropertyVector_t &  PropertyList 
) const
pure virtual

Retrieves a property from the node map itself.

Gets all properties from a node which map a given PropertyID.

virtual bool GENAPI_NAMESPACE::GetProperty ( const GENICAM_NAMESPACE::gcstring PropertyName,
GENICAM_NAMESPACE::gcstring ValueStr,
GENICAM_NAMESPACE::gcstring AttributeStr 
)
pure virtual

Retrieves a property plus an additional attribute by name.

If a property has multiple values/attribute they come with Tabs as delimiters

virtual void GENAPI_NAMESPACE::GetPropertyNames ( GENICAM_NAMESPACE::gcstring_vector &  PropertyNames) const
pure virtual

Returns a list of the names all properties set during initialization.

ERepresentation GENAPI_NAMESPACE::GetRepresentation ( )
pure virtual

Get recommended representation.

virtual void GENAPI_NAMESPACE::GetSchemaVersion ( Version_t Version)
pure virtual

Get the schema version number.

virtual void GENAPI_NAMESPACE::GetSelectedFeatures ( FeatureList_t &  ) const
pure virtual

retrieve the group of selected features

virtual void GENAPI_NAMESPACE::GetSelectingFeatures ( FeatureList_t &  ) const
pure virtual

retrieve the group of features selecting this node

virtual void GENAPI_NAMESPACE::GetSelectorList ( GENAPI_NAMESPACE::FeatureList_t &  SelectorList,
bool  Incremental = false 
)
pure virtual

Retrieves an ordered list of selectors.

Parameters
Incremental

List to contain the selector pointer> if true only seletor changed since the last GetNext are contained

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetStandardNameSpace ( )
pure virtual

Get the standard name space.

virtual void GENAPI_NAMESPACE::GetSupportedSchemaVersions ( GENICAM_NAMESPACE::gcstring_vector &  SchemaVersions)
pure virtual

Gets a list of supported schema versions.

Each list entry is a string with the format "<Major>.<Minor>" were <Major> and <Minor> are integers Example: {"1.1", "1.2"} indicates that the schema v1.1 and v1.2 are supported. The SubMinor version number is not given since it is for fully compatible bug fixes only

virtual EYesNo GENAPI_NAMESPACE::GetSwapEndianess ( )
pure virtual

Determines if the port adapter must perform an endianess swap.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetSymbolic ( ) const
pure virtual

Get symbolic enum value.

virtual void GENAPI_NAMESPACE::GetTerminalNodes ( NodeList_t ) const
pure virtual

Returns the list of all terminal nodes a write access to this node will eventually write to.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetToolTip ( )
pure virtual

Get tool tip.

Get a short description of the node.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetUnit ( ) const
pure virtual

Get the physical unit name.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
) const
pure virtual

Get node value.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetVendorName ( )
pure virtual

Get the vendor name.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetVersionGuid ( )
pure virtual

Get the Guid describing the product version.

virtual EVisibility GENAPI_NAMESPACE::GetVisibility ( ) const
pure virtual

Get the recommended visibility of the node.

virtual bool GENAPI_NAMESPACE::HasInc ( )
pure virtual

True if the float has a constant increment.

char GENAPI_NAMESPACE::Hex2Byte ( uint8_t  Hex)
inline

Converts an ASCII hex digit to a char value.

Definition at line 134 of file Value2String.h.

virtual void GENAPI_NAMESPACE::ImposeAccessMode ( EAccessMode  ImposedAccessMode)
pure virtual

Imposes an access mode to the natural access mode of the node.

virtual void GENAPI_NAMESPACE::ImposeMax ( int64_t  Value)
pure virtual

Restrict maximum value.

virtual void GENAPI_NAMESPACE::ImposeMax ( double  Value)
pure virtual

Restrict maximum value.

virtual void GENAPI_NAMESPACE::ImposeMin ( int64_t  Value)
pure virtual

Restrict minimum value.

virtual void GENAPI_NAMESPACE::ImposeMin ( double  Value)
pure virtual

Restrict minimum value.

virtual void GENAPI_NAMESPACE::ImposeVisibility ( EVisibility  ImposedVisibility)
pure virtual

Imposes a visibility to the natural visibility of the node.

virtual void GENAPI_NAMESPACE::InvalidateNode ( )
pure virtual

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

virtual void GENAPI_NAMESPACE::InvalidateNodes ( ) const
pure virtual

Invalidates all nodes.

virtual EYesNo GENAPI_NAMESPACE::IsAccessModeCacheable ( ) const
pure virtual

True if the AccessMode can be cached.

virtual bool GENAPI_NAMESPACE::IsCachable ( ) const
pure virtual

Is the node value cachable.

virtual bool GENAPI_NAMESPACE::IsDeprecated ( ) const
pure virtual

True if the node should not be used any more.

virtual bool GENAPI_NAMESPACE::IsDone ( bool  Verify = true)
pure virtual

Query whether the command is executed.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
Returns
True if the Execute command has finished; false otherwise
virtual bool GENAPI_NAMESPACE::IsFeature ( ) const
pure virtual

True if the node can be reached via category nodes from a category node named "Root".

virtual bool GENAPI_NAMESPACE::IsGenApiDeviceLoggingEnabled ( )
pure virtual

Indicates if the GenApi.Device logging is enabled.

virtual bool GENAPI_NAMESPACE::IsGenApiLoggingEnabled ( )
pure virtual

Indicates if the GenApi logging is enabled.

virtual bool GENAPI_NAMESPACE::IsSelfClearing ( )
pure virtual

Indicates if the corresponding EnumEntry is self clearing.

virtual bool GENAPI_NAMESPACE::IsStreamable ( ) const
pure virtual

True if the node is streamable.

virtual bool GENAPI_NAMESPACE::IsTerminalNode ( ) const
pure virtual

Returns true, if this node is terminal.

virtual bool GENAPI_NAMESPACE::IsValueCacheValid ( ) const
pure virtual

Checks if the value comes from cache or is requested from another node.

virtual void GENAPI_NAMESPACE::LoadXMLFromFile ( const GENICAM_NAMESPACE::gcstring FileName)
pure virtual

Loads an XML from a file.

virtual void GENAPI_NAMESPACE::LoadXMLFromFileInject ( const GENICAM_NAMESPACE::gcstring TargetFileName,
const GENICAM_NAMESPACE::gcstring InjectFileName 
)
pure virtual

Loads an XML from a file with injection.

virtual void GENAPI_NAMESPACE::LoadXMLFromString ( const GENICAM_NAMESPACE::gcstring XMLData)
pure virtual

Loads an XML from a string.

virtual void GENAPI_NAMESPACE::LoadXMLFromStringInject ( const GENICAM_NAMESPACE::gcstring TargetXMLData,
const GENICAM_NAMESPACE::gcstring InjectXMLData 
)
pure virtual

Loads an XML from a string with injection.

virtual void GENAPI_NAMESPACE::LoadXMLFromZIPData ( const void *  zipData,
size_t  zipSize 
)
pure virtual

Loads an XML from a ZIP data buffer.

virtual void GENAPI_NAMESPACE::LoadXMLFromZIPFile ( const GENICAM_NAMESPACE::gcstring ZipFileName)
pure virtual

Loads an XML from a ZIP file.

virtual void GENAPI_NAMESPACE::MergeXMLFiles ( const GENICAM_NAMESPACE::gcstring TargetFileName,
const GENICAM_NAMESPACE::gcstring InjectedFileName,
const GENICAM_NAMESPACE::gcstring OutputFileName 
)
pure virtual

Injects an XML file into a target file.

Parameters
InjectedFileName

Name of the target XML file to process

OutputFileName

Name of the Injected XML file to process> Name of the oputput file

void* GENAPI_NAMESPACE::MyAllocate ( std::size_t  )
virtual bool GENAPI_NAMESPACE::openFile ( const char *  pFileName,
std::ios_base::openmode  mode 
)
pure virtual
template<class T1 , class T2 >
bool GENAPI_NAMESPACE::operator!= ( const MyAlloc< T1 > &  ,
const MyAlloc< T2 > &   
)
throw (
)

Definition at line 103 of file gcmemory.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::operator() ( ) const
virtual

Get node value.

Execute the command.

Definition at line 75 of file IBoolean.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::operator* ( )
pure virtual

Get string node value.

Get node value.

std::ostream& GENAPI_NAMESPACE::operator<< ( std::ostream &  os,
const CFeatureBag FeatureBag 
)
inline

writes out persistent data to a stream

puts the bag into a stream

Definition at line 194 of file Persistence.h.

std::ostream& GENAPI_NAMESPACE::operator<< ( std::ostream &  os,
const CFeatureBagger featureBagger 
)
inline

writes out persistent data to a stream

puts the bags into a stream

Definition at line 301 of file Persistence.h.

virtual IEnumeration& GENAPI_NAMESPACE::operator= ( EnumT  Value)
pure virtual

Set node value.

virtual IFloat& GENAPI_NAMESPACE::operator= ( double  Value)
pure virtual

Set node value.

virtual IInteger& GENAPI_NAMESPACE::operator= ( int64_t  Value)
pure virtual

Set node value.

virtual void GENAPI_NAMESPACE::operator= ( bool  Value)
virtual

Set node value.

Definition at line 64 of file IBoolean.h.

IString & GENAPI_NAMESPACE::operator= ( const GENICAM_NAMESPACE::gcstring ValueStr)
pure virtual

Set string node value.

Set node value.

Note : the operator= is not inherited thus the operator= versions from IEnumeration must be implemented again

template<class T1 , class T2 >
bool GENAPI_NAMESPACE::operator== ( const MyAlloc< T1 > &  ,
const MyAlloc< T2 > &   
)
throw (
)

Definition at line 98 of file gcmemory.h.

std::istream& GENAPI_NAMESPACE::operator>> ( std::istream &  is,
CFeatureBag FeatureBag 
)
inline

reads in persistent data from a stream

fills the bag from a stream

Definition at line 139 of file Persistence.h.

std::istream& GENAPI_NAMESPACE::operator>> ( std::istream &  is,
CFeatureBagger featureBagger 
)
inline

reads back persistent data from a stream

reads the bags from a stream

Definition at line 323 of file Persistence.h.

virtual bool GENAPI_NAMESPACE::ParseSwissKnifes ( GENICAM_NAMESPACE::gcstring_vector *  pErrorList = NULL) const
pure virtual

Parse all Swissknife equations.

virtual void GENAPI_NAMESPACE::PersistFeature ( IValue item)
pure virtual

Stores a feature.

void GENAPI_NAMESPACE::Poll ( int64_t  ElapsedTime)
pure virtual

Invalidates the node if the polling time has elapsed.

Fires nodes which have a polling time.

Returns
true : fire callback of that node
virtual void GENAPI_NAMESPACE::PreprocessXMLFromFile ( const GENICAM_NAMESPACE::gcstring XMLFileName,
const GENICAM_NAMESPACE::gcstring StyleSheetFileName,
const GENICAM_NAMESPACE::gcstring OutputFileName,
const uint32_t  XMLValidation = xvDefault 
)
pure virtual

Loads an XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file.

Parameters
StyleSheetFileName

The name of the XML file to process

OutputFileName

Optional name of a style sheet which is applied after the pre-processor (can be empty string) > This has no effect if the OutputFileName is an empty string

XMLValidation

Optional name of an output file into which the processed data is written (can be empty string)> Optional bit mask formed from EXMLValidation enumeration indicating which tests should be performed on the XML file

virtual void GENAPI_NAMESPACE::PreprocessXMLFromZIPFile ( const GENICAM_NAMESPACE::gcstring XMLFileName,
const GENICAM_NAMESPACE::gcstring StyleSheetFileName,
const GENICAM_NAMESPACE::gcstring OutputFileName,
const uint32_t  XMLValidation = xvDefault 
)
pure virtual

Loads a Zipped XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file.

Parameters
StyleSheetFileName

The name of the XML file to process

OutputFileName

Optional name of a style sheet which is applied after the pre-processor (can be empty string) > This has no effect if the OutputFileName is an empty string

XMLValidation

Optional name of an output file into which the processed data is written (can be empty string)> Optional bit mask formed from EXMLValidation enumeration indicating which tests should be performed on the XML file

virtual GenICam_streamsize GENAPI_NAMESPACE::read ( char *  buf,
int64_t  offs,
GenICam_streamsize  len,
const char *  pFileName 
)
pure virtual
virtual CallbackHandleType GENAPI_NAMESPACE::RegisterCallback ( CNodeCallback pCallback)
pure virtual

Register change callback.

Takes ownership of the CNodeCallback object

void GENAPI_NAMESPACE::ReplaceEnvironmentVariables ( GENICAM_NAMESPACE::gcstring Buffer)
virtual void GENAPI_NAMESPACE::Replay ( IPort pPort)
pure virtual

Replays the write command to the given port interface.

virtual void GENAPI_NAMESPACE::ResetEntryPoint ( )
pure virtual

Sets the entry point to undefined.

virtual void GENAPI_NAMESPACE::Restore ( )
pure virtual

Restores the selectors' values found at creation.

int64_t GENAPI_NAMESPACE::round ( double  x)
inline

Definition at line 51 of file PolyReference.h.

void GENAPI_DECL GENAPI_NAMESPACE::SET_GUID ( GUID &  name,
uint32_t  l,
uint16_t  w1,
uint16_t  w2,
uint8_t  b1,
uint8_t  b2,
uint8_t  b3,
uint8_t  b4,
uint8_t  b5,
uint8_t  b6,
uint8_t  b7,
uint8_t  b8 
)
virtual void GENAPI_NAMESPACE::SetCookie ( const int64_t  Value)
pure virtual

Sets a cookie in case the port implementation want to cache a command list.

virtual void GENAPI_NAMESPACE::SetEntryPoint ( EMethod  EntryMethod,
const INodePrivate pEntryNode,
bool  IgnoreCache 
)
pure virtual

Sets the node and the method the client call has entered the node map.

virtual void GENAPI_NAMESPACE::SetIntValue ( int64_t  Value,
bool  Verify = true 
)
pure virtual

Set integer node value.

Parameters
ValueThe value to set
VerifyEnables AccessMode and Range verification (default = true)
virtual void GENAPI_NAMESPACE::SetInvalid ( ESetInvalidMode  simMode)
pure virtual

Invalidate the node resp. the node and all of its dependents.

virtual bool GENAPI_NAMESPACE::SetNext ( bool  Tick = true)
pure virtual

Sets digit to next value.

Parameters
Tickif false the counter does not tick (but realize it could have)
Returns
true if the resulting value is valid
virtual void GENAPI_NAMESPACE::SetNumEnums ( int  NumEnums)
pure virtual

sets the number of enum vallues

virtual void GENAPI_NAMESPACE::SetNumNodes ( size_t  NumNodes)
pure virtual

Presets the number of nodes in order to resize the containers.

void GENAPI_NAMESPACE::SetProperty ( CProperty &  Property)
pure virtual

Sets a property to the node map itself.

Sets a property to the node.

virtual UserData_t GENAPI_NAMESPACE::SetUserData ( UserData_t  userdata)
pure virtual

Stores user defined data without taking ownership. Returns the previously stored value.

virtual void GENAPI_NAMESPACE::StopRecording ( )
pure virtual

stops recording

template<typename T >
bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
T *  Value 
)

Converts a string to an T property.

Definition at line 72 of file Value2String.h.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const char *  ValueStr,
int64_t Value,
ERepresentation  Representation = PureNumber 
)

Converts a string to an int64_t property taking representation hints.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
CIntegerPolyRef Value 
)

Converts a string to a CIntegerPolyRef.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
CBooleanPolyRef Value 
)

Converts a string to a CBooleanPolyRef.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
CFloatPolyRef Value 
)

Converts a string to a CFloatPolyRef.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
CStringPolyRef Value 
)

Converts a string to a CStringPolyRef.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
GUID *  Value 
)

Converts a string to a GUID property.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
uint8_t *  pValue,
int64_t  len 
)

Converts a string to a byte array.

GENAPI_DECL bool GENAPI_NAMESPACE::String2Value ( const GENICAM_NAMESPACE::gcstring ValueStr,
bool *  pValue 
)

Converts a string to a bool value.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::ToString ( )
pure virtual

Returns a string representation of the digit.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::ToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
pure virtual

Get content of the node as string.

Parameters
VerifyEnables Range verification (default = false). The AccessMode is always checked
IgnoreCacheIf true the value is read ignoring any caches (default = false)
Returns
The value read
template<typename T >
void GENAPI_NAMESPACE::Value2String ( Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts an T property to a string.

Definition at line 62 of file Value2String.h.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( int64_t  Value,
GENICAM_NAMESPACE::gcstring ValueStr,
ERepresentation  Representation = PureNumber 
)

Converts an int64_t property to a string taking representation hints.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( CIntegerPolyRef  Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts a CIntegerPolyRef to a string.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( CBooleanPolyRef  Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts a CBooleanPolyRef to a string.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( CFloatPolyRef  Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts a CFloatPolyRef to a string.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( CStringPolyRef  Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts a CStringPolyRef to a string.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( const GUID &  Value,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Converts a GUID property tp a string.

GENAPI_DECL void GENAPI_NAMESPACE::Value2String ( uint8_t *  pValue,
GENICAM_NAMESPACE::gcstring ValueStr,
int64_t  len 
)

Converts a byte array property to a string.

template<typename T >
void GENAPI_NAMESPACE::Values2String ( const T &  Values,
GENICAM_NAMESPACE::gcstring ValueStr 
)

Dump a value container into a string.

Definition at line 48 of file Value2String.h.

virtual void GENAPI_NAMESPACE::Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Writes a chunk of bytes to the port.

virtual GenICam_streamsize GENAPI_NAMESPACE::write ( const char *  buf,
int64_t  offs,
int64_t  len,
const char *  pFileName 
)
pure virtual
GENAPI_NAMESPACE::IBase::~IBase ( )
inlinepure virtual

Virtual destructor enforcing virtual destructor on all derived classes.

Definition at line 67 of file IBase.h.

ISelectorDigit::~ISelectorDigit ( )
inlinepure virtual

Virtual destructor enforcing virtual destructor on all derived classes.

Definition at line 72 of file ISelectorDigit.h.

Variable Documentation

const size_t GENAPI_NAMESPACE::CL_COMMAND_HEADER_SIZE = sizeof (CL_COMMAND_HEADER)

Definition at line 102 of file EventAdapterCL.h.

const size_t GENAPI_NAMESPACE::CL_EVENT_BASIC_SIZE = sizeof (CL_EVENT_MESSAGE)

Definition at line 103 of file EventAdapterCL.h.

const uint16_t GENAPI_NAMESPACE::CL_EVENT_CMD_ID = 0x0C00

Definition at line 101 of file EventAdapterCL.h.

const uint16_t GENAPI_NAMESPACE::CL_EVENT_PREAMBLE = 0x0100

Definition at line 100 of file EventAdapterCL.h.

const uint8_t GENAPI_NAMESPACE::COMMAND_MAGIC = 0x42

Definition at line 127 of file EventAdapterGEV.h.

const size_t GENAPI_NAMESPACE::GENCP_COMMAND_HEADER_SIZE = sizeof (U3V_COMMAND_HEADER)

Definition at line 82 of file EventAdapterU3V.h.

const size_t GENAPI_NAMESPACE::GENCP_EVENT_BASIC_SIZE = sizeof (U3V_EVENT_MESSAGE)

Definition at line 83 of file EventAdapterU3V.h.

const uint16_t GENAPI_NAMESPACE::GENCP_EVENT_CMD_ID = 0x0C00

Definition at line 81 of file EventAdapterU3V.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IDestroy
Initial value:
{
virtual void Destroy() = 0

Interface to destroy an object.

Definition at line 35 of file IDestroy.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPersistScript
Initial value:
{
virtual void SetInfo(const GENICAM_NAMESPACE::gcstring &Info) = 0
A string class which is a clone of std::string.
Definition: GCString.h:52

Basic interface to persist values to.

Definition at line 44 of file Persistence.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortWriteList
Initial value:
{
virtual void Write(const void *pBuffer, int64_t Address, int64_t Length) = 0
__int64 int64_t
Definition: config-win32.h:21
interface GENAPI_DECL_ABSTRACT int64_t Address
Definition: IPort.h:57
interface GENAPI_DECL_ABSTRACT int64_t int64_t Length
Definition: IPort.h:57
virtual void Write(const void *pBuffer, int64_t Address, int64_t Length)=0
Writes a chunk of bytes to the port.

Definition at line 45 of file IPortRecorder.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ISelectorDigit
Initial value:
{
virtual bool SetFirst() = 0

Interface of a "digit" of the "counter" formed by the selector set.

Definition at line 41 of file ISelectorDigit.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IUserData
Initial value:
{
virtual UserData_t GetUserData() const = 0
void * UserData_t
Definition: IUserData.h:24

Interface to manage user data stored in nodes or nodemaps.

Definition at line 34 of file IUserData.h.

const uint32_t GENAPI_NAMESPACE::U3V_EVENT_PREFIX = 0x45563355

Definition at line 80 of file EventAdapterU3V.h.



rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:55