All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 >:

Public Member Functions

virtual bool _ConcatenatedWrite (CNodeWriteConcatenator *, bool featureStreaming=true, GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL)
 Execute the transaction. More...
 
virtual bool _Connect (IPort *pPort) const
 Connects a port to the standard port "Device". More...
 
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 (IPortStacked *pPort) const
 Connects a port to the standard port "Device". More...
 
virtual bool _Connect (IPortStacked *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const
 Connects a port to a port node with given name. 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 CNodeWriteConcatenator_NewNodeWriteConcatenator () const
 Create a new write concatenator object. 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...
 
virtual void _SetSuppressCallbackMode (ECallbackSuppressMode) const
 Set suppress callback mode. More...
 
 CNodeMapRefT (const CNodeMapRefT &Them)
 Copy constructor. More...
 
 CNodeMapRefT (const GENICAM_NAMESPACE::gcstring &DeviceName="Device")
 Constructor. More...
 
 CNodeMapRefT (INodeMap *pNodeMap, const GENICAM_NAMESPACE::gcstring &DeviceName="Device")
 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

◆ CNodeMapRefT() [1/3]

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

Constructor.

Definition at line 177 of file NodeMapRef.h.

◆ CNodeMapRefT() [2/3]

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

Constructor.

Definition at line 185 of file NodeMapRef.h.

◆ CNodeMapRefT() [3/3]

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

Copy constructor.

Definition at line 195 of file NodeMapRef.h.

◆ ~CNodeMapRefT()

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

Destructor.

Definition at line 299 of file NodeMapRef.h.

Member Function Documentation

◆ _ClearXMLCache()

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

Clears the cache of the camera description files.

Definition at line 525 of file NodeMapRef.h.

◆ _ConcatenatedWrite()

template<class TCameraParams >
bool GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_ConcatenatedWrite ( CNodeWriteConcatenator pConcatenatedWrite,
bool  featureStreaming = true,
GENICAM_NAMESPACE::gcstring_vector *  pErrorList = NULL 
)
inlinevirtual

Execute the transaction.

Definition at line 461 of file NodeMapRef.h.

◆ _Connect() [1/4]

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

Connects a port to the standard port "Device".

Definition at line 501 of file NodeMapRef.h.

◆ _Connect() [2/4]

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 493 of file NodeMapRef.h.

◆ _Connect() [3/4]

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

Connects a port to the standard port "Device".

Definition at line 517 of file NodeMapRef.h.

◆ _Connect() [4/4]

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

Connects a port to a port node with given name.

Definition at line 509 of file NodeMapRef.h.

◆ _Destroy()

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

Destroys the node map.

Definition at line 305 of file NodeMapRef.h.

◆ _GetDeviceName()

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

Get device name.

Definition at line 419 of file NodeMapRef.h.

◆ _GetNode()

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 469 of file NodeMapRef.h.

◆ _GetNodes()

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

Retrieves all nodes in the node map.

Definition at line 435 of file NodeMapRef.h.

◆ _GetSupportedSchemaVersions()

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 413 of file NodeMapRef.h.

◆ _InvalidateNodes()

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_InvalidateNodes
inlinevirtual

Invalidates all nodes.

Definition at line 477 of file NodeMapRef.h.

◆ _LoadXMLFromFile()

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 312 of file NodeMapRef.h.

◆ _LoadXMLFromFileInject()

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 346 of file NodeMapRef.h.

◆ _LoadXMLFromString()

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 365 of file NodeMapRef.h.

◆ _LoadXMLFromStringInject()

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 396 of file NodeMapRef.h.

◆ _LoadXMLFromZIPData()

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 381 of file NodeMapRef.h.

◆ _LoadXMLFromZIPFile()

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 329 of file NodeMapRef.h.

◆ _NewNodeWriteConcatenator()

template<class TCameraParams >
CNodeWriteConcatenator * GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_NewNodeWriteConcatenator
inlinevirtual

Create a new write concatenator object.

Definition at line 453 of file NodeMapRef.h.

◆ _ParseSwissKnifes()

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

Parse all Swissknife equations.

Definition at line 485 of file NodeMapRef.h.

◆ _Poll()

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

Fires nodes which have a polling time.

Definition at line 427 of file NodeMapRef.h.

◆ _SetSuppressCallbackMode()

template<class TCameraParams >
void GENAPI_NAMESPACE::CNodeMapRefT< TCameraParams >::_SetSuppressCallbackMode ( ECallbackSuppressMode  mode) const
inlinevirtual

Set suppress callback mode.

Definition at line 444 of file NodeMapRef.h.

◆ Attach()

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

Definition at line 206 of file NodeMapRef.h.

◆ operator=() [1/2]

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

Assignment.

Definition at line 291 of file NodeMapRef.h.

◆ operator=() [2/2]

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

Assignment of an INodeMap*.

Definition at line 278 of file NodeMapRef.h.

◆ Release()

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

Definition at line 238 of file NodeMapRef.h.

Member Data Documentation

◆ _DeviceName

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

The name of this device.

Definition at line 166 of file NodeMapRef.h.

◆ _pRefCount

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

Definition at line 169 of file NodeMapRef.h.

◆ _Ptr

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

Pointer to the NodeMap.

Definition at line 162 of file NodeMapRef.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:13