Skip to content

GenApi Node Ptr Classes#

Module: GenICam

Files#

Name
GenApi/Pointer.h
Definition of template CPointer.
GenApi/Types.h
Common types used in the public GenApi interface.

Classes#

Name
class GenApi::CPointer
Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.
class GenApi::CFloatPtr
SmartPointer for IFloat interface pointer.

Types#

Name
enum _ESign
enum _EAccessMode
enum _EVisibility
enum _ECachingMode
enum _ERepresentation
enum _EEndianess
enum _ENameSpace
enum _EStandardNameSpace
enum _EYesNo
typedef CPointer< IBase > CBasePtr
SmartPointer for IBase interface pointer.
typedef CPointer< INode > CNodePtr
SmartPointer for INode interface pointer.
typedef CPointer< IValue > CValuePtr
SmartPointer for IValue interface pointer.
typedef CPointer< ICategory > CCategoryPtr
SmartPointer for ICategory interface pointer.
typedef CPointer< IBoolean > CBooleanPtr
SmartPointer for IBoolean interface pointer.
typedef CPointer< IInteger > CIntegerPtr
SmartPointer for IInteger interface pointer.
typedef CPointer< IString > CStringPtr
SmartPointer for IString interface pointer.
typedef CPointer< IRegister > CRegisterPtr
SmartPointer for IRegister interface pointer.
typedef CPointer< IEnumeration > CEnumerationPtr
SmartPointer for IEnumeration interface pointer.
typedef CPointer< IEnumEntry > CEnumEntryPtr
SmartPointer for IEnumEntry interface pointer.
typedef CPointer< IPort > CPortPtr
SmartPointer for IPort interface pointer.
typedef CPointer< IPortReplay > CPortReplayPtr
SmartPointer for IPortReplay interface pointer.
typedef CPointer< IPortRecorder > CPortRecorderPtr
SmartPointer for IPortRecorder interface pointer.
typedef CPointer< IPortWriteList, IPortWriteList > CPortWriteListPtr
SmartPointer for IPortWriteList interface pointer.
typedef CPointer< IChunkPort > CChunkPortPtr
SmartPointer for IChunkPort interface pointer.
typedef CPointer< INodeMap, INodeMap > CNodeMapPtr
SmartPointer for INodeMap interface pointer.
typedef CPointer< IDeviceInfo, INodeMap > CDeviceInfoPtr
SmartPointer for IDeviceInfo interface pointer.
typedef CPointer< IUserData, INodeMap > CNodeMapUserDataPtr
SmartPointer for IUserData interface pointer.
typedef CPointer< IUserData > CNodeUserDataPtr
SmartPointer for IUserData interface pointer.
typedef CPointer< ISelector > CSelectorPtr
SmartPointer for ISelector interface pointer.
typedef CPointer< ICommand > CCommandPtr
SmartPointer for ICommand interface pointer.
typedef enum GenApi::_ESign ESign
typedef enum GenApi::_EAccessMode EAccessMode
typedef enum GenApi::_EVisibility EVisibility
typedef enum GenApi::_ECachingMode ECachingMode
typedef enum GenApi::_ERepresentation ERepresentation
typedef enum GenApi::_EEndianess EEndianess
typedef enum GenApi::_ENameSpace ENameSpace
typedef enum GenApi::_EStandardNameSpace EStandardNameSpace
typedef enum GenApi::_EYesNo EYesNo

Functions#

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

Types Documentation#

enum _ESign#

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

signed or unsigned integers

enum _EAccessMode#

Enumerator Value Description
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

access mode of a node

enum _EVisibility#

Enumerator Value Description
Beginner 0 Always visible.
Expert 1 Visible for experts or Gurus.
Guru 2 Visible for Gurus.
Invisible 3 Not Visible.
_UndefinedVisibility 99 Object is not yet initialized.

recommended visibility of a node

enum _ECachingMode#

Enumerator Value Description
NoCache Do not use cache.
WriteThrough Write to cache and register.
WriteAround Write to register, write to cache on read.
_UndefinedCachingMode Not yet initialized.

caching mode of a register

enum _ERepresentation#

Enumerator Value Description
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

recommended representation of a node value

enum _EEndianess#

Enumerator Value Description
BigEndian Register is big endian.
LittleEndian Register is little endian.
_UndefinedEndian Object is not yet initialized.

Endianess of a value in a register

enum _ENameSpace#

Enumerator Value Description
Custom name resides in custom namespace
Standard name resides in one of the standard namespaces
_UndefinedNameSpace Object is not yet initialized.

Defines if a node name is standard or custom

enum _EStandardNameSpace#

Enumerator Value Description
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.

Defines from which standard namespace a node name comes from

enum _EYesNo#

Enumerator Value Description
Yes 1 yes
No 0 no
_UndefinedYesNo 2 Object is not yet initialized.

Defines the choices of a Yes/No alternatives

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

Functions Documentation#

Register#

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

Register a C-function as a callback.

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.


Updated on 5 July 2022 at 15:30:01