All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Files | Classes | Typedefs | Enumerations | Functions
GenApi Node Reference Classes
Collaboration diagram for GenApi Node Reference Classes:

Files

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.
 

Classes

class  GenApi::node_vector
 A vector of INode pointers. More...
 
class  GenApi::value_vector
 A vector of IValue pointers. More...
 
struct  GenApi::IFileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. 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
 typedef for link type More...
 
typedef enum GenApi::_EIncMode GenApi::EIncMode
 
typedef enum
GenApi::_EInputDirection 
GenApi::EInputDirection
 

Enumerations

enum  GenApi::_ESlope {
  GenApi::Increasing, GenApi::Decreasing, GenApi::Varying, GenApi::Automatic,
  GenApi::_UndefinedESlope
}
 
enum  GenApi::_EXMLValidation {
  GenApi::xvLoad = 0x00000001L, 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::fnAutomatic, GenApi::fnFixed, GenApi::fnScientific, GenApi::_UndefinedEDisplayNotation }
 
enum  GenApi::_EInterfaceType {
  GenApi::intfIValue, 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::ctParentNodes, GenApi::ctReadingChildren, GenApi::ctWritingChildren, GenApi::ctInvalidatingChildren,
  GenApi::ctDependingNodes, GenApi::ctTerminalNodes
}
 typedef for link type More...
 
enum  GenApi::_EIncMode
 
enum  GenApi::_EInputDirection { GenApi::idFrom, GenApi::idTo, GenApi::idNone }
 

Functions

struct virtual __attribute__((visibility("default")))
ISelector void 
GenApi::GetSelectedFeatures (FeatureList_t &) const =0
 Interface for groups of features selected by a single one. More...
 
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 increment mode

typedef for link type

typedef for interface type

typedef for link type

For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies

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

typedef GenICam::gcstring_vector GenApi::StringList_t

A list of strings

Enumeration Type Documentation

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.

typedef for increment mode

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.

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.

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.

typedef for fomula 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.

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.

Function Documentation

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

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

struct virtual __attribute__ ((visibility("default"))) ISelector void GenApi::GetSelectedFeatures ( FeatureList_t &  ) const
pure virtual

Interface for groups of features selected by a single one.

retrieve the group of selected features


pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)