Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams > Class Template Reference

Smartpointer template for NodeMaps with create function. More...

#include <NodeMapRef.h>

Inheritance diagram for GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >:
Inheritance graph
[legend]

Public Member Functions

virtual bool _Connect (IPort *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const
 Connects a port to a port node with given name. More...
 
virtual bool _Connect (IPort *pPort) const
 Connects a port to the standard port "Device". More...
 
void _Destroy ()
 Destroys the node map. More...
 
virtual GENICAM_NAMESPACE::gcstring _GetDeviceName () const
 Get device name. More...
 
virtual INode_GetNode (const GENICAM_NAMESPACE::gcstring &key) const
 Retrieves the node from the central map by name. More...
 
virtual void _GetNodes (NodeList_t &Nodes) const
 Retrieves all nodes in the node map. More...
 
virtual void _GetSupportedSchemaVersions (GENICAM_NAMESPACE::gcstring_vector &SchemaVersions) const
 Gets a list of supported schema versions. More...
 
virtual void _InvalidateNodes () const
 Invalidates all nodes. More...
 
void _LoadXMLFromFile (const GENICAM_NAMESPACE::gcstring &FileName)
 Creates the object from a XML file with given file name. More...
 
void _LoadXMLFromFileInject (const GENICAM_NAMESPACE::gcstring &TargetFileName, const GENICAM_NAMESPACE::gcstring &InjectFileName)
 Creates the object from a XML target and an inject file with given file name. More...
 
void _LoadXMLFromString (const GENICAM_NAMESPACE::gcstring &XMLData)
 Creates the object from XML data given in a string. More...
 
void _LoadXMLFromStringInject (const GENICAM_NAMESPACE::gcstring &TargetXMLDataconst, const GENICAM_NAMESPACE::gcstring &InjectXMLData)
 Creates the object from XML data given in a string with injection. More...
 
void _LoadXMLFromZIPData (const void *zipData, size_t zipSize)
 Creates the object from a ZIP'd XML file given in a string. More...
 
void _LoadXMLFromZIPFile (const GENICAM_NAMESPACE::gcstring &ZipFileName)
 Creates the object from a ZIP'd XML file with given file name. More...
 
virtual bool _ParseSwissKnifes (GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL) const
 Parse all Swissknife equations. More...
 
virtual void _Poll (int64_t ElapsedTime)
 Fires nodes which have a polling time. More...
 
 CNodeMapRefT (const GENICAM_NAMESPACE::gcstring &DeviceName="Device")
 Constructor. More...
 
 CNodeMapRefT (INodeMap *pNodeMap, const GENICAM_NAMESPACE::gcstring &DeviceName="Device")
 Constructor. More...
 
 CNodeMapRefT (const CNodeMapRefT &Them)
 Copy constructor. More...
 
CNodeMapRefToperator= (const CNodeMapRefT &Them)
 Assignment. More...
 
CNodeMapRefToperator= (INodeMap *pNodeMap)
 Assignment of an INodeMap*. More...
 
virtual ~CNodeMapRefT ()
 Destructor. More...
 

Static Public Member Functions

static bool _ClearXMLCache ()
 Clears the cache of the camera description files. More...
 

Public Attributes

INodeMap_Ptr
 Pointer to the NodeMap. More...
 

Private Member Functions

void Attach (INodeMap *pNodeMap, const GENICAM_NAMESPACE::gcstring &DeviceName, int *pRefCount)
 
void Release ()
 

Private Attributes

GENICAM_NAMESPACE::gcstring _DeviceName
 The name of this device. More...
 
int * _pRefCount
 

Detailed Description

template<class TCameraParams>
class GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >

Smartpointer template for NodeMaps with create function.

Template Parameters
TCameraParamsThe camera specific parameter class (auto generated from camera xml file)

Definition at line 67 of file NodeMapRef.h.

Constructor & Destructor Documentation

template<class TCameraParams >
GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::CNodeMapRefT ( const GENICAM_NAMESPACE::gcstring DeviceName = "Device")
inline

Constructor.

Definition at line 162 of file NodeMapRef.h.

template<class TCameraParams >
GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::CNodeMapRefT ( INodeMap pNodeMap,
const GENICAM_NAMESPACE::gcstring DeviceName = "Device" 
)
inline

Constructor.

Definition at line 170 of file NodeMapRef.h.

template<class TCameraParams >
GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::CNodeMapRefT ( const CNodeMapRefT< TCameraParams > &  Them)

Copy constructor.

Definition at line 180 of file NodeMapRef.h.

template<class TCameraParams >
GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::~CNodeMapRefT ( )
inlinevirtual

Destructor.

Definition at line 284 of file NodeMapRef.h.

Member Function Documentation

template<class TCameraParams >
bool GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_ClearXMLCache ( )
inlinestatic

Clears the cache of the camera description files.

Definition at line 461 of file NodeMapRef.h.

template<class TCameraParams >
bool GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_Connect ( IPort pPort,
const GENICAM_NAMESPACE::gcstring PortName 
) const
inlinevirtual

Connects a port to a port node with given name.

Definition at line 442 of file NodeMapRef.h.

template<class TCameraParams >
bool GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_Connect ( IPort pPort) const
inlinevirtual

Connects a port to the standard port "Device".

Definition at line 451 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_Destroy ( )
inline

Destroys the node map.

Definition at line 290 of file NodeMapRef.h.

template<class TCameraParams >
GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_GetDeviceName ( ) const
inlinevirtual

Get device name.

Definition at line 386 of file NodeMapRef.h.

template<class TCameraParams >
INode * GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_GetNode ( const GENICAM_NAMESPACE::gcstring key) const
inlinevirtual

Retrieves the node from the central map by name.

Definition at line 413 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_GetNodes ( NodeList_t Nodes) const
inlinevirtual

Retrieves all nodes in the node map.

Definition at line 404 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_GetSupportedSchemaVersions ( GENICAM_NAMESPACE::gcstring_vector &  SchemaVersions) const
inlinevirtual

Gets a list of supported schema versions.

Each list entry is a string with the format "{Major}.{Minor}" were {Major} and {Minor} are integers Example: {"1.1", "1.2"} indicates that the schema v1.1 and v1.2 are supported. The SubMinor version number is not given since it is for fully compatible bug fixes only

Definition at line 380 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_InvalidateNodes ( ) const
inlinevirtual

Invalidates all nodes.

Definition at line 422 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromFile ( const GENICAM_NAMESPACE::gcstring FileName)
inline

Creates the object from a XML file with given file name.

Definition at line 297 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromFileInject ( const GENICAM_NAMESPACE::gcstring TargetFileName,
const GENICAM_NAMESPACE::gcstring InjectFileName 
)
inline

Creates the object from a XML target and an inject file with given file name.

Definition at line 325 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromString ( const GENICAM_NAMESPACE::gcstring XMLData)
inline

Creates the object from XML data given in a string.

Definition at line 341 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromStringInject ( const GENICAM_NAMESPACE::gcstring TargetXMLDataconst,
const GENICAM_NAMESPACE::gcstring InjectXMLData 
)
inline

Creates the object from XML data given in a string with injection.

Definition at line 366 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromZIPData ( const void *  zipData,
size_t  zipSize 
)
inline

Creates the object from a ZIP'd XML file given in a string.

Definition at line 354 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_LoadXMLFromZIPFile ( const GENICAM_NAMESPACE::gcstring ZipFileName)
inline

Creates the object from a ZIP'd XML file with given file name.

Definition at line 311 of file NodeMapRef.h.

template<class TCameraParams >
bool GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_ParseSwissKnifes ( GENICAM_NAMESPACE::gcstring_vector *  pErrorList = NULL) const
inlinevirtual

Parse all Swissknife equations.

Definition at line 431 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_Poll ( int64_t  ElapsedTime)
inlinevirtual

Fires nodes which have a polling time.

Definition at line 395 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::Attach ( INodeMap pNodeMap,
const GENICAM_NAMESPACE::gcstring DeviceName,
int *  pRefCount 
)
private

Definition at line 191 of file NodeMapRef.h.

template<class TCameraParams >
CNodeMapRefT< TCameraParams > & GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::operator= ( const CNodeMapRefT< TCameraParams > &  Them)

Assignment.

Definition at line 276 of file NodeMapRef.h.

template<class TCameraParams >
CNodeMapRefT< TCameraParams > & GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::operator= ( INodeMap pNodeMap)

Assignment of an INodeMap*.

Definition at line 263 of file NodeMapRef.h.

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::Release ( )
private

Definition at line 223 of file NodeMapRef.h.

Member Data Documentation

template<class TCameraParams>
GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_DeviceName
private

The name of this device.

Definition at line 151 of file NodeMapRef.h.

template<class TCameraParams>
int* GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_pRefCount
private

Definition at line 154 of file NodeMapRef.h.

template<class TCameraParams>
INodeMap* GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_Ptr

Pointer to the NodeMap.

Definition at line 147 of file NodeMapRef.h.


The documentation for this class was generated from the following file:


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:55