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	PointerImpl.h
	Definition of private drivates from 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	GENAPI_NAMESPACE::AttachStatistics_t
	Delivers information about the attached chunks and nodes. More...

class	GENAPI_NAMESPACE::CChunkAdapter
	Connects a chunked buffer to a node map. More...

class	GENAPI_NAMESPACE::CChunkPort
	Port attachable to a chunk in a buffer. More...

class	GENAPI_NAMESPACE::CEventAdapter
	Delivers Events to ports. More...

class	GENAPI_NAMESPACE::CEventPort
	Port attachable to an event. More...

class	GENAPI_NAMESPACE::CFloatPtr
	SmartPointer for IFloat interface pointer. More...

class	GENAPI_NAMESPACE::CPointer< T, B >
	Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...

class	GENAPI_NAMESPACE::CPortImpl
	Standard implementation for a port ! More...

class	GENAPI_NAMESPACE::CPortStackedImpl
	Standard implementation for a port ! More...

class	GENAPI_NAMESPACE::CRegisterSetHelper
	Copies data from buffer to variables in a typesafe manner. More...

Typedefs
typedef struct GENAPI_NAMESPACE::AttachStatistics_t	GENAPI_NAMESPACE::AttachStatistics_t
	Delivers information about the attached chunks and nodes. More...

typedef CPointer< IBase >	GENAPI_NAMESPACE::CBasePtr
	SmartPointer for IBase interface pointer. More...

typedef CPointer< IBoolean >	GENAPI_NAMESPACE::CBooleanPtr
	SmartPointer for IBoolean interface pointer. More...

typedef CPointer< ICategory >	GENAPI_NAMESPACE::CCategoryPtr
	SmartPointer for ICategory interface pointer. More...

typedef CPointer< IChunkPort >	GENAPI_NAMESPACE::CChunkPortPtr
	SmartPointer for IChunkPort interface pointer. More...

typedef CPointer< ICommand >	GENAPI_NAMESPACE::CCommandPtr
	SmartPointer for ICommand interface pointer. More...

typedef CPointer< IDeviceInfo, INodeMap >	GENAPI_NAMESPACE::CDeviceInfoPtr
	SmartPointer for IDeviceInfo interface pointer. More...

typedef CPointer< IEnumEntry >	GENAPI_NAMESPACE::CEnumEntryPtr
	SmartPointer for IEnumEntry interface pointer. More...

typedef CPointer< IEnumeration >	GENAPI_NAMESPACE::CEnumerationPtr
	SmartPointer for IEnumeration interface pointer. More...

typedef CPointer< IInteger >	GENAPI_NAMESPACE::CIntegerPtr
	SmartPointer for IInteger interface pointer. More...

typedef CPointer< INodeMap, INodeMap >	GENAPI_NAMESPACE::CNodeMapPtr
	SmartPointer for INodeMap interface pointer. More...

typedef CPointer< IUserData, INodeMap >	GENAPI_NAMESPACE::CNodeMapUserDataPtr
	SmartPointer for IUserData interface pointer. More...

typedef CPointer< INode >	GENAPI_NAMESPACE::CNodePtr
	SmartPointer for INode interface pointer. More...

typedef CPointer< IUserData >	GENAPI_NAMESPACE::CNodeUserDataPtr
	SmartPointer for IUserData interface pointer. More...

typedef CPointer< IPort >	GENAPI_NAMESPACE::CPortPtr
	SmartPointer for IPort interface pointer. More...

typedef CPointer< IPortRecorder >	GENAPI_NAMESPACE::CPortRecorderPtr
	SmartPointer for IPortRecorder interface pointer. More...

typedef CPointer< IPortReplay >	GENAPI_NAMESPACE::CPortReplayPtr
	SmartPointer for IPortReplay interface pointer. More...

typedef CPointer< IPortWriteList, IPortWriteList >	GENAPI_NAMESPACE::CPortWriteListPtr
	SmartPointer for IPortWriteList interface pointer. More...

typedef CPointer< IRegister >	GENAPI_NAMESPACE::CRegisterPtr
	SmartPointer for IRegister interface pointer. More...

typedef CPointer< ISelector >	GENAPI_NAMESPACE::CSelectorPtr
	SmartPointer for ISelector interface pointer. More...

typedef CPointer< IString >	GENAPI_NAMESPACE::CStringPtr
	SmartPointer for IString interface pointer. More...

typedef CPointer< IValue >	GENAPI_NAMESPACE::CValuePtr
	SmartPointer for IValue interface pointer. More...

typedef enum GENAPI_NAMESPACE::_EAccessMode	GENAPI_NAMESPACE::EAccessMode
	access mode of a node More...

typedef enum GENAPI_NAMESPACE::_ECachingMode	GENAPI_NAMESPACE::ECachingMode
	caching mode of a register More...

typedef enum GENAPI_NAMESPACE::_EEndianess	GENAPI_NAMESPACE::EEndianess
	Endianess of a value in a register. More...

typedef enum GENAPI_NAMESPACE::_ENameSpace	GENAPI_NAMESPACE::ENameSpace
	Defines if a node name is standard or custom. More...

typedef enum GENAPI_NAMESPACE::_ERepresentation	GENAPI_NAMESPACE::ERepresentation
	recommended representation of a node value More...

typedef enum GENAPI_NAMESPACE::_ESign	GENAPI_NAMESPACE::ESign
	signed or unsigned integers More...

typedef enum GENAPI_NAMESPACE::_EStandardNameSpace	GENAPI_NAMESPACE::EStandardNameSpace
	Defines from which standard namespace a node name comes from. More...

typedef enum GENAPI_NAMESPACE::_EVisibility	GENAPI_NAMESPACE::EVisibility
	recommended visibility of a node More...

typedef enum GENAPI_NAMESPACE::_EYesNo	GENAPI_NAMESPACE::EYesNo
	Defines the choices of a Yes/No alternatives. More...

Enumerations
enum	GENAPI_NAMESPACE::_EAccessMode { GENAPI_NAMESPACE::NI, GENAPI_NAMESPACE::NA, GENAPI_NAMESPACE::WO, GENAPI_NAMESPACE::RO, GENAPI_NAMESPACE::RW, GENAPI_NAMESPACE::_UndefinedAccesMode, GENAPI_NAMESPACE::_CycleDetectAccesMode }
	access mode of a node More...

enum	GENAPI_NAMESPACE::_ECachingMode { GENAPI_NAMESPACE::NoCache, GENAPI_NAMESPACE::WriteThrough, GENAPI_NAMESPACE::WriteAround, GENAPI_NAMESPACE::_UndefinedCachingMode }
	caching mode of a register More...

enum	GENAPI_NAMESPACE::_EEndianess { GENAPI_NAMESPACE::BigEndian, GENAPI_NAMESPACE::LittleEndian, GENAPI_NAMESPACE::_UndefinedEndian }
	Endianess of a value in a register. More...

enum	GENAPI_NAMESPACE::_ENameSpace { GENAPI_NAMESPACE::Custom, GENAPI_NAMESPACE::Standard, GENAPI_NAMESPACE::_UndefinedNameSpace }
	Defines if a node name is standard or custom. More...

enum	GENAPI_NAMESPACE::_ERepresentation { GENAPI_NAMESPACE::Linear, GENAPI_NAMESPACE::Logarithmic, GENAPI_NAMESPACE::Boolean, GENAPI_NAMESPACE::PureNumber, GENAPI_NAMESPACE::HexNumber, GENAPI_NAMESPACE::IPV4Address, GENAPI_NAMESPACE::MACAddress, GENAPI_NAMESPACE::_UndefinedRepresentation }
	recommended representation of a node value More...

enum	GENAPI_NAMESPACE::_ESign { GENAPI_NAMESPACE::Signed, GENAPI_NAMESPACE::Unsigned, GENAPI_NAMESPACE::_UndefinedSign }
	signed or unsigned integers More...

enum	GENAPI_NAMESPACE::_EStandardNameSpace { GENAPI_NAMESPACE::None, GENAPI_NAMESPACE::GEV, GENAPI_NAMESPACE::IIDC, GENAPI_NAMESPACE::CL, GENAPI_NAMESPACE::USB, GENAPI_NAMESPACE::_UndefinedStandardNameSpace }
	Defines from which standard namespace a node name comes from. More...

enum	GENAPI_NAMESPACE::_EVisibility { GENAPI_NAMESPACE::Beginner = 0, GENAPI_NAMESPACE::Expert = 1, GENAPI_NAMESPACE::Guru = 2, GENAPI_NAMESPACE::Invisible = 3, GENAPI_NAMESPACE::_UndefinedVisibility = 99 }
	recommended visibility of a node More...

enum	GENAPI_NAMESPACE::_EYesNo { GENAPI_NAMESPACE::Yes = 1, GENAPI_NAMESPACE::No = 0, GENAPI_NAMESPACE::_UndefinedYesNo = 2 }
	Defines the choices of a Yes/No alternatives. More...

Functions
template<class Function >
intptr_t	GENAPI_NAMESPACE::Register (INode *pNode, Function f, ECallbackType CallbackType=cbPostInsideLock)
	Register a C-function as a callback. More...

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

Detailed Description

Typedef Documentation

typedef struct GENAPI_NAMESPACE::AttachStatistics_t GENAPI_NAMESPACE::AttachStatistics_t

Delivers information about the attached chunks and nodes.

typedef CPointer<IBase> GENAPI_NAMESPACE::CBasePtr

SmartPointer for IBase interface pointer.

Definition at line 156 of file Pointer.h.

typedef CPointer<IBoolean> GENAPI_NAMESPACE::CBooleanPtr

SmartPointer for IBoolean interface pointer.

Definition at line 168 of file Pointer.h.

typedef CPointer<ICategory> GENAPI_NAMESPACE::CCategoryPtr

SmartPointer for ICategory interface pointer.

Definition at line 165 of file Pointer.h.

typedef CPointer<IChunkPort> GENAPI_NAMESPACE::CChunkPortPtr

SmartPointer for IChunkPort interface pointer.

Definition at line 198 of file Pointer.h.

typedef CPointer<ICommand> GENAPI_NAMESPACE::CCommandPtr

SmartPointer for ICommand interface pointer.

Definition at line 215 of file Pointer.h.

typedef CPointer<IDeviceInfo, INodeMap> GENAPI_NAMESPACE::CDeviceInfoPtr

SmartPointer for IDeviceInfo interface pointer.

Definition at line 204 of file Pointer.h.

typedef CPointer<IEnumEntry> GENAPI_NAMESPACE::CEnumEntryPtr

SmartPointer for IEnumEntry interface pointer.

Definition at line 183 of file Pointer.h.

typedef CPointer<IEnumeration> GENAPI_NAMESPACE::CEnumerationPtr

SmartPointer for IEnumeration interface pointer.

Definition at line 180 of file Pointer.h.

typedef CPointer<IInteger> GENAPI_NAMESPACE::CIntegerPtr

SmartPointer for IInteger interface pointer.

Definition at line 171 of file Pointer.h.

typedef CPointer<INodeMap, INodeMap> GENAPI_NAMESPACE::CNodeMapPtr

SmartPointer for INodeMap interface pointer.

Definition at line 201 of file Pointer.h.

typedef CPointer<IUserData, INodeMap> GENAPI_NAMESPACE::CNodeMapUserDataPtr

SmartPointer for IUserData interface pointer.

Definition at line 207 of file Pointer.h.

typedef CPointer<INode> GENAPI_NAMESPACE::CNodePtr

SmartPointer for INode interface pointer.

Definition at line 159 of file Pointer.h.

typedef CPointer<IUserData> GENAPI_NAMESPACE::CNodeUserDataPtr

SmartPointer for IUserData interface pointer.

Definition at line 209 of file Pointer.h.

typedef CPointer<IPort> GENAPI_NAMESPACE::CPortPtr

SmartPointer for IPort interface pointer.

Definition at line 186 of file Pointer.h.

typedef CPointer<IPortRecorder> GENAPI_NAMESPACE::CPortRecorderPtr

SmartPointer for IPortRecorder interface pointer.

Definition at line 192 of file Pointer.h.

typedef CPointer<IPortReplay> GENAPI_NAMESPACE::CPortReplayPtr

SmartPointer for IPortReplay interface pointer.

Definition at line 189 of file Pointer.h.

typedef CPointer<IPortWriteList, IPortWriteList> GENAPI_NAMESPACE::CPortWriteListPtr

SmartPointer for IPortWriteList interface pointer.

Definition at line 195 of file Pointer.h.

typedef CPointer<IRegister> GENAPI_NAMESPACE::CRegisterPtr

SmartPointer for IRegister interface pointer.

Definition at line 177 of file Pointer.h.

typedef CPointer<ISelector> GENAPI_NAMESPACE::CSelectorPtr

SmartPointer for ISelector interface pointer.

Definition at line 212 of file Pointer.h.

typedef CPointer<IString> GENAPI_NAMESPACE::CStringPtr

SmartPointer for IString interface pointer.

Definition at line 174 of file Pointer.h.

typedef CPointer<IValue> GENAPI_NAMESPACE::CValuePtr

SmartPointer for IValue interface pointer.

Definition at line 162 of file Pointer.h.

typedef enum GENAPI_NAMESPACE::_EAccessMode GENAPI_NAMESPACE::EAccessMode

access mode of a node

typedef enum GENAPI_NAMESPACE::_ECachingMode GENAPI_NAMESPACE::ECachingMode

caching mode of a register

typedef enum GENAPI_NAMESPACE::_EEndianess GENAPI_NAMESPACE::EEndianess

Endianess of a value in a register.

typedef enum GENAPI_NAMESPACE::_ENameSpace GENAPI_NAMESPACE::ENameSpace

Defines if a node name is standard or custom.

typedef enum GENAPI_NAMESPACE::_ERepresentation GENAPI_NAMESPACE::ERepresentation

recommended representation of a node value

typedef enum GENAPI_NAMESPACE::_ESign GENAPI_NAMESPACE::ESign

signed or unsigned integers

typedef enum GENAPI_NAMESPACE::_EStandardNameSpace GENAPI_NAMESPACE::EStandardNameSpace

Defines from which standard namespace a node name comes from.

typedef enum GENAPI_NAMESPACE::_EVisibility GENAPI_NAMESPACE::EVisibility

recommended visibility of a node

typedef enum GENAPI_NAMESPACE::_EYesNo GENAPI_NAMESPACE::EYesNo

Defines the choices of a Yes/No alternatives.

Enumeration Type Documentation

enum GENAPI_NAMESPACE::_EAccessMode

access mode of a node

Enumerator
NI	Not implemented.
NA	Not available.
WO	Write Only.
RO	Read Only.
RW	Read and Write.
_UndefinedAccesMode	Object is not yet initialized.
_CycleDetectAccesMode	used internally for AccessMode cycle detection

Definition at line 54 of file Types.h.

enum GENAPI_NAMESPACE::_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.

Definition at line 79 of file Types.h.

enum GENAPI_NAMESPACE::_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.

Definition at line 108 of file Types.h.

enum GENAPI_NAMESPACE::_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.

Definition at line 118 of file Types.h.

enum GENAPI_NAMESPACE::_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.
_UndefinedRepresentation

Definition at line 89 of file Types.h.

enum GENAPI_NAMESPACE::_ESign

signed or unsigned integers

Enumerator
Signed	Integer is signed.
Unsigned	Integer is unsigned.
_UndefinedSign	Object is not yet initialized.

Definition at line 45 of file Types.h.

enum GENAPI_NAMESPACE::_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.

Definition at line 128 of file Types.h.

enum GENAPI_NAMESPACE::_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.

Definition at line 68 of file Types.h.

enum GENAPI_NAMESPACE::_EYesNo

Defines the choices of a Yes/No alternatives.

Enumerator
Yes	yes
No	no
_UndefinedYesNo	Object is not yet initialized.

Definition at line 141 of file Types.h.

Function Documentation

template<class Function >

intptr_t GENAPI_NAMESPACE::Register	(	INode *	pNode,
		Function	f,
		ECallbackType	CallbackType = `cbPostInsideLock`
	)

Register a C-function as a callback.

Definition at line 146 of file NodeCallback.h.

template<class Client , class Member >

intptr_t GENAPI_NAMESPACE::Register	(	INode *	pNode,
		Client &	c,
		Member	m,
		ECallbackType	CallbackType = `cbPostInsideLock`
	)

Register a C++-member function a callback.

Definition at line 218 of file NodeCallback.h.

Files

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation