GenApi#

Contains definitions of the types of GenICam GenApi modules. More…

Classes#

Types#

Functions#

Detailed Description#

Contains definitions of the types of GenICam GenApi modules.

GenApi is an alias for a more complex namespace name, e.g. GenApi_3_1_Basler_pylon. Throughout this documentation, only the alias GenApi is used. For programming, we also recommend to only use the alias.

Forward declarations can be defined as follows:

#include <GenApi/GenApiNamespace.h>

//...

namespace GENAPI_NAMESPACE
{
    interface INodeMap;
}

Alternatively, the GenICam library provides a header file that contains most of the forward declarations:

#include <GenICamFwd.h>

Types Documentation#

enum _ECallbackType#

the type of callback

enum _ESign#

signed or unsigned integers

enum _EAccessMode#

access mode of a node

enum _EVisibility#

recommended visibility of a node

enum _ECachingMode#

caching mode of a register

enum _ERepresentation#

recommended representation of a node value

enum _EEndianess#

Endianess of a value in a register

enum _ENameSpace#

Defines if a node name is standard or custom

enum _EStandardNameSpace#

Defines from which standard namespace a node name comes from

enum _EYesNo#

Defines the choices of a Yes/No alternatives

enum _ESlope#

typedef for formula type

enum _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

enum _EDisplayNotation#

typedef for float notation

enum _EInterfaceType#

typedef for interface type

enum _ELinkType#

typedef for link type

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

enum _EIncMode#

typedef for increment mode

enum _EInputDirection#

typedef for link type

enum _EGenApiSchemaVersion#

GenApi schema version.

typedef FeatureList_t#

typedef value_vector GenApi::FeatureList_t;

a list of feature references

typedef CBaseRef#

typedef CBaseRefT<IBase> GenApi::CBaseRef;

Reference to an IBase pointer

typedef CBooleanRef#

typedef CBooleanRefT<IBoolean> GenApi::CBooleanRef;

Reference to an IBoolean pointer

typedef CCategoryRef#

typedef CCategoryRefT<ICategory> GenApi::CCategoryRef;

Reference to an ICategory pointer

typedef CCommandRef#

typedef CCommandRefT<ICommand> GenApi::CCommandRef;

Reference to an ICommand pointer

typedef CEnumEntryRef#

typedef CEnumEntryRefT<IEnumEntry> GenApi::CEnumEntryRef;

Reference to an IEnumEntry pointer

typedef CFloatRef#

typedef CFloatRefT<IFloat> GenApi::CFloatRef;

Reference to an IFloat pointer

typedef CIntegerRef#

typedef CIntegerRefT<IInteger> GenApi::CIntegerRef;

Reference to an IInteger pointer

typedef NodeList_t#

typedef node_vector GenApi::NodeList_t;

a list of node references

typedef CallbackHandleType#

typedef intptr_t GenApi::CallbackHandleType;

the callback handle for nodes

typedef CPortRef#

typedef CPortRefT<IPort> GenApi::CPortRef;

Reference to an IEnumEntry pointer

typedef CRegisterRef#

typedef CRegisterRefT<IRegister> GenApi::CRegisterRef;

Reference to an IRegister pointer

typedef CSelectorRef#

typedef CSelectorRefT<ISelector> GenApi::CSelectorRef;

Reference to an ISelector pointer

typedef CStringRef#

typedef CStringRefT<IString> GenApi::CStringRef;

Reference to an IString pointer

typedef CValueRef#

typedef CValueRefT<IValue> GenApi::CValueRef;

Reference to an IValue pointer

typedef ECallbackType#

typedef enum GenApi::_ECallbackType  GenApi::ECallbackType;

the type of callback

typedef CBasePtr#

typedef CPointer<IBase> GenApi::CBasePtr;

SmartPointer for IBase interface pointer.

typedef CNodePtr#

typedef CPointer<INode> GenApi::CNodePtr;

SmartPointer for INode interface pointer.

typedef CValuePtr#

typedef CPointer<IValue> GenApi::CValuePtr;

SmartPointer for IValue interface pointer.

typedef CCategoryPtr#

typedef CPointer<ICategory> GenApi::CCategoryPtr;

SmartPointer for ICategory interface pointer.

typedef CBooleanPtr#

typedef CPointer<IBoolean> GenApi::CBooleanPtr;

SmartPointer for IBoolean interface pointer.

typedef CIntegerPtr#

typedef CPointer<IInteger> GenApi::CIntegerPtr;

SmartPointer for IInteger interface pointer.

typedef CStringPtr#

typedef CPointer<IString> GenApi::CStringPtr;

SmartPointer for IString interface pointer.

typedef CRegisterPtr#

typedef CPointer<IRegister> GenApi::CRegisterPtr;

SmartPointer for IRegister interface pointer.

typedef CEnumerationPtr#

typedef CPointer<IEnumeration> GenApi::CEnumerationPtr;

SmartPointer for IEnumeration interface pointer.

typedef CEnumEntryPtr#

typedef CPointer<IEnumEntry> GenApi::CEnumEntryPtr;

SmartPointer for IEnumEntry interface pointer.

typedef CPortPtr#

typedef CPointer<IPort> GenApi::CPortPtr;

SmartPointer for IPort interface pointer.

typedef CPortReplayPtr#

typedef CPointer<IPortReplay> GenApi::CPortReplayPtr;

SmartPointer for IPortReplay interface pointer.

typedef CPortRecorderPtr#

typedef CPointer<IPortRecorder> GenApi::CPortRecorderPtr;

SmartPointer for IPortRecorder interface pointer.

typedef CPortWriteListPtr#

typedef CPointer<IPortWriteList, IPortWriteList> GenApi::CPortWriteListPtr;

SmartPointer for IPortWriteList interface pointer.

typedef CChunkPortPtr#

typedef CPointer<IChunkPort> GenApi::CChunkPortPtr;

SmartPointer for IChunkPort interface pointer.

typedef CNodeMapPtr#

typedef CPointer<INodeMap, INodeMap> GenApi::CNodeMapPtr;

SmartPointer for INodeMap interface pointer.

typedef CDeviceInfoPtr#

typedef CPointer<IDeviceInfo, INodeMap> GenApi::CDeviceInfoPtr;

SmartPointer for IDeviceInfo interface pointer.

typedef CNodeMapUserDataPtr#

typedef CPointer<IUserData, INodeMap> GenApi::CNodeMapUserDataPtr;

SmartPointer for IUserData interface pointer.

typedef CNodeUserDataPtr#

typedef CPointer<IUserData> GenApi::CNodeUserDataPtr;

SmartPointer for IUserData interface pointer.

typedef CSelectorPtr#

typedef CPointer<ISelector> GenApi::CSelectorPtr;

SmartPointer for ISelector interface pointer.

typedef CCommandPtr#

typedef CPointer<ICommand> GenApi::CCommandPtr;

SmartPointer for ICommand interface pointer.

typedef CPortConstructPtr#

typedef CPointer<IPortConstruct> GenApi::CPortConstructPtr;

SmartPointer for IPortConstruct interface pointer.

typedef ESign#

typedef enum GenApi::_ESign  GenApi::ESign;

signed or unsigned integers

typedef EAccessMode#

typedef enum GenApi::_EAccessMode  GenApi::EAccessMode;

access mode of a node

typedef EVisibility#

typedef enum GenApi::_EVisibility  GenApi::EVisibility;

recommended visibility of a node

typedef ECachingMode#

typedef enum GenApi::_ECachingMode  GenApi::ECachingMode;

caching mode of a register

typedef ERepresentation#

typedef enum GenApi::_ERepresentation  GenApi::ERepresentation;

recommended representation of a node value

typedef EEndianess#

typedef enum GenApi::_EEndianess  GenApi::EEndianess;

Endianess of a value in a register

typedef ENameSpace#

typedef enum GenApi::_ENameSpace  GenApi::ENameSpace;

Defines if a node name is standard or custom

typedef EStandardNameSpace#

typedef enum GenApi::_EStandardNameSpace  GenApi::EStandardNameSpace;

Defines from which standard namespace a node name comes from

typedef EYesNo#

typedef enum GenApi::_EYesNo  GenApi::EYesNo;

Defines the choices of a Yes/No alternatives

typedef StringList_t#

typedef GenICam::gcstring_vector GenApi::StringList_t;

A list of strings

typedef ESlope#

typedef enum GenApi::_ESlope  GenApi::ESlope;

typedef for formula type

typedef EXMLValidation#

typedef enum GenApi::_EXMLValidation  GenApi::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 EDisplayNotation#

typedef enum GenApi::_EDisplayNotation  GenApi::EDisplayNotation;

typedef for float notation

typedef EInterfaceType#

typedef enum GenApi::_EInterfaceType  GenApi::EInterfaceType;

typedef for interface type

typedef ELinkType#

typedef enum GenApi::_ELinkType  GenApi::ELinkType;

typedef for link type

For details see GenICam Wiki : GenApi/SoftwareArchitecture/NodeDependencies

typedef EIncMode#

typedef enum GenApi::_EIncMode  GenApi::EIncMode;

typedef for increment mode

typedef EInputDirection#

typedef enum GenApi::_EInputDirection  GenApi::EInputDirection;

typedef for link type

typedef EGenApiSchemaVersion#

typedef enum GenApi::_EGenApiSchemaVersion  GenApi::EGenApiSchemaVersion;

GenApi schema version.

Functions Documentation#

function IsReadable#

inline bool IsReadable(
    EAccessMode AccessMode
)

Tests if readable.

function IsReadable#

inline bool IsReadable(
    const IBase * p
)

Checks if a node is readable.

function IsReadable#

inline bool IsReadable(
    const IBase & r
)

Checks if a node is readable.

function IsWritable#

inline bool IsWritable(
    EAccessMode AccessMode
)

Tests if writable.

function IsWritable#

inline bool IsWritable(
    const IBase * p
)

Checks if a node is writable.

function IsWritable#

inline bool IsWritable(
    const IBase & r
)

Checks if a node is writable.

function IsImplemented#

inline bool IsImplemented(
    EAccessMode AccessMode
)

Tests if implemented.

function IsImplemented#

inline bool IsImplemented(
    const IBase * p
)

Checks if a node is implemented.

function IsImplemented#

inline bool IsImplemented(
    const IBase & r
)

Checks if a node is implemented.

function IsAvailable#

inline bool IsAvailable(
    EAccessMode AccessMode
)

Tests if available.

function IsAvailable#

inline bool IsAvailable(
    const IBase * p
)

Checks if a node is available.

function IsAvailable#

inline bool IsAvailable(
    const IBase & r
)

Checks if a node is available.

function Combine#

inline EAccessMode Combine(
    EAccessMode Peter,
    EAccessMode Paul
)

Computes which access mode the two guards allow together.

function IsVisible#

inline bool IsVisible(
    EVisibility Visibility,
    EVisibility MaxVisiblity
)

Tests Visibility.

CAVE : this relys on the EVisibility enum's coding

function Combine#

inline EVisibility Combine(
    EVisibility Peter,
    EVisibility Paul
)

Computes which visibility the two guards allow together.

function IsCacheable#

inline bool IsCacheable(
    ECachingMode CachingMode
)

Tests Cacheability.

function Combine#

inline ECachingMode Combine(
    ECachingMode Peter,
    ECachingMode Paul
)

Computes which CachingMode results from a combination.

function make_NodeCallback#

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

make a new callback object for C functions

function Register#

template <class Function >
intptr_t Register(
    INode * pNode,
    Function f,
    ECallbackType CallbackType =cbPostInsideLock
)

Register a C-function as a callback.

function make_NodeCallback#

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

make a new callback object for member functions

function Register#

template <class Client ,
class Member >
intptr_t Register(
    INode * pNode,
    Client & c,
    Member m,
    ECallbackType CallbackType =cbPostInsideLock
)

Register a C++-member function a callback.

function Deregister#

void Deregister(
    GenApi::CallbackHandleType pCallbackInfo
)

Unregistering callback by handle.

function GetInterfaceName#

inline GenICam::gcstring GetInterfaceName(
    IBase * pBase
)

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

function IsReadable#

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

Checks if a node is readable.

function IsWritable#

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

Checks if a node is Writable.

function IsImplemented#

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

Checks if a node is Implemented.

function IsAvailable#

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

Checks if a node is Available.