Hold a map of all nodes. More...

#include <NodeMap.h>

Inheritance diagram for GENAPI_NAMESPACE::CNodeMap:

[legend]

Classes
class	EntryMethodFinalizer
	Used to ensure that PostSetValue() is called in any case. More...

Public Member Functions
	CNodeMap (const GENICAM_NAMESPACE::gcstring &DeviceName="Device", CLock *pUserProvidedLock=NULL)
	Constructor. More...

Interface INodeMap
virtual void	GetNodes (NodeList_t &Nodes) const

virtual INode *	GetNode (const GENICAM_NAMESPACE::gcstring &Name) const

virtual void	InvalidateNodes () const

virtual bool	Connect (IPort *pPort, const GENICAM_NAMESPACE::gcstring &PortName) const

virtual bool	Connect (IPort *pPort) const

virtual bool	Connect (IPortStacked *pPort, const GENICAM_NAMESPACE::gcstring &PortName)

virtual bool	Connect (IPortStacked *pPort)

virtual GENICAM_NAMESPACE::gcstring	GetDeviceName ()

virtual void	Poll (int64_t ElapsedTime)

virtual CLock &	GetLock () const

virtual uint64_t	GetNumNodes () const

virtual CNodeWriteConcatenator *	NewNodeWriteConcatenator () const

virtual bool	ConcatenatedWrite (CNodeWriteConcatenator , bool featureStreaming=true, GENICAM_NAMESPACE::gcstring_vector pErrorList=NULL)

virtual bool	ParseSwissKnifes (GENICAM_NAMESPACE::gcstring_vector *pErrorList=NULL) const

virtual void	SetSuppressCallbackMode (ECallbackSuppressMode mode)

Interface INodeMapPrivate
virtual void	RegisterNode (INodePrivate *pNode, CNodeData::ENodeType_t NodeType, NodeID_t NodeID)

virtual void	FinalConstruct (bool DetermineDependencies)

virtual void	SetNumNodes (size_t NumNodes)

virtual INodePrivate *	GetNodeByID (NodeID_t NodeID)

virtual void	SetProperty (CProperty &Property)

virtual bool	GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const

virtual bool	IsCallbackSuppressed ()

virtual Counter &	GetBathometer ()

virtual void	SetEntryPoint (EMethod EntryMethod, const INodePrivate *pEntryNode, bool stremable, bool IgnoreCache)

virtual void	ResetEntryPoint ()

virtual GENICAM_NAMESPACE::gcstring	GetEntryPoint ()

virtual bool	IsGenApiLoggingEnabled ()

virtual bool	IsGenApiDeviceLoggingEnabled ()

virtual bool	EntryIsStremable ()

virtual void	SetGenApiPersistenceMode (bool)

Interface IDeviceInfo
virtual GENICAM_NAMESPACE::gcstring	GetModelName ()

virtual GENICAM_NAMESPACE::gcstring	GetVendorName ()

virtual GENICAM_NAMESPACE::gcstring	GetToolTip ()

virtual GENICAM_NAMESPACE::gcstring	GetStandardNameSpace ()

virtual void	GetGenApiVersion (Version_t &Version, uint16_t &Build)

virtual void	GetSchemaVersion (Version_t &Version)

virtual void	GetDeviceVersion (Version_t &Version)

virtual GENICAM_NAMESPACE::gcstring	GetProductGuid ()

virtual GENICAM_NAMESPACE::gcstring	GetVersionGuid ()

Private Member Functions
Interface IUserData
virtual UserData_t	GetUserData () const

virtual UserData_t	SetUserData (UserData_t userdata)

Interface IDestroy
Makes the object to destroy itself
typedef std::vector< INodePrivate * >	Node2NodeID_t
	Holds the Node pointers referenced by NodeID. More...

GENICAM_NAMESPACE::gcstring	m_ModelName
	model name More...

GENICAM_NAMESPACE::gcstring	m_VendorName
	Get the vendor name. More...

GENICAM_NAMESPACE::gcstring	m_ToolTip
	tool tip More...

GENAPI_NAMESPACE::EStandardNameSpace	m_StandardNameSpace
	standard name space More...

Version_t	m_SchemaVersion
	schema version number More...

Version_t	m_DeviceVersion
	device description file's version number More...

GENICAM_NAMESPACE::gcstring	m_ProductGuid
	Guid describing the product. More...

GENICAM_NAMESPACE::gcstring	m_VersionGuid
	Guid describing the product version. More...

GENICAM_NAMESPACE::gcstring_vector	m_PropertyNames
	A list with all properties set. More...

GENICAM_NAMESPACE::gcstring	m_DeviceName
	The name of the device. More...

GENICAM_NAMESPACE::gcstring	m_Name
	Dummy name, used only for loading. More...

Node2NodeID_t	m_Node2NodeID

string2node_t *	m_pMap
	Holds the Node pointers referenced by NodeName. More...

uint64_t	m_suppressCallback
	counts the depth of SetValue call-chains More...

Counter	m_Bathometer
	counts the depth of SetValue call-chains More...

const INodePrivate *	m_pEntryNode
	The node where a call entered the tree. More...

EMethod	m_EntryMethod
	The node where a call entered the tree. More...

int	m_EntryPointDepth
	Number of call pairs to SetEntryPoint/ResetEntryPoint. More...

bool	m_EntryPointIgnoreCache
	Indicates if the entry point had the Ignore Cache flag set. More...

bool	m_EntryPointStreamable
	Indicate if the entry point has the stremable flag. More...

NodePrivateVector_t *	m_pPollingNodes
	List of pointers to nodes which need to be polled. More...

bool	m_GenApiLoggingEnabled
	indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi") ) More...

bool	m_GenApiDeviceLoggingEnabled
	indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi.Device") ) More...

bool	m_GenApiPersistenceMode
	indicates who GenApi deals with the verify flag. More...

CLock &	m_Lock
	The pointer to the lock guarding access to the node map This may be changed by the user if he decides to use another lock. More...

CLock	m_zzz_OwnLock_DoNotUse
	The own lock guarding access to the node map Do not use this directly! Use GetLock() instead. More...

UserData_t	m_pUserData
	Storage of user defined data. Ownership remains by the user!. Use IUserData interface to access the data. More...

std::list< CPort * >	m_connectedPort

virtual void	Destroy ()

INodePrivate *	_GetNodeByID (NodeID_t NodeID)

	CNodeMap (const CNodeMap &)
	forbidden copy constructor More...

CNodeMap &	operator= (const CNodeMap &)
	forbidden operator= More...

string2node_t &	Map ()
	Retrieve the map. More...

const string2node_t &	Map () const
	Retrieve the map. More...

virtual	~CNodeMap ()
	Destructor (note that in order to destroy the node map you need to call IDestroy::Destroy() More...

void	ClearAllNodes ()
	Clear the map. More...

Detailed Description

Hold a map of all nodes.

Definition at line 61 of file NodeMap.h.

Member Typedef Documentation

◆ Node2NodeID_t

typedef std::vector<INodePrivate*> GENAPI_NAMESPACE::CNodeMap::Node2NodeID_t

protected

Holds the Node pointers referenced by NodeID.

Definition at line 192 of file NodeMap.h.

Constructor & Destructor Documentation

◆ CNodeMap() [1/2]

GENAPI_NAMESPACE::CNodeMap::CNodeMap	(	const GENICAM_NAMESPACE::gcstring &	DeviceName = `"Device"`,
		CLock *	pUserProvidedLock = `NULL`
	)

Constructor.

◆ ~CNodeMap()

virtual GENAPI_NAMESPACE::CNodeMap::~CNodeMap ( )

protectedvirtual

Destructor (note that in order to destroy the node map you need to call IDestroy::Destroy()

◆ CNodeMap() [2/2]

GENAPI_NAMESPACE::CNodeMap::CNodeMap ( const CNodeMap & )

private

forbidden copy constructor

Member Function Documentation

◆ _GetNodeByID()

INodePrivate* GENAPI_NAMESPACE::CNodeMap::_GetNodeByID ( NodeID_t NodeID )

inline

Definition at line 143 of file NodeMap.h.

◆ ClearAllNodes()

void GENAPI_NAMESPACE::CNodeMap::ClearAllNodes ( )

protected

Clear the map.

◆ ConcatenatedWrite()

virtual bool GENAPI_NAMESPACE::CNodeMap::ConcatenatedWrite	(	CNodeWriteConcatenator *	,
		bool	featureStreaming = `true`,
		GENICAM_NAMESPACE::gcstring_vector *	pErrorList = `NULL`
	)

virtual

◆ Connect() [1/4]

virtual bool GENAPI_NAMESPACE::CNodeMap::Connect ( IPort * pPort ) const

virtual

◆ Connect() [2/4]

virtual bool GENAPI_NAMESPACE::CNodeMap::Connect	(	IPort *	pPort,
		const GENICAM_NAMESPACE::gcstring &	PortName
	)		const

virtual

◆ Connect() [3/4]

virtual bool GENAPI_NAMESPACE::CNodeMap::Connect ( IPortStacked * pPort )

virtual

◆ Connect() [4/4]

virtual bool GENAPI_NAMESPACE::CNodeMap::Connect	(	IPortStacked *	pPort,
		const GENICAM_NAMESPACE::gcstring &	PortName
	)

virtual

◆ Destroy()

virtual void GENAPI_NAMESPACE::CNodeMap::Destroy ( )

virtual

◆ EntryIsStremable()

virtual bool GENAPI_NAMESPACE::CNodeMap::EntryIsStremable ( )

virtual

◆ FinalConstruct()

virtual void GENAPI_NAMESPACE::CNodeMap::FinalConstruct ( bool DetermineDependencies )

virtual

◆ GetBathometer()

virtual Counter& GENAPI_NAMESPACE::CNodeMap::GetBathometer ( )

inlinevirtual

Definition at line 105 of file NodeMap.h.

◆ GetDeviceName()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetDeviceName ( )

virtual

◆ GetDeviceVersion()

virtual void GENAPI_NAMESPACE::CNodeMap::GetDeviceVersion ( Version_t & Version )

virtual

◆ GetEntryPoint()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetEntryPoint ( )

virtual

◆ GetGenApiVersion()

virtual void GENAPI_NAMESPACE::CNodeMap::GetGenApiVersion	(	Version_t &	Version,
		uint16_t &	Build
	)

virtual

◆ GetLock()

virtual CLock& GENAPI_NAMESPACE::CNodeMap::GetLock ( ) const

virtual

◆ GetModelName()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetModelName ( )

virtual

◆ GetNode()

virtual INode* GENAPI_NAMESPACE::CNodeMap::GetNode ( const GENICAM_NAMESPACE::gcstring & Name ) const

virtual

◆ GetNodeByID()

virtual INodePrivate* GENAPI_NAMESPACE::CNodeMap::GetNodeByID ( NodeID_t NodeID )

virtual

◆ GetNodes()

virtual void GENAPI_NAMESPACE::CNodeMap::GetNodes ( NodeList_t & Nodes ) const

virtual

◆ GetNumNodes()

virtual uint64_t GENAPI_NAMESPACE::CNodeMap::GetNumNodes ( ) const

virtual

◆ GetProductGuid()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetProductGuid ( )

virtual

◆ GetProperty()

virtual bool GENAPI_NAMESPACE::CNodeMap::GetProperty	(	CNodeDataMap *	pNodeDataMap,
		CPropertyID::EProperty_ID_t	PropertyID,
		CNodeData::PropertyVector_t &	PropertyList
	)		const

virtual

◆ GetSchemaVersion()

virtual void GENAPI_NAMESPACE::CNodeMap::GetSchemaVersion ( Version_t & Version )

virtual

◆ GetStandardNameSpace()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetStandardNameSpace ( )

virtual

◆ GetToolTip()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetToolTip ( )

virtual

◆ GetUserData()

virtual UserData_t GENAPI_NAMESPACE::CNodeMap::GetUserData ( ) const

privatevirtual

◆ GetVendorName()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetVendorName ( )

virtual

◆ GetVersionGuid()

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::GetVersionGuid ( )

virtual

◆ InvalidateNodes()

virtual void GENAPI_NAMESPACE::CNodeMap::InvalidateNodes ( ) const

virtual

◆ IsCallbackSuppressed()

virtual bool GENAPI_NAMESPACE::CNodeMap::IsCallbackSuppressed ( )

inlinevirtual

Definition at line 104 of file NodeMap.h.

◆ IsGenApiDeviceLoggingEnabled()

virtual bool GENAPI_NAMESPACE::CNodeMap::IsGenApiDeviceLoggingEnabled ( )

virtual

◆ IsGenApiLoggingEnabled()

virtual bool GENAPI_NAMESPACE::CNodeMap::IsGenApiLoggingEnabled ( )

virtual

◆ Map() [1/2]

string2node_t& GENAPI_NAMESPACE::CNodeMap::Map ( )

protected

Retrieve the map.

◆ Map() [2/2]

const string2node_t& GENAPI_NAMESPACE::CNodeMap::Map ( ) const

protected

Retrieve the map.

◆ NewNodeWriteConcatenator()

virtual CNodeWriteConcatenator* GENAPI_NAMESPACE::CNodeMap::NewNodeWriteConcatenator ( ) const

virtual

◆ operator=()

CNodeMap& GENAPI_NAMESPACE::CNodeMap::operator= ( const CNodeMap & )

private

forbidden operator=

◆ ParseSwissKnifes()

virtual bool GENAPI_NAMESPACE::CNodeMap::ParseSwissKnifes ( GENICAM_NAMESPACE::gcstring_vector * pErrorList = NULL ) const

virtual

◆ Poll()

virtual void GENAPI_NAMESPACE::CNodeMap::Poll ( int64_t ElapsedTime )

virtual

◆ RegisterNode()

virtual void GENAPI_NAMESPACE::CNodeMap::RegisterNode	(	INodePrivate *	pNode,
		CNodeData::ENodeType_t	NodeType,
		NodeID_t	NodeID
	)

virtual

◆ ResetEntryPoint()

virtual void GENAPI_NAMESPACE::CNodeMap::ResetEntryPoint ( )

virtual

◆ SetEntryPoint()

virtual void GENAPI_NAMESPACE::CNodeMap::SetEntryPoint	(	EMethod	EntryMethod,
		const INodePrivate *	pEntryNode,
		bool	stremable,
		bool	IgnoreCache
	)

virtual

◆ SetGenApiPersistenceMode()

virtual void GENAPI_NAMESPACE::CNodeMap::SetGenApiPersistenceMode ( bool )

virtual

◆ SetNumNodes()

virtual void GENAPI_NAMESPACE::CNodeMap::SetNumNodes ( size_t NumNodes )

virtual

◆ SetProperty()

virtual void GENAPI_NAMESPACE::CNodeMap::SetProperty ( CProperty & Property )

virtual

◆ SetSuppressCallbackMode()

virtual void GENAPI_NAMESPACE::CNodeMap::SetSuppressCallbackMode ( ECallbackSuppressMode mode )

virtual

◆ SetUserData()

virtual UserData_t GENAPI_NAMESPACE::CNodeMap::SetUserData ( UserData_t userdata )

privatevirtual

Member Data Documentation

◆ m_Bathometer

Counter GENAPI_NAMESPACE::CNodeMap::m_Bathometer

protected

counts the depth of SetValue call-chains

Definition at line 222 of file NodeMap.h.

◆ m_connectedPort

std::list<CPort *> GENAPI_NAMESPACE::CNodeMap::m_connectedPort

private

Definition at line 266 of file NodeMap.h.

◆ m_DeviceName

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_DeviceName

protected

The name of the device.

Definition at line 182 of file NodeMap.h.

◆ m_DeviceVersion

Version_t GENAPI_NAMESPACE::CNodeMap::m_DeviceVersion

protected

device description file's version number

Definition at line 170 of file NodeMap.h.

◆ m_EntryMethod

EMethod GENAPI_NAMESPACE::CNodeMap::m_EntryMethod

protected

The node where a call entered the tree.

Definition at line 228 of file NodeMap.h.

◆ m_EntryPointDepth

int GENAPI_NAMESPACE::CNodeMap::m_EntryPointDepth

protected

Number of call pairs to SetEntryPoint/ResetEntryPoint.

Definition at line 231 of file NodeMap.h.

◆ m_EntryPointIgnoreCache

bool GENAPI_NAMESPACE::CNodeMap::m_EntryPointIgnoreCache

protected

Indicates if the entry point had the Ignore Cache flag set.

Definition at line 234 of file NodeMap.h.

◆ m_EntryPointStreamable

bool GENAPI_NAMESPACE::CNodeMap::m_EntryPointStreamable

protected

Indicate if the entry point has the stremable flag.

Definition at line 237 of file NodeMap.h.

◆ m_GenApiDeviceLoggingEnabled

bool GENAPI_NAMESPACE::CNodeMap::m_GenApiDeviceLoggingEnabled

protected

indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi.Device") )

Definition at line 246 of file NodeMap.h.

◆ m_GenApiLoggingEnabled

bool GENAPI_NAMESPACE::CNodeMap::m_GenApiLoggingEnabled

protected

indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi") )

Definition at line 243 of file NodeMap.h.

◆ m_GenApiPersistenceMode

bool GENAPI_NAMESPACE::CNodeMap::m_GenApiPersistenceMode

protected

indicates who GenApi deals with the verify flag.

Definition at line 249 of file NodeMap.h.

◆ m_Lock

CLock& GENAPI_NAMESPACE::CNodeMap::m_Lock

protected

The pointer to the lock guarding access to the node map This may be changed by the user if he decides to use another lock.

Definition at line 263 of file NodeMap.h.

◆ m_ModelName

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ModelName

protected

model name

Definition at line 155 of file NodeMap.h.

◆ m_Name

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_Name

protected

Dummy name, used only for loading.

Definition at line 185 of file NodeMap.h.

◆ m_Node2NodeID

Node2NodeID_t GENAPI_NAMESPACE::CNodeMap::m_Node2NodeID

protected

Definition at line 193 of file NodeMap.h.

◆ m_pEntryNode

const INodePrivate* GENAPI_NAMESPACE::CNodeMap::m_pEntryNode

protected

The node where a call entered the tree.

Definition at line 225 of file NodeMap.h.

◆ m_pMap

string2node_t* GENAPI_NAMESPACE::CNodeMap::m_pMap

protected

Holds the Node pointers referenced by NodeName.

Definition at line 196 of file NodeMap.h.

◆ m_pPollingNodes

NodePrivateVector_t* GENAPI_NAMESPACE::CNodeMap::m_pPollingNodes

protected

List of pointers to nodes which need to be polled.

Definition at line 240 of file NodeMap.h.

◆ m_ProductGuid

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ProductGuid

protected

Guid describing the product.

Definition at line 173 of file NodeMap.h.

◆ m_PropertyNames

GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::CNodeMap::m_PropertyNames

protected

A list with all properties set.

Definition at line 179 of file NodeMap.h.

◆ m_pUserData

UserData_t GENAPI_NAMESPACE::CNodeMap::m_pUserData

private

Storage of user defined data. Ownership remains by the user!. Use IUserData interface to access the data.

Definition at line 258 of file NodeMap.h.

◆ m_SchemaVersion

Version_t GENAPI_NAMESPACE::CNodeMap::m_SchemaVersion

protected

schema version number

Definition at line 167 of file NodeMap.h.

◆ m_StandardNameSpace

GENAPI_NAMESPACE::EStandardNameSpace GENAPI_NAMESPACE::CNodeMap::m_StandardNameSpace

protected

standard name space

Definition at line 164 of file NodeMap.h.

◆ m_suppressCallback

uint64_t GENAPI_NAMESPACE::CNodeMap::m_suppressCallback

protected

counts the depth of SetValue call-chains

Definition at line 219 of file NodeMap.h.

◆ m_ToolTip

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ToolTip

protected

tool tip

Definition at line 161 of file NodeMap.h.

◆ m_VendorName

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_VendorName

protected

Get the vendor name.

Definition at line 158 of file NodeMap.h.

◆ m_VersionGuid

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_VersionGuid

protected

Guid describing the product version.

Definition at line 176 of file NodeMap.h.

◆ m_zzz_OwnLock_DoNotUse

CLock GENAPI_NAMESPACE::CNodeMap::m_zzz_OwnLock_DoNotUse

private

The own lock guarding access to the node map Do not use this directly! Use GetLock() instead.

Definition at line 254 of file NodeMap.h.

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

NodeMap.h

Classes

Public Member Functions

Private Member Functions

Interface IDestroy

Detailed Description

Member Typedef Documentation

◆ Node2NodeID_t

Constructor & Destructor Documentation

◆ CNodeMap() [1/2]

◆ ~CNodeMap()

◆ CNodeMap() [2/2]

Member Function Documentation

◆ _GetNodeByID()

◆ ClearAllNodes()

◆ ConcatenatedWrite()

◆ Connect() [1/4]

◆ Connect() [2/4]

◆ Connect() [3/4]

◆ Connect() [4/4]

◆ Destroy()

◆ EntryIsStremable()

◆ FinalConstruct()

◆ GetBathometer()

◆ GetDeviceName()

◆ GetDeviceVersion()

◆ GetEntryPoint()

◆ GetGenApiVersion()

◆ GetLock()

◆ GetModelName()

◆ GetNode()

◆ GetNodeByID()

◆ GetNodes()

◆ GetNumNodes()

◆ GetProductGuid()

◆ GetProperty()

◆ GetSchemaVersion()

◆ GetStandardNameSpace()

◆ GetToolTip()

◆ GetUserData()

◆ GetVendorName()

◆ GetVersionGuid()

◆ InvalidateNodes()

◆ IsCallbackSuppressed()

◆ IsGenApiDeviceLoggingEnabled()

◆ IsGenApiLoggingEnabled()

◆ Map() [1/2]

◆ Map() [2/2]

◆ NewNodeWriteConcatenator()

◆ operator=()

◆ ParseSwissKnifes()

◆ Poll()

◆ RegisterNode()

◆ ResetEntryPoint()

◆ SetEntryPoint()

◆ SetGenApiPersistenceMode()

◆ SetNumNodes()

◆ SetProperty()

◆ SetSuppressCallbackMode()

◆ SetUserData()

Member Data Documentation

◆ m_Bathometer

◆ m_connectedPort

◆ m_DeviceName

◆ m_DeviceVersion

◆ m_EntryMethod

◆ m_EntryPointDepth

◆ m_EntryPointIgnoreCache

◆ m_EntryPointStreamable

◆ m_GenApiDeviceLoggingEnabled

◆ m_GenApiLoggingEnabled

◆ m_GenApiPersistenceMode

◆ m_Lock

◆ m_ModelName

◆ m_Name

◆ m_Node2NodeID

◆ m_pEntryNode

◆ m_pMap

◆ m_pPollingNodes

◆ m_ProductGuid

◆ m_PropertyNames