Implementation parts of the GenApi module which must be public

Files
file	Container.h
	Portable container classes for INode & IValue pointers.
file	Counter.h
	Definition of a simple Counter class.
file	DLLLoad.h
	Definition of function for loading a DLL dynamically.
file	IPortConstruct.h
	Definition of interface IPortConstruct.
file	NodeCallback.h
	Implementation helpers for CNodeCallbackDefines a bunch of templates for creating callback-functors taking a INode pointer and returning void.
file	Reference.h
	Definition of template CReference.
file	Synch.h
	Definition of Lock classes.
file	GenApiDll.h
	declspec's to be used for GenApi Windows dll
file	GenApiNamespace.h
	GenICam versioned namespace.
file	LogDll.h
	declspec's to be used for Log Windows dll

Classes
class	CNodeCallback
	callback body instance for INode pointers More...
class	Function_NodeCallback< Function >
	Container for a function pointer. More...
class	Member_NodeCallback< Client, Member >
	Container for a member function pointer. More...
class	CReferenceT< T, I >
	Reference to an IBase derived pointer. More...
class	CLock
	A lock class. More...
class	LockableObject< Object >
	Instance-Lock for an object. More...

Typedefs
typedef INodeMap *(__cdecl *	Create_f) (const char *pDeviceName)
typedef void(__cdecl *	GetGenApiVersion_f) (Version_t &Version)
typedef CBaseRefT< IBase >	CBaseRef
typedef CBooleanRefT< IBoolean >	CBooleanRef
typedef CCategoryRefT< ICategory >	CCategoryRef
typedef CCommandRefT< ICommand >	CCommandRef
typedef CEnumEntryRefT< IEnumEntry >	CEnumEntryRef
typedef CFloatRefT< IFloat >	CFloatRef
typedef CIntegerRefT< IInteger >	CIntegerRef
typedef CPortRefT< IPort >	CPortRef
typedef CPortRecorderRefT< IPortRecorder >	CPortRecorderRef
typedef CPortStackedRefT< IPortStacked >	CPortStackedRef
typedef CRegisterRefT< IRegister >	CRegisterRef
typedef CSelectorRefT< ISelector >	CSelectorRef
typedef CStringRefT< IString >	CStringRef
typedef CValueRefT< IValue >	CValueRef
typedef CPointer< IPortConstruct >	CPortConstructPtr
	SmartPointer for IPortConstruct interface pointer.
typedef CPointer< IPortStackedConstruct >	CPortStackedConstructPtr
	SmartPointer for IPortStackedConstruct interface pointer.
typedef GENICAM_NAMESPACE::gcstring_vector	StringList_t
typedef enum GENAPI_NAMESPACE::_ESlope	ESlope
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::_EDisplayNotation	EDisplayNotation
typedef enum GENAPI_NAMESPACE::_EInterfaceType	EInterfaceType
typedef enum GENAPI_NAMESPACE::_ELinkType	ELinkType
	typedef for link type More...
typedef enum GENAPI_NAMESPACE::_EIncMode	EIncMode
typedef enum GENAPI_NAMESPACE::_EInputDirection	EInputDirection
typedef enum GENAPI_NAMESPACE::_ECallbackSuppressMode	ECallbackSuppressMode

Enumerations
enum	_ESlope {   Increasing, Decreasing, Varying, Automatic,   _UndefinedESlope }
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	_EDisplayNotation { fnAutomatic, fnFixed, fnScientific, _UndefinedEDisplayNotation }
enum	_EInterfaceType {   intfIValue, intfIBase, intfIInteger, intfIBoolean,   intfICommand, intfIFloat, intfIString, intfIRegister,   intfICategory, intfIEnumeration, intfIEnumEntry, intfIPort }
enum	_ELinkType {   ctParentNodes, ctReadingChildren, ctWritingChildren, ctInvalidatingChildren,   ctDependingNodes, ctTerminalNodes, ctValueChangingChildren }
	typedef for link type More...
enum	_EIncMode
enum	_EInputDirection { idFrom, idTo, idNone }
enum	_ECallbackSuppressMode { csmOff = 0, csmActive, csmOnce }

Functions
template<class Function >
CNodeCallback *	make_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType)
	make a new callback object for C functions
template<class Client , class Member >
CNodeCallback *	make_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType)
	make a new callback object for member functions
GENICAM_NAMESPACE::gcstring	GetInterfaceName (IBase *pBase)
template<class T , class B >
bool	IsReadable (const CPointer< T, B > &ptr)
	Checks if a node is readable.
template<class T , class B >
bool	IsWritable (const CPointer< T, B > &ptr)
	Checks if a node is Writable.
template<class T , class B >
bool	IsImplemented (const CPointer< T, B > &ptr)
	Checks if a node is Implemented.
template<class T , class B >
bool	IsAvailable (const CPointer< T, B > &ptr)
	Checks if a node is Available.

Variables
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IFileProtocolAdapter
	Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPortConstruct
	Interface for ports.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IPortStackedConstruct
	Interface for ports.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	ISelector
	Interface for groups of features selected by a single one.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IReference
	Interface to construct a reference.
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT	IEnumReference
	Interface to construct an enum reference.

Detailed Description

Typedef Documentation

Create_f

typedef INodeMap*(__cdecl * Create_f) (const char *pDeviceName)

Function prototype for the create function implemented by GenApi DLLs

GetGenApiVersion_f

typedef void(__cdecl * GetGenApiVersion_f) (Version_t &Version)

Function prototype for checking the DLL's GenApi version

CBaseRef

typedef CBaseRefT<IBase> CBaseRef

Reference to an IBase pointer

CBooleanRef

typedef CBooleanRefT<IBoolean> CBooleanRef

Reference to an IBoolean pointer

CCategoryRef

typedef CCategoryRefT<ICategory> CCategoryRef

Reference to an ICategory pointer

CCommandRef

typedef CCommandRefT<ICommand> CCommandRef

Reference to an ICommand pointer

CEnumEntryRef

typedef CEnumEntryRefT<IEnumEntry> CEnumEntryRef

Reference to an IEnumEntry pointer

CFloatRef

typedef CFloatRefT<IFloat> CFloatRef

Reference to an IFloat pointer

CIntegerRef

typedef CIntegerRefT<IInteger> CIntegerRef

Reference to an IInteger pointer

CPortRef

typedef CPortRefT<IPort> CPortRef

Reference to an IEnumEntry pointer

CPortRecorderRef

typedef CPortRecorderRefT< IPortRecorder > CPortRecorderRef

Reference to an IPortRecorder pointer

CPortStackedRef

typedef CPortStackedRefT<IPortStacked> CPortStackedRef

Reference to an IEnumEntry pointer

CRegisterRef

typedef CRegisterRefT<IRegister> CRegisterRef

Reference to an IRegister pointer

CSelectorRef

typedef CSelectorRefT<ISelector> CSelectorRef

Reference to an ISelector pointer

CStringRef

typedef CStringRefT<IString> CStringRef

Reference to an IString pointer

CValueRef

typedef CValueRefT<IValue> CValueRef

Reference to an IValue pointer

StringList_t

typedef GENICAM_NAMESPACE::gcstring_vector StringList_t

A list of strings

ESlope

typedef enum GENAPI_NAMESPACE::_ESlope ESlope

typedef for formula type

EXMLValidation

typedef enum GENAPI_NAMESPACE::_EXMLValidation EXMLValidation

The enum values for a bitfield of length uint32_t

EDisplayNotation

typedef enum GENAPI_NAMESPACE::_EDisplayNotation EDisplayNotation

typedef for float notation

EInterfaceType

typedef enum GENAPI_NAMESPACE::_EInterfaceType EInterfaceType

typedef for interface type

ELinkType

typedef enum GENAPI_NAMESPACE::_ELinkType ELinkType

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

EIncMode

typedef enum GENAPI_NAMESPACE::_EIncMode EIncMode

typedef for increment mode

EInputDirection

typedef enum GENAPI_NAMESPACE::_EInputDirection EInputDirection

typedef for link type

ECallbackSuppressMode

typedef enum GENAPI_NAMESPACE::_ECallbackSuppressMode ECallbackSuppressMode

typedef for callback suppression mod

Enumeration Type Documentation

_ESlope

enum _ESlope

typedef for formula type

Enumerator
Increasing	strictly monotonous increasing
Decreasing	strictly monotonous decreasing
Varying	slope changes, e.g. at run-time
Automatic	slope is determined automatically by probing the function
_UndefinedESlope	Object is not yet initialized.

_EXMLValidation

enum _EXMLValidation

The enum values for a bitfield of length uint32_t

Enumerator
xvLoad	Creates a dummy node map.
xvCycles	checks for write and dependency cycles (implies xvLoad)
xvSFNC	checks for conformance with the standard feature naming convention (SFNC)
xvDefault	checks performed if nothing else is said
xvAll	all possible checks
_UndefinedEXMLValidation	Object is not yet initialized.

_EDisplayNotation

enum _EDisplayNotation

typedef for float notation

Enumerator
fnAutomatic	the notation if either scientific or fixed depending on what is shorter
fnFixed	the notation is fixed, e.g. 123.4
fnScientific	the notation is scientific, e.g. 1.234e2
_UndefinedEDisplayNotation	Object is not yet initialized.

_EInterfaceType

enum _EInterfaceType

typedef for interface type

Enumerator
intfIValue	IValue interface.
intfIBase	IBase interface.
intfIInteger	IInteger interface.
intfIBoolean	IBoolean interface.
intfICommand	ICommand interface.
intfIFloat	IFloat interface.
intfIString	IString interface.
intfIRegister	IRegister interface.
intfICategory	ICategory interface.
intfIEnumeration	IEnumeration interface.
intfIEnumEntry	IEnumEntry interface.
intfIPort	IPort interface.

_ELinkType

enum _ELinkType

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

Enumerator
ctParentNodes	All nodes for which this node is at least an invalidating child.
ctReadingChildren	All nodes which can be read from.
ctWritingChildren	All nodes which can write a value further down the node stack.
ctInvalidatingChildren	All directly connected nodes which invalidate this node.
ctDependingNodes	All directly or indirectly connected nodes which are invalidated by this nodes (i.e. which are dependent on this node)
ctTerminalNodes	All indirectly connected terminal nodes.
ctValueChangingChildren	All child node used to compute the value.

_EIncMode

enum _EIncMode

typedef for increment mode

_EInputDirection

enum _EInputDirection

typedef for link type

Enumerator
idFrom	Indicates a swiss knife that it is used as worker for a converter computing FROM.
idTo	Indicates a swiss knife that it is used as worker for a converter computing TO.
idNone	SwissKnife is not used within a converter.

_ECallbackSuppressMode

enum _ECallbackSuppressMode

typedef for callback suppression mod

Enumerator
csmOff	Indicates suppression is turned off.
csmActive	Indicates suppression is active.
csmOnce	Indicates suppression is used once.

Function Documentation

GetInterfaceName()

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetInterfaceName

(

IBase *

pBase

)

Returns the name of the main interface as string DEPRECATED, use IBase::GetPrincipalInterfaceType() instead