Class SpinnakerNET::GenApi::NodeMap¶

ClassList > SpinnakerNET > GenApi > NodeMap

NodeMap containing all nodes of an XML description.

#include <NodeMap.h>

Inherits the following classes: Helper::NodeEnumerableFactory, SpinnakerNET::GenApi::INodeMap, SpinnakerNET::GenApi::IDeviceInfo

Public Attributes¶

Type	Name
property int	Count = `/* multi line expression /` Gets the number of nodes in the node map.*
property SpinnakerNET::GenApi::Version	DeviceVersion = `/* multi line expression /` Get the* SpinnakerNET::GenApi::Version of the device description file.
property bool	Disposed = `/* multi line expression /` Gets or sets whether this object has been disposed or not.*
property __int16	GenApiBuild = `/* multi line expression /` Gets the build number of the DLL's* GenApi implementation.
property SpinnakerNET::GenApi::Version	GenApiVersion = `/* multi line expression /` Get the* SpinnakerNET::GenApi::Version of the DLL'sGenApi implementation.
property bool	IsReadOnly = `/* multi line expression /` Gets whether this collection is read-only.*
property ICollection< System::String^>	Keys = `/* multi line expression /` Gets the collection containing all node names.*
property System::String	ModelName = `/* multi line expression /` Get the model name.*
where	NodeType Gets the `INode` with the given__name and casts it to`NodeType` .
property System::String	ProductGuid = `/* multi line expression /` Get the GUID describing the product.*
property SpinnakerNET::GenApi::Version	SchemaVersion = `/* multi line expression /` Get the schema* SpinnakerNET::GenApi::Version number.
property System::String	StandardNameSpace = `/* multi line expression /` Get the standard name space.*
property System::String	ToolTip = `/* multi line expression /` Get tool tip.*
property ICollection< SpinnakerNET::GenApi::INode^>	Values = `/* multi line expression /` Gets the collection containing all nodes.*
property System::String	VendorName = `/* multi line expression /` Get the vendor name.*
property System::String	VersionGuid = `/* multi line expression /` Get the GUID describing the product* SpinnakerNET::GenApi::Version .
property SpinnakerNET::GenApi::INode	default = `/* multi line expression /` Gets the node with the name given in* key . Set is not supported and results in an exception.

Public Attributes inherited from SpinnakerNET::GenApi::INodeMap¶

See SpinnakerNET::GenApi::INodeMap

Type	Name
where	NodeType Gets the `INode` with the given__name and casts it to`NodeType` .

Public Attributes inherited from SpinnakerNET::GenApi::IDeviceInfo¶

See SpinnakerNET::GenApi::IDeviceInfo

Type	Name
property SpinnakerNET::GenApi::Version	DeviceVersion = `/* multi line expression /` Get the* SpinnakerNET::GenApi::Version of the device description file.
property __int16	GenApiBuild = `/* multi line expression /` Gets the build number of the DLL's* GenApi implementation.
property SpinnakerNET::GenApi::Version	GenApiVersion = `/* multi line expression /` Get the* SpinnakerNET::GenApi::Version of the DLL'sGenApi implementation.
property::System::String	ModelName = `/* multi line expression /` Get the model name.*
property::System::String	ProductGuid = `/* multi line expression /` Get the GUID describing the product.*
property SpinnakerNET::GenApi::Version	SchemaVersion = `/* multi line expression /` Get the schema* SpinnakerNET::GenApi::Version number.
property::System::String	StandardNameSpace = `/* multi line expression /` Get the standard name space.*
property::System::String	ToolTip = `/* multi line expression /` Get tool tip.*
property::System::String	VendorName = `/* multi line expression /` Get the vendor name.*
property::System::String	VersionGuid = `/* multi line expression /` Get the GUID describing the product* SpinnakerNET::GenApi::Version .

Public Functions¶

Type	Name
virtual void	Add (System::String ^ key, SpinnakerNET::GenApi::INode ^ value) Not supported.
virtual void	Add (KeyValuePair< System::String^, SpinnakerNET::GenApi::INode^> item) Not supported.
virtual void	Clear (void) Not supported.
virtual void __clrcall	Connect (Port ^ port) Connects the given port to the node with the name 'Device'.
virtual void __clrcall	Connect (Port ^ port, System::String ^ name) Connects the given port to the node with the given__name .
virtual bool	Contains (KeyValuePair< System::String^, SpinnakerNET::GenApi::INode^> item) Determines whether the node map contains a specific node name/node pair.
virtual bool	ContainsKey (System::String ^ key) Determines whether the node map contains the given node name.
virtual void	CopyTo (array< KeyValuePair< System::String^, SpinnakerNET::GenApi::INode^> > ^ target, int arrayIndex) Copies the elements of the node map to an array in target , starting at a particular__arrayIndex .
virtual void __clrcall	InvalidateNodes (void) Invalidate all nodes.
virtual void __clrcall	LoadXMLFromString (System::String ^ xml) Creates a `NodeMap` from an XML document in the__xml __`System.System::String` .
__clrcall	NodeMap (void) Default constructor creating an empty `NodeMap` .
virtual void __clrcall	Poll (__int64 elapsedTime) Invalidates all due pollable nodes.
virtual bool	Remove (System::String ^ key) Not supported.
virtual bool	Remove (KeyValuePair< System::String^, SpinnakerNET::GenApi::INode^> item) Not supported.
virtual bool	TryGetValue (System::String ^ key, SpinnakerNET::GenApi::INode ^% value) Gets the `INode` with the given node name.
void	set (System::String ^ key, SpinnakerNET::GenApi::INode ^ value)
virtual __clrcall	~NodeMap (void) Clean up any resources being used deterministically.

Public Functions inherited from SpinnakerNET::GenApi::INodeMap¶

See SpinnakerNET::GenApi::INodeMap

Type	Name
void __clrcall	Connect (Port ^ port) Connects the given port to the node with the name 'Device'.
void __clrcall	Connect (Port ^ port, System::String ^ name) Connects the given port to the node with the given__name .
void __clrcall	InvalidateNodes (void) Invalidate all nodes.
void __clrcall	Poll (__int64 elapsedTime) Invalidates all due pollable nodes.

Protected Functions¶

Type	Name
virtual System::Collections::Generic::IEnumerator< KeyValuePair< System::String^, SpinnakerNET::GenApi::INode^> >	DoGetEnumerator () override

Public Attributes Documentation¶

variable Count¶

Gets the number of nodes in the node map.

virtual property int SpinnakerNET::GenApi::NodeMap::Count;

Number of elements in the node map

variable DeviceVersion¶

Get the SpinnakerNET::GenApi::Version of the device description file.

virtual property SpinnakerNET::GenApi::Version SpinnakerNET::GenApi::NodeMap::DeviceVersion;

variable Disposed¶

Gets or sets whether this object has been disposed or not.

property bool SpinnakerNET::GenApi::NodeMap::Disposed;

true if this object has been disposed; false otherwise.

variable GenApiBuild¶

Gets the build number of the DLL's GenApi implementation.

virtual property __int16 SpinnakerNET::GenApi::NodeMap::GenApiBuild;

variable GenApiVersion¶

Get the SpinnakerNET::GenApi::Version of the DLL'sGenApi implementation.

virtual property SpinnakerNET::GenApi::Version SpinnakerNET::GenApi::NodeMap::GenApiVersion;

variable IsReadOnly¶

Gets whether this collection is read-only.

virtual property bool SpinnakerNET::GenApi::NodeMap::IsReadOnly;

Always true

variable Keys¶

Gets the collection containing all node names.

virtual property ICollection<System::String^> SpinnakerNET::GenApi::NodeMap::Keys;

Collection containing all fully qualified names known to the NodeMap.

variable ModelName¶

Get the model name.

virtual property System::String SpinnakerNET::GenApi::NodeMap::ModelName;

variable NodeType¶

Gets the INode with the given__name and casts it toNodeType .

where SpinnakerNET::GenApi::NodeMap::NodeType;

Parameters:

name Name of the INode to be retrieved.

variable ProductGuid¶

Get the GUID describing the product.

virtual property System::String SpinnakerNET::GenApi::NodeMap::ProductGuid;

variable SchemaVersion¶

Get the schema SpinnakerNET::GenApi::Version number.

virtual property SpinnakerNET::GenApi::Version SpinnakerNET::GenApi::NodeMap::SchemaVersion;

variable StandardNameSpace¶

Get the standard name space.

virtual property System::String SpinnakerNET::GenApi::NodeMap::StandardNameSpace;

Get tool tip.

virtual property System::String SpinnakerNET::GenApi::NodeMap::ToolTip;

variable Values¶

Gets the collection containing all nodes.

virtual property ICollection<SpinnakerNET::GenApi::INode^> SpinnakerNET::GenApi::NodeMap::Values;

Collection containing all INode objects known to the NodeMap.

variable VendorName¶

Get the vendor name.

virtual property System::String SpinnakerNET::GenApi::NodeMap::VendorName;

variable VersionGuid¶

Get the GUID describing the product SpinnakerNET::GenApi::Version .

virtual property System::String SpinnakerNET::GenApi::NodeMap::VersionGuid;

variable default¶

Gets the node with the name given in key . Set is not supported and results in an exception.

virtual property SpinnakerNET::GenApi::INode SpinnakerNET::GenApi::NodeMap::default[System::String^];

INode object associated with the given name.

Public Functions Documentation¶

function Add [1/2]¶

Not supported.

virtual void SpinnakerNET::GenApi::NodeMap::Add (
    System::String ^ key,
    SpinnakerNET::GenApi::INode ^ value
)

Parameters:

key Node name.
value Node object.

function Add [2/2]¶

Not supported.

virtual void SpinnakerNET::GenApi::NodeMap::Add (
    KeyValuePair < System::String^, SpinnakerNET::GenApi::INode ^> item
)

Parameters:

item Node name and object pair.

function Clear¶

Not supported.

virtual void SpinnakerNET::GenApi::NodeMap::Clear (
    void
)

function Connect [1/2]¶

Connects the given port to the node with the name 'Device'.

virtual void  __clrcall SpinnakerNET::GenApi::NodeMap::Connect (
    Port ^ port
)

Parameters:

port Port object to be connected to device node.

Implements SpinnakerNET::GenApi::INodeMap::Connect

function Connect [2/2]¶

Connects the given port to the node with the given__name .

virtual void  __clrcall SpinnakerNET::GenApi::NodeMap::Connect (
    Port ^ port,
    System::String ^ name
)

Parameters:

port Port object to be connected.
name Name of the port Node to be connected.

Implements SpinnakerNET::GenApi::INodeMap::Connect

function Contains¶

Determines whether the node map contains a specific node name/node pair.

virtual bool SpinnakerNET::GenApi::NodeMap::Contains (
    KeyValuePair < System::String^, SpinnakerNET::GenApi::INode ^> item
)

Parameters:

item Node name and object pair.

Returns:

true if the node map contains a name/INode pair; false otherwise.

function ContainsKey¶

Determines whether the node map contains the given node name.

virtual bool SpinnakerNET::GenApi::NodeMap::ContainsKey (
    System::String ^ key
)

Parameters:

key Node name.

Returns:

true if the node map contains an INode with the given name; false otherwise.

function CopyTo¶

Copies the elements of the node map to an array in target , starting at a particular__arrayIndex .

virtual void SpinnakerNET::GenApi::NodeMap::CopyTo (
    array < KeyValuePair < System::String^, SpinnakerNET::GenApi::INode ^> > ^ target,
    int arrayIndex
)

Parameters:

target One-dimensional Array that is the destination. Array must have zero-based indexing.
arrayIndex Zero-base index in target at which copying begins.

function InvalidateNodes¶

Invalidate all nodes.

virtual void  __clrcall SpinnakerNET::GenApi::NodeMap::InvalidateNodes (
    void
)

Implements SpinnakerNET::GenApi::INodeMap::InvalidateNodes

function LoadXMLFromString¶

Creates a NodeMap from an XML document in the__xml __System.System::String .

virtual void  __clrcall SpinnakerNET::GenApi::NodeMap::LoadXMLFromString (
    System::String ^ xml
)

Parameters:

xml Contains the XML document.

function NodeMap¶

Default constructor creating an empty NodeMap .

__clrcall SpinnakerNET::GenApi::NodeMap::NodeMap (
    void
)

function Poll¶

Invalidates all due pollable nodes.

virtual void  __clrcall SpinnakerNET::GenApi::NodeMap::Poll (
    __int64 elapsedTime
)

Parameters:

elapsedTime Elapsed time since last call in ms.

Implements SpinnakerNET::GenApi::INodeMap::Poll

function Remove [1/2]¶

Not supported.

virtual bool SpinnakerNET::GenApi::NodeMap::Remove (
    System::String ^ key
)

Parameters:

key Node name.

Returns:

true if the INode with the given name was successfully removed; false otherwise.

function Remove [2/2]¶

Not supported.

virtual bool SpinnakerNET::GenApi::NodeMap::Remove (
    KeyValuePair < System::String^, SpinnakerNET::GenApi::INode ^> item
)

Parameters:

item Node name and object pair.

Returns:

true if the name/INode pair could be successfully removed; false otherwise.

function TryGetValue¶

Gets the INode with the given node name.

virtual bool SpinnakerNET::GenApi::NodeMap::TryGetValue (
    System::String ^ key,
    SpinnakerNET::GenApi::INode ^% value
)

Parameters:

key Node name.
value If the key was found, the value contains the associated INode object; null otherwise.

Returns:

true if the node map contains an INode with the given name; false otherwise.

function set¶

void SpinnakerNET::GenApi::NodeMap::set (
    System::String ^ key,
    SpinnakerNET::GenApi::INode ^ value
)

function ~NodeMap¶

Clean up any resources being used deterministically.

virtual __clrcall SpinnakerNET::GenApi::NodeMap::~NodeMap (
    void
)

Protected Functions Documentation¶

function DoGetEnumerator¶

virtual System::Collections::Generic::IEnumerator< KeyValuePair < System::String^, SpinnakerNET::GenApi::INode ^> > SpinnakerNET::GenApi::NodeMap::DoGetEnumerator () override

The documentation for this class was generated from the following file /workspace/src/SpinnakerNET/GenApiNet/NodeMap.h

Class SpinnakerNET::GenApi::NodeMap¶

Public Attributes¶

Public Attributes inherited from SpinnakerNET::GenApi::INodeMap¶

Public Attributes inherited from SpinnakerNET::GenApi::IDeviceInfo¶

Public Functions¶

Public Functions inherited from SpinnakerNET::GenApi::INodeMap¶

Protected Functions¶

Public Attributes Documentation¶

variable Count¶

variable DeviceVersion¶

variable Disposed¶

variable GenApiBuild¶

variable GenApiVersion¶

variable IsReadOnly¶

variable Keys¶

variable ModelName¶

variable NodeType¶

variable ProductGuid¶

variable SchemaVersion¶

variable StandardNameSpace¶

variable ToolTip¶

variable Values¶

variable VendorName¶

variable VersionGuid¶

variable default¶

Public Functions Documentation¶

function Add [1/2]¶

function Add [2/2]¶

function Clear¶

function Connect [1/2]¶

function Connect [2/2]¶

function Contains¶

function ContainsKey¶

function CopyTo¶

function InvalidateNodes¶

function LoadXMLFromString¶

function NodeMap¶

function Poll¶

function Remove [1/2]¶

function Remove [2/2]¶

function TryGetValue¶

function set¶

function ~NodeMap¶

Protected Functions Documentation¶

function DoGetEnumerator¶