Pylon Logo Basler Logo
Classes | Typedefs | Enumerations | Functions
GenApi Namespace Reference

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

Classes

struct  AttachStatistics_t
 
class  CChunkAdapter
 Connects a chunked buffer to a node map. More...
 
class  CChunkAdapterGEV
 Connects a chunked DCAM buffer to a node map. More...
 
class  CEventAdapter
 Delivers Events to ports. More...
 
class  CEventAdapterGEV
 Connects a GigE Event to a node map. More...
 
class  CFeatureBag
 Bag holding streamable features of a nodetree. More...
 
class  CFeatureBagger
 Class use to bag features. More...
 
class  CFloatPtr
 SmartPointer for IFloat interface pointer. More...
 
class  CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
 
class  CNodeCallback
 callback body instance for INode pointers More...
 
class  CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
 
class  CNodeMapRefT
 Smartpointer template for NodeMaps with create function. More...
 
class  CPointer
 Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...
 
class  FileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...
 
class  Function_NodeCallback
 Container for a function pointer. More...
 
struct  GVCP_CHUNK_TRAILER
 header of a GVCP request packet More...
 
struct  IBase
 Base interface common to all nodes. More...
 
struct  IBoolean
 Interface for Boolean properties. More...
 
struct  ICategory
 Gives access to a category node. More...
 
struct  ICommand
 
struct  IEnumEntry
 Interface of single enum value. More...
 
struct  IEnumeration
 Interface for enumeration properties. More...
 
struct  IEnumerationT
 Interface for enumeration properties. More...
 
struct  IFileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device filesystem. More...
 
struct  IFloat
 Interface for float properties. More...
 
struct  IInteger
 Interface for integer properties. More...
 
struct  INode
 Interface common to all nodes. More...
 
struct  INodeMap
 Interface to access the node map. More...
 
struct  IPersistScript
 Basic interface to persist values to. More...
 
struct  IPort
 Interface for ports. More...
 
struct  IRegister
 Interface for registers. More...
 
struct  ISelector
 Interface for groups of features selected by a single one. More...
 
struct  IString
 Interface for string properties. More...
 
struct  IValue
 Interface for value properties. More...
 
class  Member_NodeCallback
 Container for a member function pointer. More...
 
class  node_vector
 A vector of INode pointers. More...
 
class  value_vector
 A vector of IValue pointers. More...
 

Typedefs

typedef struct GenApi::AttachStatistics_t AttachStatistics_t
 
typedef struct GenApi::GVCP_CHUNK_TRAILER GVCP_CHUNK_TRAILER
 header of a GVCP request packet
 
typedef value_vector FeatureList_t
 a list of feature references
 
typedef CBaseRefT< IBaseCBaseRef
 
typedef CBooleanRefT< IBooleanCBooleanRef
 
typedef CCategoryRefT< ICategoryCCategoryRef
 
typedef CCommandRefT< ICommandCCommandRef
 
typedef CEnumEntryRefT< IEnumEntryCEnumEntryRef
 
typedef CFloatRefT< IFloatCFloatRef
 
typedef CIntegerRefT< IIntegerCIntegerRef
 
typedef node_vector NodeList_t
 a list of node references
 
typedef intptr_t CallbackHandleType
 the callback handle for nodes
 
typedef CPortRefT< IPortCPortRef
 
typedef CRegisterRefT< IRegisterCRegisterRef
 
typedef CSelectorRefT< ISelectorCSelectorRef
 
typedef CStringRefT< IStringCStringRef
 
typedef CValueRefT< IValueCValueRef
 
typedef enum GenApi::_ECallbackType ECallbackType
 the type of callback
 
typedef CPointer< IBaseCBasePtr
 SmartPointer for IBase interface pointer.
 
typedef CPointer< INodeCNodePtr
 SmartPointer for INode interface pointer.
 
typedef CPointer< IValueCValuePtr
 SmartPointer for IValue interface pointer.
 
typedef CPointer< ICategoryCCategoryPtr
 SmartPointer for ICategory interface pointer.
 
typedef CPointer< IBooleanCBooleanPtr
 SmartPointer for IBoolean interface pointer.
 
typedef CPointer< IIntegerCIntegerPtr
 SmartPointer for IInteger interface pointer.
 
typedef CPointer< IStringCStringPtr
 SmartPointer for IString interface pointer.
 
typedef CPointer< IRegisterCRegisterPtr
 SmartPointer for IRegister interface pointer.
 
typedef CPointer< IEnumerationCEnumerationPtr
 SmartPointer for IEnumeration interface pointer.
 
typedef CPointer< IEnumEntryCEnumEntryPtr
 SmartPointer for IEnumEntry interface pointer.
 
typedef CPointer< IPortCPortPtr
 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, INodeMapCNodeMapPtr
 SmartPointer for INodeMap interface pointer.
 
typedef CPointer< IDeviceInfo, INodeMapCDeviceInfoPtr
 SmartPointer for IDeviceInfo interface pointer.
 
typedef CPointer< IUserData, INodeMapCNodeMapUserDataPtr
 SmartPointer for IUserData interface pointer.
 
typedef CPointer< IUserData > CNodeUserDataPtr
 SmartPointer for IUserData interface pointer.
 
typedef CPointer< ISelectorCSelectorPtr
 SmartPointer for ISelector interface pointer.
 
typedef CPointer< ICommandCCommandPtr
 SmartPointer for ICommand interface pointer.
 
typedef CPointer< IPortConstruct > CPortConstructPtr
 SmartPointer for IPortConstruct 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
 
typedef GenICam::gcstring_vector StringList_t
 
typedef enum GenApi::_ESlope ESlope
 
typedef enum GenApi::_EXMLValidation EXMLValidation
 typedef describing the different validity checks which can be performed on an XML file More...
 
typedef enum GenApi::_EDisplayNotation EDisplayNotation
 
typedef enum GenApi::_EInterfaceType EInterfaceType
 
typedef enum GenApi::_ELinkType ELinkType
 typedef for link type More...
 
typedef enum GenApi::_EIncMode EIncMode
 
typedef enum GenApi::_EInputDirection EInputDirection
 
typedef enum GenApi::_EGenApiSchemaVersion EGenApiSchemaVersion
 GenApi schema version.
 

Enumerations

Functions

struct __attribute__ ((packed)) GVCP_REQUEST_HEADER
 header of a GVCP request packet More...
 
bool IsReadable (EAccessMode AccessMode)
 Tests if readable.
 
bool IsReadable (const IBase *p)
 Checks if a node is readable.
 
bool IsReadable (const IBase &r)
 Checks if a node is readable.
 
bool IsWritable (EAccessMode AccessMode)
 Tests if writable.
 
bool IsWritable (const IBase *p)
 Checks if a node is writable.
 
bool IsWritable (const IBase &r)
 Checks if a node is writable.
 
bool IsImplemented (EAccessMode AccessMode)
 Tests if implemented.
 
bool IsImplemented (const IBase *p)
 Checks if a node is implemented.
 
bool IsImplemented (const IBase &r)
 Checks if a node is implemented.
 
bool IsAvailable (EAccessMode AccessMode)
 Tests if available.
 
bool IsAvailable (const IBase *p)
 Checks if a node is available.
 
bool IsAvailable (const IBase &r)
 Checks if a node is available.
 
EAccessMode Combine (EAccessMode Peter, EAccessMode Paul)
 Computes which access mode the two guards allow together.
 
bool IsVisible (EVisibility Visibility, EVisibility MaxVisiblity)
 Tests Visibility. More...
 
EVisibility Combine (EVisibility Peter, EVisibility Paul)
 Computes which visibility the two guards allow together.
 
bool IsCacheable (ECachingMode CachingMode)
 Tests Cacheability.
 
ECachingMode Combine (ECachingMode Peter, ECachingMode Paul)
 Computes which CachingMode results from a combination.
 
template<class Function >
CNodeCallbackmake_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType)
 make a new callback object for C functions
 
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 >
CNodeCallbackmake_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType)
 make a new callback object for member functions
 
template<class Client , class Member >
intptr_t Register (INode *pNode, Client &c, Member m, ECallbackType CallbackType=cbPostInsideLock)
 Register a C++-member function a callback.
 
void Deregister (GenApi::CallbackHandleType pCallbackInfo)
 Unregistering callback by handle.
 
IDestroy * CastToIDestroy (INodeMap *pNodeMap)
 makes sure the dynamic_cast operator is implemented in the DLL (due to a Linux bug)
 
GenICam::gcstring GetInterfaceName (IBase *pBase)
 
template<class T , class B >
bool IsReadable (const CPointer< T, B > &ptr)
 Checks if a node is readable.
 
template<class T , class B >
bool IsWritable (const CPointer< T, B > &ptr)
 Checks if a node is Writable.
 
template<class T , class B >
bool IsImplemented (const CPointer< T, B > &ptr)
 Checks if a node is Implemented.
 
template<class T , class B >
bool IsAvailable (const CPointer< T, B > &ptr)
 Checks if a node is Available.
 
std::istream & EatComments (std::istream &is)
 Helper function ignoring lines starting with comment character '#'.
 
std::istream & operator>> (std::istream &is, CFeatureBag &FeatureBag)
 reads in persistent data from a stream More...
 
std::ostream & operator<< (std::ostream &os, const CFeatureBag &FeatureBag)
 writes out persistent data to a stream More...
 
std::ostream & operator<< (std::ostream &os, const CFeatureBagger &featureBagger)
 writes out persistent data to a stream More...
 
std::istream & operator>> (std::istream &is, CFeatureBagger &featureBagger)
 reads back persistent data from a stream More...
 

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>

Enumeration Type Documentation

the type of callback

Enumerator
cbPostOutsideLock 

callback is fired on leaving the tree inside the lock-guarded area

Function Documentation

struct GenApi::__attribute__ ( (packed)  )

header of a GVCP request packet

Layout of a GVCP event data request packet (Extended ID flag set)

Layout of a GVCP event request packet (Extended ID flag set)

layout of a GVCP event item (Extended ID flag set)

Layout of a GVCP event data request packet (Extended ID flag not set)

Layout of a GVCP event request packet (Extended ID flag not set)

layout of a GVCP event item (Extended ID flag not set)

layout of a GVCP event item (common to all types)

std::ostream& GenApi::operator<< ( std::ostream &  os,
const CFeatureBag FeatureBag 
)
inline

writes out persistent data to a stream

puts the bag into a stream

std::ostream& GenApi::operator<< ( std::ostream &  os,
const CFeatureBagger featureBagger 
)
inline

writes out persistent data to a stream

puts the bags into a stream

std::istream& GenApi::operator>> ( std::istream &  is,
CFeatureBag FeatureBag 
)
inline

reads in persistent data from a stream

fills the bag from a stream

std::istream& GenApi::operator>> ( std::istream &  is,
CFeatureBagger featureBagger 
)
inline

reads back persistent data from a stream

reads the bags from a stream


pylon 6.1.0
Copyright (c) 2006-2020 Basler AG (Mon Mar 16 2020 10:56:56)