GenApi 3.5.1
Files | Classes | Typedefs | Enumerations | Functions
Public utilities of the GenApi module

Files

file  ChunkAdapter.h
 Declaration of the CChunkAdapter class.
 
file  ChunkPort.h
 Declaration of the CChunkPort class.
 
file  EventAdapter.h
 Declaration of the CEventAdapter class.
 
file  EventPort.h
 Declaration of the CEventPort class.
 
file  Persistence.h
 Definition of interface IPersistScript and class CFeatureBag.
 
file  Pointer.h
 Definition of template CPointer.
 
file  PortImpl.h
 Definition of CPortImpl.
 
file  PortStackedImpl.h
 Definition of CPortImpl.
 
file  RegisterSetHelper.h
 Definition of CRegisterSetHelper.
 
file  Types.h
 Common types used in the public GenApi interface.
 

Classes

struct  AttachStatistics_t
 
class  CChunkAdapter
 Connects a chunked buffer to a node map. More...
 
class  CChunkPort
 Port attachable to a chunk in a buffer. More...
 
class  CEventAdapter
 Delivers Events to ports. More...
 
class  CEventPort
 Port attachable to an event. More...
 
class  CPointer< T, B >
 Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...
 
class  CFloatPtr
 SmartPointer for IFloat interface pointer. More...
 
class  CPortImpl
 
class  CPortStackedImpl
 
class  CRegisterSetHelper
 Copies data from buffer to variables in a typesafe manner. More...
 

Typedefs

typedef struct GENAPI_NAMESPACE::AttachStatistics_t AttachStatistics_t
 
typedef CPointer< IBase > CBasePtr
 SmartPointer for IBase interface pointer.
 
typedef CPointer< INode > CNodePtr
 SmartPointer for INode interface pointer.
 
typedef CPointer< IValue > CValuePtr
 SmartPointer for IValue interface pointer.
 
typedef CPointer< ICategory > CCategoryPtr
 SmartPointer for ICategory interface pointer.
 
typedef CPointer< IBoolean > CBooleanPtr
 SmartPointer for IBoolean interface pointer.
 
typedef CPointer< IInteger > CIntegerPtr
 SmartPointer for IInteger interface pointer.
 
typedef CPointer< IString > CStringPtr
 SmartPointer for IString interface pointer.
 
typedef CPointer< IRegister > CRegisterPtr
 SmartPointer for IRegister interface pointer.
 
typedef CPointer< IEnumeration > CEnumerationPtr
 SmartPointer for IEnumeration interface pointer.
 
typedef CPointer< IEnumEntry > CEnumEntryPtr
 SmartPointer for IEnumEntry interface pointer.
 
typedef CPointer< IPort > CPortPtr
 SmartPointer for IPort interface pointer.
 
typedef CPointer< IPortReplay > CPortReplayPtr
 SmartPointer for IPortReplay interface pointer.
 
typedef CPointer< IPortRecorder > CPortRecorderPtr
 SmartPointer for IPortRecorder interface pointer.
 
typedef CPointer< IPortWriteList, IPortWriteList > CPortWriteListPtr
 SmartPointer for IPortWriteList interface pointer.
 
typedef CPointer< IChunkPort > CChunkPortPtr
 SmartPointer for IChunkPort interface pointer.
 
typedef CPointer< INodeMap, INodeMap > CNodeMapPtr
 SmartPointer for INodeMap interface pointer.
 
typedef CPointer< IDeviceInfo, INodeMap > CDeviceInfoPtr
 SmartPointer for IDeviceInfo interface pointer.
 
typedef CPointer< IUserData, INodeMap > CNodeMapUserDataPtr
 SmartPointer for IUserData interface pointer.
 
typedef CPointer< IUserData > CNodeUserDataPtr
 SmartPointer for IUserData interface pointer.
 
typedef CPointer< ISelector > CSelectorPtr
 SmartPointer for ISelector interface pointer.
 
typedef CPointer< ICommand > CCommandPtr
 SmartPointer for ICommand interface pointer.
 
typedef enum GENAPI_NAMESPACE::_ESign ESign
 
typedef enum GENAPI_NAMESPACE::_EAccessMode EAccessMode
 
typedef enum GENAPI_NAMESPACE::_EVisibility EVisibility
 
typedef enum GENAPI_NAMESPACE::_ECachingMode ECachingMode
 
typedef enum GENAPI_NAMESPACE::_ERepresentation ERepresentation
 
typedef enum GENAPI_NAMESPACE::_EEndianess EEndianess
 
typedef enum GENAPI_NAMESPACE::_ENameSpace ENameSpace
 
typedef enum GENAPI_NAMESPACE::_EStandardNameSpace EStandardNameSpace
 
typedef enum GENAPI_NAMESPACE::_EYesNo EYesNo
 

Enumerations

enum  _ESign { Signed , Unsigned , _UndefinedSign }
 
enum  _EAccessMode {
  NI , NA , WO , RO ,
  RW , _UndefinedAccessMode , _CycleDetectAccessMode
}
 
enum  _EVisibility {
  Beginner = 0 , Expert = 1 , Guru = 2 , Invisible = 3 ,
  _UndefinedVisibility = 99
}
 
enum  _ECachingMode { NoCache , WriteThrough , WriteAround , _UndefinedCachingMode }
 
enum  _ERepresentation {
  Linear , Logarithmic , Boolean , PureNumber ,
  HexNumber , IPV4Address , MACAddress , _UndefinedRepresentation
}
 
enum  _EEndianess { BigEndian , LittleEndian , _UndefinedEndian }
 
enum  _ENameSpace { Custom , Standard , _UndefinedNameSpace }
 
enum  _EStandardNameSpace {
  None , GEV , IIDC , CL ,
  USB , _UndefinedStandardNameSpace
}
 
enum  _EYesNo { Yes = 1 , No = 0 , _UndefinedYesNo = 2 }
 

Functions

template<class Function >
intptr_t Register (INode *pNode, Function f, ECallbackType CallbackType=cbPostInsideLock)
 Register a C-function as a callback.
 
template<class Client , class Member >
intptr_t Register (INode *pNode, Client &c, Member m, ECallbackType CallbackType=cbPostInsideLock)
 Register a C++-member function a callback.
 

Detailed Description

Typedef Documentation

◆ AttachStatistics_t

typedef struct GENAPI_NAMESPACE::AttachStatistics_t AttachStatistics_t

Delivers information about the attached chunks and nodes

◆ ESign

typedef enum GENAPI_NAMESPACE::_ESign ESign

signed or unsigned integers

◆ EAccessMode

typedef enum GENAPI_NAMESPACE::_EAccessMode EAccessMode

access mode of a node

◆ EVisibility

typedef enum GENAPI_NAMESPACE::_EVisibility EVisibility

recommended visibility of a node

◆ ECachingMode

typedef enum GENAPI_NAMESPACE::_ECachingMode ECachingMode

caching mode of a register

◆ ERepresentation

typedef enum GENAPI_NAMESPACE::_ERepresentation ERepresentation

recommended representation of a node value

◆ EEndianess

typedef enum GENAPI_NAMESPACE::_EEndianess EEndianess

Endianess of a value in a register

◆ ENameSpace

typedef enum GENAPI_NAMESPACE::_ENameSpace ENameSpace

Defines if a node name is standard or custom

◆ EStandardNameSpace

typedef enum GENAPI_NAMESPACE::_EStandardNameSpace EStandardNameSpace

Defines from which standard namespace a node name comes from

◆ EYesNo

typedef enum GENAPI_NAMESPACE::_EYesNo EYesNo

Defines the choices of a Yes/No alternatives

Enumeration Type Documentation

◆ _ESign

enum _ESign

signed or unsigned integers

Enumerator
Signed 

Integer is signed.

Unsigned 

Integer is unsigned.

_UndefinedSign 

Object is not yet initialized.

◆ _EAccessMode

access mode of a node

Enumerator
NI 

Not implemented.

NA 

Not available.

WO 

Write Only.

RO 

Read Only.

RW 

Read and Write.

_UndefinedAccessMode 

Object is not yet initialized.

_CycleDetectAccessMode 

used internally for AccessMode cycle detection

◆ _EVisibility

recommended visibility of a node

Enumerator
Beginner 

Always visible.

Expert 

Visible for experts or Gurus.

Guru 

Visible for Gurus.

Invisible 

Not Visible.

_UndefinedVisibility 

Object is not yet initialized.

◆ _ECachingMode

caching mode of a register

Enumerator
NoCache 

Do not use cache.

WriteThrough 

Write to cache and register.

WriteAround 

Write to register, write to cache on read.

_UndefinedCachingMode 

Not yet initialized.

◆ _ERepresentation

recommended representation of a node value

Enumerator
Linear 

Slider with linear behavior.

Logarithmic 

Slider with logarithmic behaviour.

Boolean 

Check box.

PureNumber 

Decimal number in an edit control.

HexNumber 

Hex number in an edit control.

IPV4Address 

IP-Address.

MACAddress 

MAC-Address.

◆ _EEndianess

Endianess of a value in a register

Enumerator
BigEndian 

Register is big endian.

LittleEndian 

Register is little endian.

_UndefinedEndian 

Object is not yet initialized.

◆ _ENameSpace

Defines if a node name is standard or custom

Enumerator
Custom 

name resides in custom namespace

Standard 

name resides in one of the standard namespaces

_UndefinedNameSpace 

Object is not yet initialized.

◆ _EStandardNameSpace

Defines from which standard namespace a node name comes from

Enumerator
None 

name resides in custom namespace

GEV 

name resides in GigE Vision namespace

IIDC 

name resides in 1394 IIDC namespace

CL 

name resides in camera link namespace

USB 

name resides in USB namespace

_UndefinedStandardNameSpace 

Object is not yet initialized.

◆ _EYesNo

enum _EYesNo

Defines the choices of a Yes/No alternatives

Enumerator
Yes 

yes

No 

no

_UndefinedYesNo 

Object is not yet initialized.