All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GenApi_PublicImpl

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  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.
 
file  Reference.h
 Definition of template CReference.
 
file  Synch.h
 Definition of Lock classes.
 

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 >
 Reference to an IBase derived pointer. 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...
 

Typedefs

typedef CBaseRefT< IBaseGENAPI_NAMESPACE::CBaseRef
 Reference to an IBase pointer. More...
 
typedef CBooleanRefT< IBooleanGENAPI_NAMESPACE::CBooleanRef
 Reference to an IBoolean pointer. More...
 
typedef CCategoryRefT< ICategoryGENAPI_NAMESPACE::CCategoryRef
 Reference to an ICategory pointer. More...
 
typedef CCommandRefT< ICommandGENAPI_NAMESPACE::CCommandRef
 Reference to an ICommand pointer. More...
 
typedef CEnumEntryRefT< IEnumEntryGENAPI_NAMESPACE::CEnumEntryRef
 Reference to an IEnumEntry pointer. More...
 
typedef CFloatRefT< IFloatGENAPI_NAMESPACE::CFloatRef
 Reference to an IFloat pointer. More...
 
typedef CIntegerRefT< IIntegerGENAPI_NAMESPACE::CIntegerRef
 Reference to an IInteger pointer. More...
 
typedef CPointer< INodeMapPrivateGENAPI_NAMESPACE::CNodeMapPrivatePtr
 SmartPointer for INodeMapPrivate interface pointer. More...
 
typedef CPointer< INodePrivateGENAPI_NAMESPACE::CNodePrivatePtr
 SmartPointer for INodePrivate interface pointer. More...
 
typedef CPointer< IPortConstructGENAPI_NAMESPACE::CPortConstructPtr
 SmartPointer for IPortConstruct interface pointer. More...
 
typedef CPortRecorderRefT< IPortRecorderGENAPI_NAMESPACE::CPortRecorderRef
 Reference to an IPortRecorder pointer. More...
 
typedef CPortRefT< IPortGENAPI_NAMESPACE::CPortRef
 Reference to an IEnumEntry pointer. More...
 
typedef CPointer< IPortStackedConstructGENAPI_NAMESPACE::CPortStackedConstructPtr
 SmartPointer for IPortStackedConstruct interface pointer. More...
 
typedef CPortStackedRefT< IPortStackedGENAPI_NAMESPACE::CPortStackedRef
 Reference to an IEnumEntry pointer. More...
 
typedef INodeMap *(__cdeclGENAPI_NAMESPACE::Create_f) (const char *pDeviceName)
 Function prototype for the create function implemented by GenApi DLLs. More...
 
typedef CRegisterRefT< IRegisterGENAPI_NAMESPACE::CRegisterRef
 Reference to an IRegister pointer. More...
 
typedef CSelectorRefT< ISelectorGENAPI_NAMESPACE::CSelectorRef
 Reference to an ISelector pointer. More...
 
typedef CStringRefT< IStringGENAPI_NAMESPACE::CStringRef
 Reference to an IString pointer. More...
 
typedef CValueRefT< IValueGENAPI_NAMESPACE::CValueRef
 Reference to an IValue pointer. More...
 
typedef enum GENAPI_NAMESPACE::_ECallbackSuppressMode GENAPI_NAMESPACE::ECallbackSuppressMode
 typedef for callback suppression mod More...
 
typedef enum GENAPI_NAMESPACE::_EDisplayNotation GENAPI_NAMESPACE::EDisplayNotation
 typedef for float notation More...
 
typedef enum GENAPI_NAMESPACE::_EIncMode GENAPI_NAMESPACE::EIncMode
 typedef for increment mode More...
 
typedef enum GENAPI_NAMESPACE::_EInputDirection GENAPI_NAMESPACE::EInputDirection
 typedef for link type More...
 
typedef enum GENAPI_NAMESPACE::_EInterfaceType GENAPI_NAMESPACE::EInterfaceType
 typedef for interface type More...
 
typedef enum GENAPI_NAMESPACE::_ELinkType GENAPI_NAMESPACE::ELinkType
 typedef for link type More...
 
typedef enum GENAPI_NAMESPACE::_ESlope GENAPI_NAMESPACE::ESlope
 typedef for formula type More...
 
typedef enum GENAPI_NAMESPACE::_EXMLValidation GENAPI_NAMESPACE::EXMLValidation
 typedef describing the different validity checks which can be performed on an XML file More...
 
typedef void(__cdeclGENAPI_NAMESPACE::GetGenApiVersion_f) (Version_t &Version)
 Function prototype for checking the DLL's GenApi version. More...
 
typedef GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::StringList_t
 A list of strings. More...
 

Enumerations

enum  GENAPI_NAMESPACE::_ECallbackSuppressMode { GENAPI_NAMESPACE::csmOff = 0, GENAPI_NAMESPACE::csmActive, GENAPI_NAMESPACE::csmOnce }
 typedef for callback suppression mod More...
 
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. More...
 
template<class T , class B >
bool GENAPI_NAMESPACE::IsAvailable (const CPointer< T, B > &ptr)
 Checks if a node is Available. More...
 
template<class T , class B >
bool GENAPI_NAMESPACE::IsImplemented (const CPointer< T, B > &ptr)
 Checks if a node is Implemented. More...
 
template<class T , class B >
bool GENAPI_NAMESPACE::IsReadable (const CPointer< T, B > &ptr)
 Checks if a node is readable. More...
 
template<class T , class B >
bool GENAPI_NAMESPACE::IsWritable (const CPointer< T, B > &ptr)
 Checks if a node is Writable. More...
 
template<class Client , class Member >
CNodeCallbackGENAPI_NAMESPACE::make_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType)
 make a new callback object for member functions More...
 
template<class Function >
CNodeCallbackGENAPI_NAMESPACE::make_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType)
 make a new callback object for C functions More...
 

Variables

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumReference
 Interface to construct an enum reference. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IFileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodeMapPrivate
 NodeMap functions used for initialization. More...
 
GENICAM_INTERFACE GENAPI_NAMESPACE::INodePrivate
 Interface including the methods for node construction common to all nodes. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortConstruct
 Interface for ports. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IPortStackedConstruct
 Interface for ports. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IReference
 Interface to construct a reference. More...
 
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::ISelector
 Interface for groups of features selected by a single one. More...
 

Detailed Description

Typedef Documentation

◆ CBaseRef

Reference to an IBase pointer.

Definition at line 106 of file IBase.h.

◆ CBooleanRef

Reference to an IBoolean pointer.

Definition at line 150 of file IBoolean.h.

◆ CCategoryRef

Reference to an ICategory pointer.

Definition at line 108 of file ICategory.h.

◆ CCommandRef

Reference to an ICommand pointer.

Definition at line 123 of file ICommand.h.

◆ CEnumEntryRef

Reference to an IEnumEntry pointer.

Definition at line 132 of file IEnumEntry.h.

◆ CFloatRef

Reference to an IFloat pointer.

Definition at line 294 of file IFloat.h.

◆ CIntegerRef

Reference to an IInteger pointer.

Definition at line 257 of file IInteger.h.

◆ CNodeMapPrivatePtr

SmartPointer for INodeMapPrivate interface pointer.

Definition at line 48 of file PointerImpl.h.

◆ CNodePrivatePtr

SmartPointer for INodePrivate interface pointer.

Definition at line 45 of file PointerImpl.h.

◆ CPortConstructPtr

SmartPointer for IPortConstruct interface pointer.

Definition at line 260 of file Pointer.h.

◆ CPortRecorderRef

Reference to an IPortRecorder pointer.

Definition at line 154 of file IPortRecorder.h.

◆ CPortRef

Reference to an IEnumEntry pointer.

Definition at line 113 of file IPort.h.

◆ CPortStackedConstructPtr

SmartPointer for IPortStackedConstruct interface pointer.

Definition at line 263 of file Pointer.h.

◆ CPortStackedRef

Reference to an IEnumEntry pointer.

Definition at line 109 of file IPortStacked.h.

◆ Create_f

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.

◆ CRegisterRef

Reference to an IRegister pointer.

Definition at line 137 of file IRegister.h.

◆ CSelectorRef

Reference to an ISelector pointer.

Definition at line 114 of file ISelector.h.

◆ CStringRef

Reference to an IString pointer.

Definition at line 157 of file IString.h.

◆ CValueRef

Reference to an IValue pointer.

Definition at line 141 of file IValue.h.

◆ ECallbackSuppressMode

typedef for callback suppression mod

◆ EDisplayNotation

◆ EIncMode

typedef for increment mode

◆ EInputDirection

◆ EInterfaceType

◆ ELinkType

typedef for link type

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

◆ ESlope

typedef for formula type

◆ 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

◆ GetGenApiVersion_f

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.

◆ StringList_t

typedef GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::StringList_t

A list of strings.

Definition at line 149 of file Types.h.

Enumeration Type Documentation

◆ _ECallbackSuppressMode

typedef for callback suppression mod

Enumerator
csmOff 

Indicates suppression is turned off.

csmActive 

Indicates suppression is active.

csmOnce 

Indicates suppression is used once.

Definition at line 247 of file Types.h.

◆ _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 178 of file Types.h.

◆ _EIncMode

typedef for increment mode

Enumerator
noIncrement 
fixedIncrement 
listIncrement 

Definition at line 221 of file Types.h.

◆ _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 230 of file Types.h.

◆ _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 188 of file Types.h.

◆ _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 208 of file Types.h.

◆ _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 154 of file Types.h.

◆ _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 166 of file Types.h.

Function Documentation

◆ GetInterfaceName()

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 267 of file Pointer.h.

◆ IsAvailable()

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

Checks if a node is Available.

Definition at line 333 of file Pointer.h.

◆ IsImplemented()

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

Checks if a node is Implemented.

Definition at line 326 of file Pointer.h.

◆ IsReadable()

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

Checks if a node is readable.

Definition at line 312 of file Pointer.h.

◆ IsWritable()

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

Checks if a node is Writable.

Definition at line 319 of file Pointer.h.

◆ make_NodeCallback() [1/2]

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.

◆ make_NodeCallback() [2/2]

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.

Variable Documentation

◆ IEnumReference

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IEnumReference
Initial value:
{
virtual void SetEnumReference( int Index, GENICAM_NAMESPACE::gcstring Name) = 0

Interface to construct an enum reference.

Definition at line 64 of file Reference.h.

◆ IFileProtocolAdapter

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IFileProtocolAdapter
Initial value:
{
virtual bool attach(GENAPI_NAMESPACE::INodeMap * pInterface) = 0

Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem.

Definition at line 88 of file Filestream.h.

◆ INodeMapPrivate

GENICAM_INTERFACE GENAPI_NAMESPACE::INodeMapPrivate

NodeMap functions used for initialization.

Definition at line 59 of file INodeMapPrivate.h.

◆ INodePrivate

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::INodePrivate

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

Definition at line 54 of file INodePrivate.h.

◆ IPortConstruct

GENICAM_INTERFACE GENAPI_NAMESPACE::IPortConstruct

Interface for ports.

Definition at line 52 of file IPortConstruct.h.

◆ IPortStackedConstruct

GENICAM_INTERFACE GENAPI_NAMESPACE::IPortStackedConstruct
Initial value:
{
virtual void SetPortImpl(IPortStacked *pPort) = 0

Interface for ports.

Definition at line 63 of file IPortConstruct.h.

◆ IReference

GENICAM_INTERFACE GENAPI_DECL_ABSTRACT GENAPI_NAMESPACE::IReference
Initial value:
{
virtual void SetReference( GENAPI_NAMESPACE::IBase *pBase ) = 0

Interface to construct a reference.

Definition at line 50 of file Reference.h.

◆ ISelector

GENICAM_INTERFACE GENAPI_NAMESPACE::ISelector

Interface for groups of features selected by a single one.

Definition at line 49 of file ISelector.h.

GENICAM_NAMESPACE::gcstring
A string class which is a clone of std::string.
Definition: GCString.h:52
GENAPI_NAMESPACE::INodeMap
GENICAM_INTERFACE INodeMap
Interface to access the node map.
Definition: INode.h:52
GENAPI_NAMESPACE::IPortStacked
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IPortStacked
Interface for ports.
Definition: IPortStacked.h:63
GENAPI_NAMESPACE::IBase
GENICAM_INTERFACE GENAPI_DECL_ABSTRACT IBase
Base interface common to all nodes.
Definition: IBase.h:55


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:12