Skip to content

GenApi::CNodeMapRefT#

Module: GenICam / GenApi Node Interfaces and Access Mode Check Functions

Smartpointer template for NodeMaps with create function. More…

#include <GenApi/NodeMapRef.h>

Inherits from TCameraParams

Public Functions#

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

Public Attributes#

Name
INodeMap * _Ptr
Pointer to the NodeMap.

Detailed Description#

template <class TCameraParams>
class GenApi::CNodeMapRefT;

Smartpointer template for NodeMaps with create function.

Template Parameters:

  • TCameraParams The camera specific parameter class (auto generated from camera xml file)

Public Functions Documentation#

CNodeMapRefT#

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

Constructor.

CNodeMapRefT#

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

Constructor.

CNodeMapRefT#

CNodeMapRefT(
    const CNodeMapRefT & Them
)

Copy constructor.

operator=#

CNodeMapRefT & operator=(
    const CNodeMapRefT & Them
)

Assignment.

operator=#

CNodeMapRefT & operator=(
    INodeMap * pNodeMap
)

Assignment of an INodeMap*.

~CNodeMapRefT#

inline virtual ~CNodeMapRefT()

Destructor.

_Destroy#

inline void _Destroy()

Destroys the node map.

_LoadXMLFromFile#

inline void _LoadXMLFromFile(
    const GenICam::gcstring & FileName
)

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

_LoadXMLFromZIPFile#

inline void _LoadXMLFromZIPFile(
    const GenICam::gcstring & ZipFileName
)

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

_LoadXMLFromZIPData#

inline void _LoadXMLFromZIPData(
    const void * zipData,
    size_t zipSize
)

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

_LoadXMLFromFileInject#

inline void _LoadXMLFromFileInject(
    const GenICam::gcstring & TargetFileName,
    const GenICam::gcstring & InjectFileName
)

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

_LoadXMLFromString#

inline void _LoadXMLFromString(
    const GenICam::gcstring & XMLData
)

Creates the object from XML data given in a string.

_LoadXMLFromStringInject#

inline void _LoadXMLFromStringInject(
    const GenICam::gcstring & TargetXMLDataconst,
    const GenICam::gcstring & InjectXMLData
)

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

_GetSupportedSchemaVersions#

inline virtual void _GetSupportedSchemaVersions(
    GenICam::gcstring_vector & SchemaVersions
) const

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

_GetDeviceName#

inline virtual GenICam::gcstring _GetDeviceName() const

Get device name.

_Poll#

inline virtual void _Poll(
    int64_t ElapsedTime
)

Fires nodes which have a polling time.

_GetNodes#

inline virtual void _GetNodes(
    NodeList_t & Nodes
) const

Retrieves all nodes in the node map.

_GetNode#

inline virtual INode * _GetNode(
    const GenICam::gcstring & key
) const

Retrieves the node from the central map by name.

_InvalidateNodes#

inline virtual void _InvalidateNodes() const

Invalidates all nodes.

_Connect#

inline virtual bool _Connect(
    IPort * pPort,
    const GenICam::gcstring & PortName
) const

Connects a port to a port node with given name.

_Connect#

inline virtual bool _Connect(
    IPort * pPort
) const

Connects a port to the standard port "Device".

_ParseSwissKnifes#

inline virtual bool _ParseSwissKnifes(
    GenICam::gcstring_vector * pErrorList =NULL
) const

Parse all Swissknife equations.

_ClearXMLCache#

static inline bool _ClearXMLCache()

Clears the cache of the camera description files.

Public Attributes Documentation#

_Ptr#

INodeMap * _Ptr;

Pointer to the NodeMap.


Updated on 5 July 2022 at 15:30:01