Classes | Files | Typedefs | Enumerations | Functions | Variables
GenApi_PublicImpl

Classes

class  GENAPI_NAMESPACE::CCommandImpl
 ICommand implementation. More...
class  GENAPI_NAMESPACE::CLock
 A lock class. More...
class  GENAPI_NAMESPACE::CNodeCallback
 callback body instance for INode pointers More...
class  GENAPI_NAMESPACE::CReferenceT< T, I >
 Interface to construct a reference. More...
class  GENAPI_NAMESPACE::Function_NodeCallback< Function >
 Container for a function pointer. More...
class  GENAPI_NAMESPACE::LockableObject< Object >
 Instance-Lock for an object. More...
class  GENAPI_NAMESPACE::Member_NodeCallback< Client, Member >
 Container for a member function pointer. More...

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 laoding a DLL dynamically.


file  GenApiDll.h
 

declspec's to be used for GenApi Windows dll


file  GenApiNamespace.h
 

GenICam versioned namespace.


file  GlobalPragmas.h
 

This file must be included FIRST.


file  INodeMapPrivate.h
 

Definition of interface INodeMapPrivate.


file  INodePrivate.h
 

Definition of interface INodePrivate.


file  IPortConstruct.h
 

Definition of interface IPortConstruct.


file  LogDll.h
 

declspec's to be used for Log Windows dll


file  NodeCallback.h
 

Implementation helpers for CNodeCallback

Defines 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.


Typedefs

typedef CBaseRefT< IBase > GENAPI_NAMESPACE::CBaseRef
 Reference to an IBase pointer.
typedef CBooleanRefT< IBoolean > GENAPI_NAMESPACE::CBooleanRef
 Reference to an IBoolean pointer.
typedef CCategoryRefT< ICategory > GENAPI_NAMESPACE::CCategoryRef
 Reference to an ICategory pointer.
typedef CCommandRefT< ICommand > GENAPI_NAMESPACE::CCommandRef
 Reference to an ICommand pointer.
typedef CEnumEntryRefT
< IEnumEntry > 		GENAPI_NAMESPACE::CEnumEntryRef
 Reference to an IEnumEntry pointer.
typedef CFloatRefT< IFloat > GENAPI_NAMESPACE::CFloatRef
 Reference to an IFloat pointer.
typedef CIntegerRefT< IInteger > GENAPI_NAMESPACE::CIntegerRef
 Reference to an IInteger pointer.
typedef CPointer< INodeMapPrivate > GENAPI_NAMESPACE::CNodeMapPrivatePtr
 SmartPointer for INodeMapPrivate interface pointer.
typedef CPointer< INodePrivate > GENAPI_NAMESPACE::CNodePrivatePtr
 SmartPointer for INodePrivate interface pointer.
typedef CPointer< IPortConstruct > GENAPI_NAMESPACE::CPortConstructPtr
 SmartPointer for IPortConstruct interface pointer.
typedef CPortRecorderRefT
< IPortRecorder > 		GENAPI_NAMESPACE::CPortRecorderRef
 Reference to an IPortRecorder pointer.
typedef CPortRefT< IPort > GENAPI_NAMESPACE::CPortRef
 Reference to an IEnumEntry pointer.
typedef INodeMap *(__cdecl * GENAPI_NAMESPACE::Create_f )(const char *pDeviceName)
 Function prototype for the create function implemented by GenApi DLLs.
typedef CRegisterRefT< IRegister > GENAPI_NAMESPACE::CRegisterRef
 Reference to an IRegister pointer.
typedef CSelectorRefT< ISelector > GENAPI_NAMESPACE::CSelectorRef
 Reference to an ISelector pointer.
typedef CStringRefT< IString > GENAPI_NAMESPACE::CStringRef
 Reference to an IString pointer.
typedef CValueRefT< IValue > GENAPI_NAMESPACE::CValueRef
 Reference to an IValue pointer.
typedef enum
GENAPI_NAMESPACE::_EDisplayNotation 		GENAPI_NAMESPACE::EDisplayNotation
 typedef for float notation
typedef enum
GENAPI_NAMESPACE::_EIncMode 		GENAPI_NAMESPACE::EIncMode
 typedef for increment mode
typedef enum
GENAPI_NAMESPACE::_EInputDirection 		GENAPI_NAMESPACE::EInputDirection
 typedef for link type
typedef enum
GENAPI_NAMESPACE::_EInterfaceType 		GENAPI_NAMESPACE::EInterfaceType
 typedef for interface type
typedef enum
GENAPI_NAMESPACE::_ELinkType 		GENAPI_NAMESPACE::ELinkType
 typedef for link type
typedef enum
GENAPI_NAMESPACE::_ESlope 		GENAPI_NAMESPACE::ESlope
 typedef for formula type
typedef enum
GENAPI_NAMESPACE::_EXMLValidation 		GENAPI_NAMESPACE::EXMLValidation
 typedef describing the different validity checks which can be performed on an XML file
typedef void(__cdecl * GENAPI_NAMESPACE::GetGenApiVersion_f )(Version_t &Version)
 Function prototype for checking the DLL's GenApi version.
typedef
GENICAM_NAMESPACE::gcstring_vector 		GENAPI_NAMESPACE::StringList_t
 A list of strings.

Enumerations

enum  GENAPI_NAMESPACE::_EDisplayNotation { GENAPI_NAMESPACE::fnAutomatic, GENAPI_NAMESPACE::fnFixed, GENAPI_NAMESPACE::fnScientific, GENAPI_NAMESPACE::_UndefinedEDisplayNotation }
 typedef for float notation More...
enum  GENAPI_NAMESPACE::_EIncMode { GENAPI_NAMESPACE::noIncrement, GENAPI_NAMESPACE::fixedIncrement, GENAPI_NAMESPACE::listIncrement }
 typedef for increment mode More...
enum  GENAPI_NAMESPACE::_EInputDirection { GENAPI_NAMESPACE::idFrom, GENAPI_NAMESPACE::idTo, GENAPI_NAMESPACE::idNone }
 typedef for link type More...
enum  GENAPI_NAMESPACE::_EInterfaceType {
  GENAPI_NAMESPACE::intfIValue, GENAPI_NAMESPACE::intfIBase, GENAPI_NAMESPACE::intfIInteger, GENAPI_NAMESPACE::intfIBoolean,
  GENAPI_NAMESPACE::intfICommand, GENAPI_NAMESPACE::intfIFloat, GENAPI_NAMESPACE::intfIString, GENAPI_NAMESPACE::intfIRegister,
  GENAPI_NAMESPACE::intfICategory, GENAPI_NAMESPACE::intfIEnumeration, GENAPI_NAMESPACE::intfIEnumEntry, GENAPI_NAMESPACE::intfIPort
}
 typedef for interface type More...
enum  GENAPI_NAMESPACE::_ELinkType {
  GENAPI_NAMESPACE::ctParentNodes, GENAPI_NAMESPACE::ctReadingChildren, GENAPI_NAMESPACE::ctWritingChildren, GENAPI_NAMESPACE::ctInvalidatingChildren,
  GENAPI_NAMESPACE::ctDependingNodes, GENAPI_NAMESPACE::ctTerminalNodes, GENAPI_NAMESPACE::ctValueChangingChildren
}
 typedef for link type More...
enum  GENAPI_NAMESPACE::_ESlope {
  GENAPI_NAMESPACE::Increasing, GENAPI_NAMESPACE::Decreasing, GENAPI_NAMESPACE::Varying, GENAPI_NAMESPACE::Automatic,
  GENAPI_NAMESPACE::_UndefinedESlope
}
 typedef for formula type More...
enum  GENAPI_NAMESPACE::_EXMLValidation {
  GENAPI_NAMESPACE::xvLoad = 0x00000001L, GENAPI_NAMESPACE::xvCycles = 0x00000002L, GENAPI_NAMESPACE::xvSFNC = 0x00000004L, GENAPI_NAMESPACE::xvDefault = 0x00000000L,
  GENAPI_NAMESPACE::xvAll = 0xffffffffL, GENAPI_NAMESPACE::_UndefinedEXMLValidation = 0x8000000L
}
 typedef describing the different validity checks which can be performed on an XML file More...

Functions

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetInterfaceName (IBase *pBase)
 Returns the name of the main interface as string DEPRECATED, use IBase::GetPrincipalInterfaceType() instead.
template<class T , class B >
bool GENAPI_NAMESPACE::IsAvailable (const CPointer< T, B > &ptr)
 Checks if a node is Available.
template<class T , class B >
bool GENAPI_NAMESPACE::IsImplemented (const CPointer< T, B > &ptr)
 Checks if a node is Implemented.
template<class T , class B >
bool GENAPI_NAMESPACE::IsReadable (const CPointer< T, B > &ptr)
 Checks if a node is readable.
template<class T , class B >
bool GENAPI_NAMESPACE::IsWritable (const CPointer< T, B > &ptr)
 Checks if a node is Writable.
template<class Function >
CNodeCallback * GENAPI_NAMESPACE::make_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType)
 make a new callback object for C functions
template<class Client , class Member >
CNodeCallback * GENAPI_NAMESPACE::make_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType)
 make a new callback object for member functions

Variables

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMapPrivate
 NodeMap functions used for initialization.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodePrivate
 Interface including the methods for node construction common to all nodes.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortConstruct
 Interface for ports.
interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ISelector
 Interface for groups of features selected by a single one.
interface GENAPI_DECL_ABSTRACT
CNodeData::ENodeType_t
NodeID_t 		GENAPI_NAMESPACE::NodeID = 0
interface GENAPI_DECL_ABSTRACT
CNodeData::ENodeType_t 		GENAPI_NAMESPACE::NodeType

Typedef Documentation

typedef CBaseRefT<IBase> GENAPI_NAMESPACE::CBaseRef

Reference to an IBase pointer.

Definition at line 106 of file IBase.h.

typedef CBooleanRefT<IBoolean> GENAPI_NAMESPACE::CBooleanRef

Reference to an IBoolean pointer.

Definition at line 142 of file IBoolean.h.

typedef CCategoryRefT<ICategory> GENAPI_NAMESPACE::CCategoryRef

Reference to an ICategory pointer.

Definition at line 105 of file ICategory.h.

typedef CCommandRefT<ICommand> GENAPI_NAMESPACE::CCommandRef

Reference to an ICommand pointer.

Definition at line 128 of file ICommand.h.

typedef CEnumEntryRefT<IEnumEntry> GENAPI_NAMESPACE::CEnumEntryRef

Reference to an IEnumEntry pointer.

Definition at line 132 of file IEnumEntry.h.

typedef CFloatRefT<IFloat> GENAPI_NAMESPACE::CFloatRef

Reference to an IFloat pointer.

Definition at line 313 of file IFloat.h.

typedef CIntegerRefT<IInteger> GENAPI_NAMESPACE::CIntegerRef

Reference to an IInteger pointer.

Definition at line 275 of file IInteger.h.

typedef CPointer<INodeMapPrivate> GENAPI_NAMESPACE::CNodeMapPrivatePtr

SmartPointer for INodeMapPrivate interface pointer.

Definition at line 48 of file PointerImpl.h.

typedef CPointer<INodePrivate> GENAPI_NAMESPACE::CNodePrivatePtr

SmartPointer for INodePrivate interface pointer.

Definition at line 45 of file PointerImpl.h.

typedef CPointer<IPortConstruct> GENAPI_NAMESPACE::CPortConstructPtr

SmartPointer for IPortConstruct interface pointer.

Definition at line 258 of file Pointer.h.

typedef CPortRecorderRefT< IPortRecorder > GENAPI_NAMESPACE::CPortRecorderRef

Reference to an IPortRecorder pointer.

Definition at line 143 of file IPortRecorder.h.

typedef CPortRefT<IPort> GENAPI_NAMESPACE::CPortRef

Reference to an IEnumEntry pointer.

Definition at line 106 of file IPort.h.

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

Function prototype for the create function implemented by GenApi DLLs.

Definition at line 53 of file DLLLoad.h.

typedef CRegisterRefT<IRegister> GENAPI_NAMESPACE::CRegisterRef

Reference to an IRegister pointer.

Definition at line 141 of file IRegister.h.

typedef CSelectorRefT<ISelector> GENAPI_NAMESPACE::CSelectorRef

Reference to an ISelector pointer.

Definition at line 107 of file ISelector.h.

typedef CStringRefT<IString> GENAPI_NAMESPACE::CStringRef

Reference to an IString pointer.

Definition at line 163 of file IString.h.

typedef CValueRefT<IValue> GENAPI_NAMESPACE::CValueRef

Reference to an IValue pointer.

Definition at line 143 of file IValue.h.

typedef enum GENAPI_NAMESPACE::_EDisplayNotation GENAPI_NAMESPACE::EDisplayNotation

typedef for float notation

typedef enum GENAPI_NAMESPACE::_EIncMode GENAPI_NAMESPACE::EIncMode

typedef for increment mode

typedef enum GENAPI_NAMESPACE::_EInputDirection GENAPI_NAMESPACE::EInputDirection

typedef for link type

typedef enum GENAPI_NAMESPACE::_EInterfaceType GENAPI_NAMESPACE::EInterfaceType

typedef for interface type

typedef enum GENAPI_NAMESPACE::_ELinkType GENAPI_NAMESPACE::ELinkType

typedef for link type

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

typedef enum GENAPI_NAMESPACE::_ESlope GENAPI_NAMESPACE::ESlope

typedef for formula type

typedef enum GENAPI_NAMESPACE::_EXMLValidation GENAPI_NAMESPACE::EXMLValidation

typedef describing the different validity checks which can be performed on an XML file

The enum values for a bitfield of length uint32_t

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

Function prototype for checking the DLL's GenApi version.

Definition at line 57 of file DLLLoad.h.

typedef GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::StringList_t

A list of strings.

Definition at line 150 of file Types.h.

Enumeration Type Documentation

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

Definition at line 179 of file Types.h.

enum GENAPI_NAMESPACE::_EIncMode

typedef for increment mode

Enumerator:
noIncrement 
fixedIncrement 
listIncrement 

Definition at line 222 of file Types.h.

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

Definition at line 231 of file Types.h.

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

Definition at line 189 of file Types.h.

enum GENAPI_NAMESPACE::_ELinkType

typedef for link type

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.

Definition at line 209 of file Types.h.

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

Definition at line 155 of file Types.h.

enum GENAPI_NAMESPACE::_EXMLValidation

typedef describing the different validity checks which can be performed on an XML file

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.

Definition at line 167 of file Types.h.

Function Documentation

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::GetInterfaceName ( IBase *  pBase) [inline]

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

Definition at line 263 of file Pointer.h.

template<class T , class B >
bool GENAPI_NAMESPACE::IsAvailable ( const CPointer< T, B > &  ptr) [inline]

Checks if a node is Available.

Definition at line 329 of file Pointer.h.

template<class T , class B >
bool GENAPI_NAMESPACE::IsImplemented ( const CPointer< T, B > &  ptr) [inline]

Checks if a node is Implemented.

Definition at line 322 of file Pointer.h.

template<class T , class B >
bool GENAPI_NAMESPACE::IsReadable ( const CPointer< T, B > &  ptr) [inline]

Checks if a node is readable.

Definition at line 308 of file Pointer.h.

template<class T , class B >
bool GENAPI_NAMESPACE::IsWritable ( const CPointer< T, B > &  ptr) [inline]

Checks if a node is Writable.

Definition at line 315 of file Pointer.h.

template<class Function >
CNodeCallback* GENAPI_NAMESPACE::make_NodeCallback ( INode *  pNode,
Function  function,
ECallbackType  CallbackType 
)

make a new callback object for C functions

Definition at line 133 of file NodeCallback.h.

template<class Client , class Member >
CNodeCallback* GENAPI_NAMESPACE::make_NodeCallback ( INode *  pNode,
Client &  client,
Member  member,
ECallbackType  CallbackType 
)

make a new callback object for member functions

Definition at line 206 of file NodeCallback.h.

Variable Documentation

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMapPrivate

NodeMap functions used for initialization.

Definition at line 59 of file INodeMapPrivate.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodePrivate

Interface including the methods for node construction common to all nodes.

Definition at line 69 of file INodePrivate.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortConstruct

Interface for ports.

Definition at line 51 of file IPortConstruct.h.

interface GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ISelector

Interface for groups of features selected by a single one.

Definition at line 49 of file ISelector.h.

interface GENAPI_DECL_ABSTRACT CNodeData::ENodeType_t NodeID_t & GENAPI_NAMESPACE::NodeID = 0

Definition at line 59 of file INodeMapPrivate.h.

interface GENAPI_DECL_ABSTRACT CNodeData::ENodeType_t GENAPI_NAMESPACE::NodeType

Definition at line 59 of file INodeMapPrivate.h.


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 18:42:48