Spinnaker C++
2.6.0.0
Modules | Classes | Typedefs | Functions
Spinnaker GenApi Classes

Modules

 AutoVector Class
 
 BooleanNode Class
 
 CategoryNode Class
 
 ChunkAdapter Class
 
 ChunkAdapterDcam Class
 
 ChunkAdapterGeneric Class
 
 ChunkAdapterGEV Class
 
 ChunkPort Class
 
 CommandNode Class
 
 Container Class
 
 Counter Class
 
 EnumClasses Class
 
 EnumEntryNode Class
 
 EnumNode Class
 
 EnumNodeT Class
 
 EventAdapter Class
 
 EventAdapter1394 Class
 
 EventAdapterGeneric Class
 
 EventAdapterGEV Class
 
 EventAdapterU3V Class
 
 EventPort Class
 
 Filestream Class
 
 FloatNode Class
 
 FloatRegNode Class
 
 GCString Class
 
 GCSynch Class
 
 GCTypes Class
 
 IntegerNode Class
 
 IntRegNode Class
 
 IString Class
 
 IValue Class
 
 Node Class
 
 NodeCallback Class
 
 NodeMap Class
 
 NodeMapFactory Class
 
 NodeMapRef Class
 
 Persistence Class
 
 Pointer Class
 
 PortImpl Class
 
 PortNode Class
 
 PortRecorder Class
 
 PortReplay Class
 
 PortWriteList Class
 
 RegisterNode Class
 
 RegisterPortImpl Class
 
 SelectorSet Class
 
 SpinTestCamera Class
 
 StringNode Class
 
 StringRegNode Class
 
 StructPort Class
 
 Synch Class
 
 ValueNode Class
 
 ChunkAdapterU3V Class
 
 IPortRecorder Interface
 

Classes

class  int64_autovector_t
 Vector of integers with reference counting. More...
 
class  double_autovector_t
 Vector of doubles with reference counting. More...
 
class  BooleanNode
 Interface for string properties. More...
 
class  CategoryNode
 Interface for string properties. More...
 
class  CChunkAdapter
 Connects a chunked buffer to a node map. More...
 
class  CChunkAdapterDcam
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterGeneric
 
class  CChunkAdapterGEV
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterU3V
 Connects a chunked U3V buffer to a node map. More...
 
class  CChunkPort
 Port attachable to a chunk in a buffer. More...
 
class  CommandNode
 Interface for string properties. More...
 
class  Counter
 Definition of a simple Counter class. More...
 
class  ESignClass
 Holds conversion methods for the sign enumeration. More...
 
class  EEndianessClass
 Holds conversion methods for the endianess enumeration. More...
 
class  ERepresentationClass
 Holds conversion methods for the representation enumeration. More...
 
class  EVisibilityClass
 Holds conversion methods for the visibility enumeration. More...
 
class  EAccessModeClass
 Holds conversion methods for the access mode enumeration. More...
 
class  ECachingModeClass
 Holds conversion methods for the caching mode enumeration. More...
 
class  ENameSpaceClass
 Holds conversion methods for the namespace enumeration. More...
 
class  EYesNoClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  EStandardNameSpaceClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  ESlopeClass
 Holds conversion methods for the converter formulas. More...
 
class  EDisplayNotationClass
 Holds conversion methods for the notation type of floats. More...
 
class  EInputDirectionClass
 Holds conversion methods for the notation type of floats. More...
 
class  EGenApiSchemaVersionClass
 helper class converting EGenApiSchemaVersion from and to string More...
 
class  EnumEntryNode
 Interface for string properties. More...
 
class  EnumNode
 Interface for string properties. More...
 
class  CEnumerationTRef< EnumT >
 Interface for string properties. More...
 
class  CEventAdapter
 Delivers Events to ports. More...
 
class  CEventAdapter1394
 Distribute the events to the node map. More...
 
class  CEventAdapterGeneric
 Connects a generic event to a node map. More...
 
class  CEventAdapterGEV
 Connects a GigE Event to a node map. More...
 
class  CEventAdapterU3V
 Connects a U3V Event to a node map. More...
 
class  CEventPort
 Port attachable to an event. More...
 
class  FileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device file system. More...
 
class  IDevFileStreamBuf< CharType, Traits >
 
class  ODevFileStreamBuf< CharType, Traits >
 
class  ODevFileStreamBase< CharType, Traits >
 
class  IDevFileStreamBase< CharType, Traits >
 
class  FloatNode
 Interface for string properties. More...
 
class  FloatRegNode
 Interface for string properties. More...
 
class  gcstring
 
class  CLock
 A lock class. More...
 
class  CLockEx
 This class is for testing purposes only. More...
 
class  AutoLock
 
class  LockableObject< Object >
 Instance-Lock for an object. More...
 
class  CGlobalLock
 Named global lock which can be used over process boundaries. More...
 
class  CGlobalLockUnlocker
 Unlocks the global lock object on destruction. More...
 
struct  Version_t
 Version. More...
 
class  IntegerNode
 Interface for string properties. More...
 
class  IntRegNode
 Interface for string properties. More...
 
class  Node
 class common to all nodes More...
 
class  CNodeCallback
 callback body instance for INode pointers More...
 
class  Function_NodeCallback< Function >
 Container for a function pointer. More...
 
class  Member_NodeCallback< Client, Member >
 Container for a member function pointer. More...
 
class  NodeMap
 Smart pointer template for NodeMaps with create function. More...
 
class  CNodeMapFactory
 The node map factory is used for creating node maps from camera description files. More...
 
class  CNodeMapRefT< TCameraParams >
 Smartpointer template for NodeMaps with create function. More...
 
class  CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
 
class  CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
 
class  CFeatureBag
 Bag holding streamable features of a nodetree. More...
 
class  CPointer< T, B >
 Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...
 
class  CFloatPtr
 SmartPointer for IFloat interface pointer. More...
 
class  CPortImpl
 Standard implementation for a port. More...
 
class  PortNode
 Interface for value properties. More...
 
class  PortRecorder
 Interface for recording write commands on a port. More...
 
class  PortReplay
 Interface for replaying write commands on a port. More...
 
class  CPortWriteList
 Container holding a list of port write commands. More...
 
class  RegisterNode
 Interface for string properties. More...
 
class  CRegisterPortImpl
 Standard implementation for a port using a register based transport layer. More...
 
class  CSelectorSet
 The set of selectors selecting a given node. More...
 
class  SpinTestCamera
 
class  StringNode
 Interface for string properties. More...
 
class  StringRegNode
 Interface for string properties. More...
 
class  CTestPortStruct< CDataStruct >
 Implements a register spaces based on a C++ struct. More...
 
class  ValueNode
 Interface for value properties. More...
 

Typedefs

typedef Node CNodeRef
 
typedef Node CSelectorRef
 
typedef NodeMap CNodeMapRef
 

Functions

SPINNAKER_API IDestroy * CastToIDestroy (INodeMap *pNodeMap)
 makes sure the dynamic_cast operator is implemented in the DLL (due to a Linux bug) More...
 
template<class TCameraParams >
void _LoadXMLFromFile (const GenICam::gcstring &FileName)
 
template<class TCameraParams >
void _LoadXMLFromZIPFile (const GenICam::gcstring &ZipFileName)
 
template<class TCameraParams >
void _LoadXMLFromFileInject (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectFileName)
 
template<class TCameraParams >
void _LoadXMLFromString (const GenICam::gcstring &XMLData)
 
template<class TCameraParams >
void _LoadXMLFromZIPData (const void *zipData, size_t zipSize)
 
template<class TCameraParams >
void _LoadXMLFromStringInject (const GenICam::gcstring &TargetXMLData, const GenICam::gcstring &InjectXMLData)
 
template<class TCameraParams >
void _GetSupportedSchemaVersions (GenICam::gcstring_vector &SchemaVersions)
 
template<class TCameraParams >
GenICam::gcstring _GetDeviceName ()
 
template<class TCameraParams >
void _Poll (int64_t ElapsedTime)
 
template<class TCameraParams >
void _GetNodes (NodeList_t &Nodes)
 
template<class TCameraParams >
INode * _GetNode (const GenICam::gcstring &key)
 
template<class TCameraParams >
void _InvalidateNodes ()
 
template<class TCameraParams >
bool _Connect (IPort *pPort, const GenICam::gcstring &PortName)
 
template<class TCameraParams >
bool _Connect (IPort *pPort)
 
template<class TCameraParams >
bool _ClearXMLCache ()
 
SPINNAKER_API std::istream & EatComments (std::istream &is)
 Helper function ignoring lines starting with comment character '#'. More...
 
SPINNAKER_API std::istream & operator>> (std::istream &is, CFeatureBag &FeatureBag)
 Reads in persistent data from a stream. More...
 
SPINNAKER_API std::ostream & operator<< (std::ostream &os, const CFeatureBag &FeatureBag)
 writes out persistent data to a stream More...
 
 CNodeMapRefT (const GenICam::gcstring &DeviceName="Device")
 Constructor. More...
 
 CNodeMapRefT (INodeMap *pNodeMap, const GenICam::gcstring &DeviceName="Device")
 Constructor. More...
 
 CNodeMapRefT (const CNodeMapRefT &Them)
 Copy constructor. More...
 
CNodeMapRefT & operator= (INodeMap *pNodeMap)
 Assignment of an INodeMap*. More...
 
CNodeMapRefT & operator= (const CNodeMapRefT &Them)
 Assignment. More...
 
virtual ~CNodeMapRefT ()
 Destructor. More...
 
void _Destroy ()
 Destroys the node map. More...
 

Detailed Description

Typedef Documentation

typedef NodeMap CNodeMapRef
typedef Node CNodeRef
typedef Node CSelectorRef

Function Documentation

bool Spinnaker::GenApi::_ClearXMLCache ( )
inline
bool Spinnaker::GenApi::_Connect ( IPort *  pPort,
const GenICam::gcstring &  PortName 
)
inline
bool Spinnaker::GenApi::_Connect ( IPort *  pPort)
inline
void _Destroy ( )
inline

Destroys the node map.

GenICam::gcstring Spinnaker::GenApi::_GetDeviceName ( )
inline
INode* Spinnaker::GenApi::_GetNode ( const GenICam::gcstring &  key)
inline
void Spinnaker::GenApi::_GetNodes ( NodeList_t &  Nodes)
inline
void Spinnaker::GenApi::_GetSupportedSchemaVersions ( GenICam::gcstring_vector &  SchemaVersions)
inline
void Spinnaker::GenApi::_InvalidateNodes ( )
inline
void Spinnaker::GenApi::_LoadXMLFromFile ( const GenICam::gcstring &  FileName)
inline
void Spinnaker::GenApi::_LoadXMLFromFileInject ( const GenICam::gcstring &  TargetFileName,
const GenICam::gcstring &  InjectFileName 
)
inline
void Spinnaker::GenApi::_LoadXMLFromString ( const GenICam::gcstring &  XMLData)
inline
void Spinnaker::GenApi::_LoadXMLFromStringInject ( const GenICam::gcstring &  TargetXMLData,
const GenICam::gcstring &  InjectXMLData 
)
inline
void Spinnaker::GenApi::_LoadXMLFromZIPData ( const void *  zipData,
size_t  zipSize 
)
inline
void Spinnaker::GenApi::_LoadXMLFromZIPFile ( const GenICam::gcstring &  ZipFileName)
inline
void Spinnaker::GenApi::_Poll ( int64_t  ElapsedTime)
inline
SPINNAKER_API IDestroy* Spinnaker::GenApi::CastToIDestroy ( INodeMap *  pNodeMap)

makes sure the dynamic_cast operator is implemented in the DLL (due to a Linux bug)

CNodeMapRefT ( const GenICam::gcstring DeviceName = "Device")
inline

Constructor.

CNodeMapRefT ( INodeMap pNodeMap,
const GenICam::gcstring DeviceName = "Device" 
)
inline

Constructor.

CNodeMapRefT ( const CNodeMapRefT< TCameraParams > &  Them)

Copy constructor.

SPINNAKER_API std::istream& Spinnaker::GenApi::EatComments ( std::istream &  is)

Helper function ignoring lines starting with comment character '#'.

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

writes out persistent data to a stream

CNodeMapRefT< TCameraParams > & operator= ( const CNodeMapRefT< TCameraParams > &  Them)

Assignment.

CNodeMapRefT< TCameraParams > & operator= ( INodeMap pNodeMap)

Assignment of an INodeMap*.

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

Reads in persistent data from a stream.

~CNodeMapRefT ( )
inlinevirtual

Destructor.

Contact Support Spinnaker® SDK Programmer's Guide and API Reference