Hold a map of all nodes. More...

#include <NodeMap.h>

Public Member Functions
INodePrivate *	_GetNodeByID (NodeID_t NodeID)
	CNodeMap (const GENICAM_NAMESPACE::gcstring &DeviceName="Device", CLock *pUserProvidedLock=NULL)
	Constructor.
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 GENICAM_NAMESPACE::gcstring	GetDeviceName ()
virtual void	Poll (int64_t ElapsedTime)
virtual CLock &	GetLock () const
virtual uint64_t	GetNumNodes () const
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 Counter &	GetBathometer ()
virtual void	SetEntryPoint (EMethod EntryMethod, const INodePrivate *pEntryNode, bool IgnoreCache)
virtual void	ResetEntryPoint ()
virtual GENICAM_NAMESPACE::gcstring	GetEntryPoint ()
virtual bool	IsGenApiLoggingEnabled ()
virtual bool	IsGenApiDeviceLoggingEnabled ()
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 ()
Interface IDestroy
Makes the object to destroy itself
virtual void	Destroy ()
Protected Types
typedef std::vector < INodePrivate * >	Node2NodeID_t
	Holds the Node pointers referenced by NodeID.
Protected Member Functions
void	ClearAllNodes ()
	Clear the map.
string2node_t &	Map ()
	Retrieve the map.
const string2node_t &	Map () const
	Retrieve the map.
virtual	~CNodeMap ()
	Destructor (note that in order to destroy the node map you need to call IDestroy::Destroy()
Protected Attributes
Counter	m_Bathometer
	counts the depth of SetValue call-chains
GENICAM_NAMESPACE::gcstring	m_DeviceName
	The name of the device.
Version_t	m_DeviceVersion
	device description file's version number
EMethod	m_EntryMethod
	The node where a call entered the tree.
int	m_EntryPointDepth
	Number of call pairs to SetEntryPoint/ResetEntryPoint.
bool	m_EntryPointIgnoreCache
	Indicates if the entry point had the Ignore Cache flag set.
bool	m_GenApiDeviceLoggingEnabled
	indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi.Device") )
bool	m_GenApiLoggingEnabled
	indicates GenApi logging is enabled (caches the returnvalue of CLog::Exists("GenApi") )
CLock &	m_Lock
GENICAM_NAMESPACE::gcstring	m_ModelName
	model name
GENICAM_NAMESPACE::gcstring	m_Name
	Dummy name, used only for loading.
Node2NodeID_t	m_Node2NodeID
const INodePrivate *	m_pEntryNode
	The node where a call entered the tree.
string2node_t *	m_pMap
	Holds the Node pointers referenced by NodeName.
NodePrivateVector_t *	m_pPollingNodes
	List of pointers to nodes which need to be polled.
GENICAM_NAMESPACE::gcstring	m_ProductGuid
	Guid describing the product.
GENICAM_NAMESPACE::gcstring_vector	m_PropertyNames
	A list with all properties set.
Version_t	m_SchemaVersion
	schema version number
GENAPI_NAMESPACE::EStandardNameSpace	m_StandardNameSpace
	standard name space
GENICAM_NAMESPACE::gcstring	m_ToolTip
	tool tip
GENICAM_NAMESPACE::gcstring	m_VendorName
	Get the vendor name.
GENICAM_NAMESPACE::gcstring	m_VersionGuid
	Guid describing the product version.
Private Member Functions
	CNodeMap (const CNodeMap &)
	forbidden copy constructor
CNodeMap &	operator= (const CNodeMap &)
	forbidden operator=
Interface IUserData
virtual UserData_t	GetUserData () const
virtual UserData_t	SetUserData (UserData_t userdata)
Private Attributes
UserData_t	m_pUserData
CLock	m_zzz_OwnLock_DoNotUse

Detailed Description

Hold a map of all nodes.

Definition at line 58 of file NodeMap.h.

Member Typedef Documentation

typedef std::vector<INodePrivate*> GENAPI_NAMESPACE::CNodeMap::Node2NodeID_t [protected]

Holds the Node pointers referenced by NodeID.

Definition at line 180 of file NodeMap.h.

Constructor & Destructor Documentation

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

Constructor.

virtual GENAPI_NAMESPACE::CNodeMap::~CNodeMap ( ) [protected, virtual]

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

GENAPI_NAMESPACE::CNodeMap::CNodeMap ( const CNodeMap & ) [private]

forbidden copy constructor

Member Function Documentation

INodePrivate* GENAPI_NAMESPACE::CNodeMap::_GetNodeByID ( NodeID_t NodeID ) [inline]

Definition at line 131 of file NodeMap.h.

void GENAPI_NAMESPACE::CNodeMap::ClearAllNodes ( ) [protected]

Clear the map.

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

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

virtual void GENAPI_NAMESPACE::CNodeMap::Destroy ( ) [virtual]

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

virtual Counter& GENAPI_NAMESPACE::CNodeMap::GetBathometer ( ) [inline, virtual]

Definition at line 95 of file NodeMap.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual UserData_t GENAPI_NAMESPACE::CNodeMap::GetUserData ( ) const [private, virtual]

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

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

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

virtual bool GENAPI_NAMESPACE::CNodeMap::IsGenApiDeviceLoggingEnabled ( ) [virtual]

virtual bool GENAPI_NAMESPACE::CNodeMap::IsGenApiLoggingEnabled ( ) [virtual]

string2node_t& GENAPI_NAMESPACE::CNodeMap::Map ( ) [protected]

Retrieve the map.

const string2node_t& GENAPI_NAMESPACE::CNodeMap::Map ( ) const [protected]

Retrieve the map.

CNodeMap& GENAPI_NAMESPACE::CNodeMap::operator= ( const CNodeMap & ) [private]

forbidden operator=

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

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

virtual void GENAPI_NAMESPACE::CNodeMap::ResetEntryPoint ( ) [virtual]

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

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

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

virtual UserData_t GENAPI_NAMESPACE::CNodeMap::SetUserData ( UserData_t userdata ) [private, virtual]

Member Data Documentation

Counter GENAPI_NAMESPACE::CNodeMap::m_Bathometer [protected]

counts the depth of SetValue call-chains

Definition at line 207 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_DeviceName [protected]

The name of the device.

Definition at line 170 of file NodeMap.h.

Version_t GENAPI_NAMESPACE::CNodeMap::m_DeviceVersion [protected]

device description file's version number

Definition at line 158 of file NodeMap.h.

EMethod GENAPI_NAMESPACE::CNodeMap::m_EntryMethod [protected]

The node where a call entered the tree.

Definition at line 213 of file NodeMap.h.

int GENAPI_NAMESPACE::CNodeMap::m_EntryPointDepth [protected]

Number of call pairs to SetEntryPoint/ResetEntryPoint.

Definition at line 216 of file NodeMap.h.

bool GENAPI_NAMESPACE::CNodeMap::m_EntryPointIgnoreCache [protected]

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

Definition at line 219 of file NodeMap.h.

bool GENAPI_NAMESPACE::CNodeMap::m_GenApiDeviceLoggingEnabled [protected]

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

Definition at line 228 of file NodeMap.h.

bool GENAPI_NAMESPACE::CNodeMap::m_GenApiLoggingEnabled [protected]

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

Definition at line 225 of file NodeMap.h.

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 242 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ModelName [protected]

model name

Definition at line 143 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_Name [protected]

Dummy name, used only for loading.

Definition at line 173 of file NodeMap.h.

Node2NodeID_t GENAPI_NAMESPACE::CNodeMap::m_Node2NodeID [protected]

Definition at line 181 of file NodeMap.h.

const INodePrivate* GENAPI_NAMESPACE::CNodeMap::m_pEntryNode [protected]

The node where a call entered the tree.

Definition at line 210 of file NodeMap.h.

string2node_t* GENAPI_NAMESPACE::CNodeMap::m_pMap [protected]

Holds the Node pointers referenced by NodeName.

Definition at line 184 of file NodeMap.h.

NodePrivateVector_t* GENAPI_NAMESPACE::CNodeMap::m_pPollingNodes [protected]

List of pointers to nodes which need to be polled.

Definition at line 222 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ProductGuid [protected]

Guid describing the product.

Definition at line 161 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring_vector GENAPI_NAMESPACE::CNodeMap::m_PropertyNames [protected]

A list with all properties set.

Definition at line 167 of file NodeMap.h.

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 237 of file NodeMap.h.

Version_t GENAPI_NAMESPACE::CNodeMap::m_SchemaVersion [protected]

schema version number

Definition at line 155 of file NodeMap.h.

GENAPI_NAMESPACE::EStandardNameSpace GENAPI_NAMESPACE::CNodeMap::m_StandardNameSpace [protected]

standard name space

Definition at line 152 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_ToolTip [protected]

tool tip

Definition at line 149 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_VendorName [protected]

Get the vendor name.

Definition at line 146 of file NodeMap.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CNodeMap::m_VersionGuid [protected]

Guid describing the product version.

Definition at line 164 of file NodeMap.h.

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 233 of file NodeMap.h.

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

NodeMap.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation