Files | Classes | Typedefs | Enumerations | Functions
GenApi Node Reference Classes
Collaboration diagram for GenApi Node Reference Classes:

Files

file  Callback.h
 This file exists only for backward compatibility reasons.
 
file  Container.h
 Portable container classes for INode & IValue pointers.
 
file  NodeCallback.h
 Implementation helpers for CNodeCallbackDefines a bunch of templates for creating callback-functors taking a INode pointer and returning void.
 
file  NodeCallbackImpl.h
 This file exists only for backward compatibility reasons.
 

Classes

class  GenApi::node_vector
 A vector of INode pointers. More...
 
class  GenApi::value_vector
 A vector of IValue pointers. More...
 
struct  GenApi::ISelector
 Interface for groups of features selected by a single one. More...
 
class  GenApi::CNodeCallback
 callback body instance for INode pointers More...
 
class  GenApi::Function_NodeCallback< Function >
 Container for a function pointer. More...
 
class  GenApi::Member_NodeCallback< Client, Member >
 Container for a member function pointer. More...
 

Typedefs

typedef CBaseRefT< IBase > GenApi::CBaseRef
 
typedef CBooleanRefT< IBoolean > GenApi::CBooleanRef
 
typedef CCategoryRefT< ICategory > GenApi::CCategoryRef
 
typedef CCommandRefT< ICommand > GenApi::CCommandRef
 
typedef CEnumEntryRefT
< IEnumEntry > 
GenApi::CEnumEntryRef
 
typedef CFloatRefT< IFloat > GenApi::CFloatRef
 
typedef CIntegerRefT< IInteger > GenApi::CIntegerRef
 
typedef CPortRefT< IPort > GenApi::CPortRef
 
typedef CRegisterRefT< IRegister > GenApi::CRegisterRef
 
typedef CSelectorRefT< ISelector > GenApi::CSelectorRef
 
typedef CStringRefT< IString > GenApi::CStringRef
 
typedef CValueRefT< IValue > GenApi::CValueRef
 
typedef CPointer< IPortConstruct > GenApi::CPortConstructPtr
 SmartPointer for IPortConstruct interface pointer.
 
typedef GenICam::gcstring_vector GenApi::StringList_t
 
typedef enum GenApi::_ESlope GenApi::ESlope
 
typedef enum
GenApi::_EXMLValidation 
GenApi::EXMLValidation
 typedef describing the different validity checks which can be performed on an XML file More...
 
typedef enum
GenApi::_EDisplayNotation 
GenApi::EDisplayNotation
 
typedef enum
GenApi::_EInterfaceType 
GenApi::EInterfaceType
 
typedef enum GenApi::_ELinkType GenApi::ELinkType
 

Enumerations

enum  GenApi::_ESlope { , GenApi::Decreasing, GenApi::Varying, GenApi::Automatic, GenApi::_UndefinedESlope }
 
enum  GenApi::_EXMLValidation { ,
  GenApi::xvCycles = 0x00000002L, GenApi::xvSFNC = 0x00000004L, GenApi::xvDefault = 0x00000000L, GenApi::xvAll = 0xffffffffL,
  GenApi::_UndefinedEXMLValidation = 0x8000000L
}
 typedef describing the different validity checks which can be performed on an XML file More...
 
enum  GenApi::_EDisplayNotation { , GenApi::fnFixed, GenApi::fnScientific, GenApi::_UndefinedEDisplayNotation }
 
enum  GenApi::_EInterfaceType { ,
  GenApi::intfIBase, GenApi::intfIInteger, GenApi::intfIBoolean, GenApi::intfICommand,
  GenApi::intfIFloat, GenApi::intfIString, GenApi::intfIRegister, GenApi::intfICategory,
  GenApi::intfIEnumeration, GenApi::intfIEnumEntry, GenApi::intfIPort
}
 
enum  GenApi::_ELinkType { ,
  GenApi::ctAllTerminalNodes, GenApi::ctInvalidators, GenApi::ctReadingChildren, GenApi::ctWritingChildren,
  GenApi::ctDependingChildren
}
 

Functions

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

Detailed Description

Typedef Documentation

typedef CBaseRefT<IBase> GenApi::CBaseRef

Reference to an IBase pointer

typedef CBooleanRefT<IBoolean> GenApi::CBooleanRef

Reference to an IBoolean pointer

typedef CCategoryRefT<ICategory> GenApi::CCategoryRef

Reference to an ICategory pointer

typedef CCommandRefT<ICommand> GenApi::CCommandRef

Reference to an ICommand pointer

typedef CEnumEntryRefT<IEnumEntry> GenApi::CEnumEntryRef

Reference to an IEnumEntry pointer

typedef CFloatRefT<IFloat> GenApi::CFloatRef

Reference to an IFloat pointer

typedef CIntegerRefT<IInteger> GenApi::CIntegerRef

Reference to an IInteger pointer

typedef CPortRefT<IPort> GenApi::CPortRef

Reference to an IEnumEntry pointer

typedef CRegisterRefT<IRegister> GenApi::CRegisterRef

Reference to an IRegister pointer

typedef CSelectorRefT<ISelector> GenApi::CSelectorRef

Reference to an ISelector pointer

typedef CStringRefT<IString> GenApi::CStringRef

Reference to an IString pointer

typedef CValueRefT<IValue> GenApi::CValueRef

Reference to an IValue pointer

typedef for float notation

typedef for interface type

typedef for link type

typedef for fomula type

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

The enum values for a bitfield of lenght uint32_t

typedef GenICam::gcstring_vector GenApi::StringList_t

A list of strings

Enumeration Type Documentation

typedef for float notation

Enumerator
fnFixed 

the notation if either scientific or fixed depending on what is shorter

fnScientific 

the notation is fixed, e.g. 123.4

_UndefinedEDisplayNotation 

the notation is scientific, e.g. 1.234e2

Object is not yetinitialized

typedef for interface type

Enumerator
intfIBase 

IBase interface

intfIInteger 

IBase interface

intfIBoolean 

IInteger interface

intfICommand 

IBoolean interface

intfIFloat 

IBoolean interface

intfIString 

IFloat interface

intfIRegister 

IString interface

intfICategory 

IRegister interface

intfIEnumeration 

ICategory interface

intfIEnumEntry 

IEnumeration interface

intfIPort 

IEnumEntry interface

typedef for link type

Enumerator
ctAllTerminalNodes 

All nodes which will be invalidated if this node becomes invalid

ctInvalidators 

All terminal nodes which may be written to by this node

ctReadingChildren 

List of references to nodes which may invalidate this node

ctWritingChildren 

All child nodes which influence this node's AccessMode

ctDependingChildren 

All child nodes which may be written to

typedef for fomula type

Enumerator
Decreasing 

strictly monotonous increasing

Varying 

strictly monotonous decreasing

Automatic 

slope changes, e.g. at run-time

_UndefinedESlope 

slope is determined automatically by probing the function

Object is not yetinitialized

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

The enum values for a bitfield of lenght uint32_t

Enumerator
xvCycles 

Creates a dummy node map

xvSFNC 

checks for write and dependency cycles (implies xvLoad)

xvDefault 

checks for conformance with the standard feature naming convention (SFNC)

xvAll 

checks performed if nothing else is said

_UndefinedEXMLValidation 

all possible checks

Object is not yetinitialized

Function Documentation

GenICam::gcstring GenApi::GetInterfaceName ( IBase *  pBase)
inline

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


© 2006-2014 Basler (Tue Jul 22 2014 11:41:23)