Smart pointer template for NodeMaps with create function. More...

#include <NodeMap.h>

Inheritance diagram for NodeMap:

Public Member Functions
	NodeMap (GenICam::gcstring DeviceName="Device")
	Constructor.

virtual	~NodeMap ()
	Destructor.

void	Destroy ()
	Destroys the node map.

void	LoadXMLFromFile (GenICam::gcstring FileName)
	Creates the object from a XML file with given file name.

void	LoadXMLFromZIPFile (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 (GenICam::gcstring TargetFileName, 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)
	Gets a list of supported schema versions.

virtual GenICam::gcstring	GetDeviceName ()
	Get device name.

virtual void	Poll (int64_t ElapsedTime)
	Fires nodes which have a polling time.

virtual void	EnableAutoPoll (int64_t ElapsedTime)
	Enable automatic polling to fire nodes at regular intervals based on the specified polling duration.

virtual void	DisableAutoPoll ()
	Disable automatic polling to fire nodes at regular intervals.

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 CLock &	GetLock () const
	Returns the lock which guards the node map.

virtual uint64_t	GetNumNodes () const
	Get the number of nodes in the map.

void *	GetNodeMapHandle () const

virtual GenICam::gcstring	GetModelName ()
	Get the model name.

virtual GenICam::gcstring	GetVendorName ()
	Get the vendor name.

virtual GenICam::gcstring	GetToolTip ()
	Get tool tip.

virtual GenICam::gcstring	GetStandardNameSpace ()
	Get the standard name space.

virtual void	GetGenApiVersion (GenICam::Version_t &Version, uint16_t &Build)
	Get the version of the DLL's GenApi implementation.

virtual void	GetSchemaVersion (GenICam::Version_t &Version)
	Get the schema version number.

virtual void	GetDeviceVersion (GenICam::Version_t &Version)
	Get the version of the device description file.

virtual GenICam::gcstring	GetProductGuid ()
	Get the GUID describing the product.

virtual GenICam::gcstring	GetVersionGuid ()
	Get the GUID describing the product version.

Static Public Member Functions
static bool	ClearXMLCache ()
	Clears the cache of the camera description files.

Public Attributes
INodeMap *	_Ptr
	Pointer to the NodeMap.

Detailed Description

Smart pointer template for NodeMaps with create function.

Parameters

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

Examples: GigEVisionPerformance.cpp.

Constructor & Destructor Documentation

◆ NodeMap()

NodeMap ( GenICam::gcstring DeviceName = "Device" )

Constructor.

◆ ~NodeMap()

virtual ~NodeMap ( )

virtual

Destructor.

Member Function Documentation

◆ ClearXMLCache()

static bool ClearXMLCache ( )

static

Clears the cache of the camera description files.

◆ Connect() [1/2]

virtual bool Connect ( IPort * pPort ) const

virtual

Connects a port to the standard port "Device".

◆ Connect() [2/2]

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

virtual

Connects a port to a port node with given name.

◆ Destroy()

void Destroy ( )

Destroys the node map.

◆ DisableAutoPoll()

virtual void DisableAutoPoll ( )

virtual

Disable automatic polling to fire nodes at regular intervals.

◆ EnableAutoPoll()

virtual void EnableAutoPoll ( int64_t ElapsedTime )

virtual

Enable automatic polling to fire nodes at regular intervals based on the specified polling duration.

◆ GetDeviceName()

virtual GenICam::gcstring GetDeviceName ( )

virtual

Get device name.

◆ GetDeviceVersion()

virtual void GetDeviceVersion ( GenICam::Version_t & Version )

virtual

Get the version of the device description file.

◆ GetGenApiVersion()

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

virtual

Get the version of the DLL's GenApi implementation.

◆ GetLock()

virtual CLock & GetLock ( ) const

virtual

Returns the lock which guards the node map.

◆ GetModelName()

virtual GenICam::gcstring GetModelName ( )

virtual

Get the model name.

◆ GetNode()

virtual INode * GetNode ( const GenICam::gcstring & key ) const

virtual

Retrieves the node from the central map by name.

Examples: GigEVisionPerformance.cpp.

◆ GetNodeMapHandle()

void * GetNodeMapHandle ( ) const

◆ GetNodes()

virtual void GetNodes ( NodeList_t & Nodes ) const

virtual

Retrieves all nodes in the node map.

◆ GetNumNodes()

virtual uint64_t GetNumNodes ( ) const

virtual

Get the number of nodes in the map.

◆ GetProductGuid()

virtual GenICam::gcstring GetProductGuid ( )

virtual

Get the GUID describing the product.

◆ GetSchemaVersion()

virtual void GetSchemaVersion ( GenICam::Version_t & Version )

virtual

Get the schema version number.

◆ GetStandardNameSpace()

virtual GenICam::gcstring GetStandardNameSpace ( )

virtual

Get the standard name space.

◆ GetSupportedSchemaVersions()

virtual void GetSupportedSchemaVersions ( GenICam::gcstring_vector & SchemaVersions )

virtual

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

◆ GetToolTip()

virtual GenICam::gcstring GetToolTip ( )

virtual

Get tool tip.

◆ GetVendorName()

virtual GenICam::gcstring GetVendorName ( )

virtual

Get the vendor name.

◆ GetVersionGuid()

virtual GenICam::gcstring GetVersionGuid ( )

virtual

Get the GUID describing the product version.

◆ InvalidateNodes()

virtual void InvalidateNodes ( ) const

virtual

Invalidates all nodes.

◆ LoadXMLFromFile()

void LoadXMLFromFile ( GenICam::gcstring FileName )

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

◆ LoadXMLFromFileInject()

void LoadXMLFromFileInject	(	GenICam::gcstring	TargetFileName,
		GenICam::gcstring	InjectFileName
	)

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

◆ LoadXMLFromString()

void LoadXMLFromString ( const GenICam::gcstring & XMLData )

Creates the object from XML data given in a string.

◆ LoadXMLFromStringInject()

void LoadXMLFromStringInject	(	const GenICam::gcstring &	TargetXMLDataconst,
		const GenICam::gcstring &	InjectXMLData
	)

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

◆ LoadXMLFromZIPData()

void LoadXMLFromZIPData	(	const void *	zipData,
		size_t	zipSize
	)

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

◆ LoadXMLFromZIPFile()

void LoadXMLFromZIPFile ( GenICam::gcstring ZipFileName )

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

◆ Poll()

virtual void Poll ( int64_t ElapsedTime )

virtual

Fires nodes which have a polling time.

Member Data Documentation

◆ _Ptr

INodeMap* _Ptr

Pointer to the NodeMap.

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

include/SpinGenApi/NodeMap.h

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NodeMap()

◆ ~NodeMap()

Member Function Documentation

◆ ClearXMLCache()

◆ Connect() [1/2]

◆ Connect() [2/2]

◆ Destroy()

◆ DisableAutoPoll()

◆ EnableAutoPoll()

◆ GetDeviceName()

◆ GetDeviceVersion()

◆ GetGenApiVersion()

◆ GetLock()

◆ GetModelName()

◆ GetNode()

◆ GetNodeMapHandle()

◆ GetNodes()

◆ GetNumNodes()

◆ GetProductGuid()

◆ GetSchemaVersion()

◆ GetStandardNameSpace()

◆ GetSupportedSchemaVersions()

◆ GetToolTip()

◆ GetVendorName()

◆ GetVersionGuid()

◆ InvalidateNodes()

◆ LoadXMLFromFile()

◆ LoadXMLFromFileInject()

◆ LoadXMLFromString()

◆ LoadXMLFromStringInject()

◆ LoadXMLFromZIPData()

◆ LoadXMLFromZIPFile()

◆ Poll()

Member Data Documentation

◆ _Ptr