Class Spinnaker::GenApi::NodeMap¶

ClassList > GenApi > NodeMap

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

#include <NodeMap.h>

Inherits the following classes: INodeMap, IDeviceInfo

Inherited by the following classes: Spinnaker::GenApi::SpinTestCamera

Public Attributes¶

Type	Name
INodeMap *	_Ptr

Public Functions¶

Type	Name
virtual bool	Connect (IPort * pPort, const GenICam::gcstring & PortName) const
virtual bool	Connect (IPort * pPort) const
void	Destroy ()
virtual void	DisableAutoPoll ()
virtual void	EnableAutoPoll (int64_t ElapsedTime)
virtual GenICam::gcstring	GetDeviceName ()
virtual void	GetDeviceVersion (GenICam::Version_t & Version)
virtual void	GetGenApiVersion (GenICam::Version_t & Version, uint16_t & Build)
virtual CLock &	GetLock () const
virtual GenICam::gcstring	GetModelName ()
virtual INode *	GetNode (const GenICam::gcstring & key) const
void *	GetNodeMapHandle () const
virtual void	GetNodes (NodeList_t & Nodes) const
virtual uint64_t	GetNumNodes () const
virtual GenICam::gcstring	GetProductGuid ()
virtual void	GetSchemaVersion (GenICam::Version_t & Version)
virtual GenICam::gcstring	GetStandardNameSpace ()
virtual void	GetSupportedSchemaVersions (GenICam::gcstring_vector & SchemaVersions)
virtual GenICam::gcstring	GetToolTip ()
virtual GenICam::gcstring	GetVendorName ()
virtual GenICam::gcstring	GetVersionGuid ()
virtual void	InvalidateNodes () const
void	LoadXMLFromFile (GenICam::gcstring FileName)
void	LoadXMLFromFileInject (GenICam::gcstring TargetFileName, GenICam::gcstring InjectFileName)
void	LoadXMLFromString (const GenICam::gcstring & XMLData)
void	LoadXMLFromStringInject (const GenICam::gcstring & TargetXMLDataconst, const GenICam::gcstring & InjectXMLData)
void	LoadXMLFromZIPData (const void * zipData, size_t zipSize)
void	LoadXMLFromZIPFile (GenICam::gcstring ZipFileName)
	NodeMap (GenICam::gcstring DeviceName="Device")
virtual void	Poll (int64_t ElapsedTime)
virtual	~NodeMap ()

Public Static Functions¶

Type	Name
bool	ClearXMLCache ()

Detailed Description¶

Parameters:

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

Public Attributes Documentation¶

variable _Ptr¶

INodeMap* Spinnaker::GenApi::NodeMap::_Ptr;

Pointer to the NodeMap

Public Functions Documentation¶

function Connect [1/2]¶

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

Connects a port to a port node with given name

function Connect [2/2]¶

virtual bool GenApi::NodeMap::Connect (
    IPort * pPort
) const

Connects a port to the standard port "Device"

function Destroy¶

void GenApi::NodeMap::Destroy ()

Destroys the node map

function DisableAutoPoll¶

virtual void GenApi::NodeMap::DisableAutoPoll ()

Disable automatic polling to fire nodes at regular intervals.

function EnableAutoPoll¶

virtual void GenApi::NodeMap::EnableAutoPoll (
    int64_t ElapsedTime
)

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

function GetDeviceName¶

virtual GenICam::gcstring GenApi::NodeMap::GetDeviceName ()

Get device name

function GetDeviceVersion¶

virtual void GenApi::NodeMap::GetDeviceVersion (
    GenICam::Version_t & Version
)

Get the version of the device description file

function GetGenApiVersion¶

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

Get the version of the DLL's GenApi implementation

function GetLock¶

virtual CLock & GenApi::NodeMap::GetLock () const

Returns the lock which guards the node map

function GetModelName¶

virtual GenICam::gcstring GenApi::NodeMap::GetModelName ()

Get the model name

function GetNode¶

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

Retrieves the node from the central map by name

function GetNodeMapHandle¶

void * GenApi::NodeMap::GetNodeMapHandle () const

function GetNodes¶

virtual void GenApi::NodeMap::GetNodes (
    NodeList_t & Nodes
) const

Retrieves all nodes in the node map

function GetNumNodes¶

virtual uint64_t GenApi::NodeMap::GetNumNodes () const

Get the number of nodes in the map

function GetProductGuid¶

virtual GenICam::gcstring GenApi::NodeMap::GetProductGuid ()

Get the GUID describing the product

function GetSchemaVersion¶

virtual void GenApi::NodeMap::GetSchemaVersion (
    GenICam::Version_t & Version
)

Get the schema version number

function GetStandardNameSpace¶

virtual GenICam::gcstring GenApi::NodeMap::GetStandardNameSpace ()

Get the standard name space

function GetSupportedSchemaVersions¶

virtual void GenApi::NodeMap::GetSupportedSchemaVersions (
    GenICam::gcstring_vector & SchemaVersions
)

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

function GetToolTip¶

virtual GenICam::gcstring GenApi::NodeMap::GetToolTip ()

Get tool tip

function GetVendorName¶

virtual GenICam::gcstring GenApi::NodeMap::GetVendorName ()

Get the vendor name

function GetVersionGuid¶

virtual GenICam::gcstring GenApi::NodeMap::GetVersionGuid ()

Get the GUID describing the product version

function InvalidateNodes¶

virtual void GenApi::NodeMap::InvalidateNodes () const

Invalidates all nodes

function LoadXMLFromFile¶

void GenApi::NodeMap::LoadXMLFromFile (
    GenICam::gcstring FileName
)

Creates the object from a XML file with given file name

function LoadXMLFromFileInject¶

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

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

function LoadXMLFromString¶

void GenApi::NodeMap::LoadXMLFromString (
    const  GenICam::gcstring & XMLData
)

Creates the object from XML data given in a string

function LoadXMLFromStringInject¶

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

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

function LoadXMLFromZIPData¶

void GenApi::NodeMap::LoadXMLFromZIPData (
    const  void * zipData,
    size_t zipSize
)

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

function LoadXMLFromZIPFile¶

void GenApi::NodeMap::LoadXMLFromZIPFile (
    GenICam::gcstring ZipFileName
)

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

function NodeMap [1/2]¶

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

Constructor

function Poll¶

virtual void GenApi::NodeMap::Poll (
    int64_t ElapsedTime
)

Fires nodes which have a polling time

function ~NodeMap¶

virtual GenApi::NodeMap::~NodeMap ()

Destructor

Public Static Functions Documentation¶

function ClearXMLCache¶

static bool GenApi::NodeMap::ClearXMLCache ()

Clears the cache of the camera description files

The documentation for this class was generated from the following file C:/workspace/include/SpinGenApi/NodeMap.h