Class SpinnakerNET::GenApi::PortNode¶

ClassList > SpinnakerNET > GenApi > PortNode

Node object representing a port node.

#include <Port.h>

Inherits the following classes: SpinnakerNET::GenApi::Node, SpinnakerNET::GenApi::IPort

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

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for this`Node` .
property SpinnakerNET::GenApi::INode	Alias = `/* multi line expression /` Gets all the node that represents the same value in a different way.*
property SpinnakerNET::GenApi::CachingMode	CachingMode = `/* multi line expression /` Gets the* `CachingMode` of this node.
property array< SpinnakerNET::GenApi::INode ^>	Children = `/* multi line expression /` Gets all child nodes.*
property System::String	Description = `/* multi line expression /` Gets the descriptive text of this node.*
property System::String	DisplayName = `/* multi line expression /` Gets the name which is to be displayed in a UI.*
property bool	Disposed = `/* multi line expression /` Gets or sets whether this* `Node` has been disposed.
property System::String	EventID = `/* multi line expression /` Gets the event ID of the event this node is associated with.*
property array< SpinnakerNET::GenApi::INode ^>	InvalidatingChildren = `/* multi line expression /` Gets all child nodes.*
property bool	IsAvailable = `/* multi line expression /` Gets whether this* `Node` is available.
property bool	IsCachable = `/* multi line expression /` Gets whether this node is cacheable.*
property bool	IsFeature = `/* multi line expression /` Gets whether this node is a feature.*
property bool	IsImplemented = `/* multi line expression /` Gets whether this* `Node` is implemented.
property bool	IsReadable = `/* multi line expression /` Gets whether this* `Node` is readable.
property bool	IsRegister = `/* multi line expression /` Gets whether this* `Node` is a register node.
property bool	IsSelector = `/* multi line expression /` Gets whether this node is a selector node.*
property bool	IsStreamable = `/* multi line expression /` Gets whether this node is intended to be savable or loadable.*
property bool	IsWritable = `/* multi line expression /` Gets whether this* `Node` is writable.
property array< SpinnakerNET::GenApi::INode ^>	LockNodes = `/* multi line expression /` Gets all locked nodes.*
property System::String	Name = `/* multi line expression /` Gets the short name of this node.*
property SpinnakerNET::GenApi::NameSpace	NameSpace = `/* multi line expression /` Gets the namespace this node resides in.*
property SpinnakerNET::GenApi::NodeMap	NodeMap = `/* multi line expression /` Gets or sets the* `NodeMap` of this`Node` .
property array< SpinnakerNET::GenApi::INode ^>	Parents = `/* multi line expression /` Gets all locked nodes.*
property __int64	PollingTime = `/* multi line expression /` Gets the time when this node should be reread (invalidated).*
property System::String	QualifiedName = `/* multi line expression /` Gets the full name of this node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectedFeatures = `/* multi line expression /` Gets all feature nodes which are affected by this selected node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectingFeatures = `/* multi line expression /` Gets all selector nodes which select this feature.*
property System::String	ToolTip = `/* multi line expression /` Gets the tool-tip of this node.*
property SpinnakerNET::GenApi::Visibility	Visibility = `/* multi line expression /` Gets the* `Visibility` of this node.

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

See SpinnakerNET::GenApi::INode

Type	Name
property SpinnakerNET::GenApi::INode	Alias = `/* multi line expression /` Gets all the node that represents the same value in a different way.*
property SpinnakerNET::GenApi::CachingMode	CachingMode = `/* multi line expression /` Gets the* `CachingMode` of this node.
property array< SpinnakerNET::GenApi::INode ^>	Children = `/* multi line expression /` Gets all child nodes.*
property System::String	Description = `/* multi line expression /` Gets the descriptive text of this node.*
property System::String	DisplayName = `/* multi line expression /` Gets the name which is to be displayed in a UI.*
property System::String	EventID = `/* multi line expression /` Gets the event ID of the event this node is associated with.*
property bool	IgnoreCache Gets or sets whether this `Node` should be read ignoring any caches.
property array< SpinnakerNET::GenApi::INode ^>	InvalidatingChildren = `/* multi line expression /` Gets all InvalidatingChildren nodes.*
property bool	IsAvailable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is available.
property bool	IsCachable = `/* multi line expression /` Gets whether this node is cacheable.*
property bool	IsFeature = `/* multi line expression /` Gets whether this node is a supported feature.*
property bool	IsImplemented = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is implemented.
property bool	IsReadable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is readable.
property bool	IsRegister = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is a register node.
property bool	IsStreamable = `/* multi line expression /` Gets whether this node is intended to be savable or loadable.*
property bool	IsWritable = `{ [bool](namespaceSpinnakerNET.md#function-node_cast) [\_\_clrcall](namespaceSpinnakerNET.md#function-node_cast) [get](namespaceSpinnakerNET.md#function-node_cast)([void](namespaceSpinnakerNET.md#function-node_cast))` Gets whether this `Node` is writable.
property array< SpinnakerNET::GenApi::INode ^>	LockNodes = `/* multi line expression /` Gets all locked nodes.*
property System::String	Name = `/* multi line expression /` Gets the short name of this node.*
property SpinnakerNET::GenApi::NameSpace	NameSpace = `/* multi line expression /` Gets the namespace this node resides in.*
property SpinnakerNET::GenApi::NodeMap	NodeMap = `/* multi line expression /` Gets the* `NodeMap` of this`Node` .
property array< SpinnakerNET::GenApi::INode ^>	Parents = `/* multi line expression /` Gets all InvalidatingChildren nodes.*
property __int64	PollingTime = `/* multi line expression /` Gets the time when this node should be reread (invalidated).*
property System::Collections::Generic::Dictionary< System::String^, Property^>	Properties = `/* multi line expression /` Gets all properties set during initialization. These are the underlying feature node connections.*
property System::String	QualifiedName = `/* multi line expression /` Gets the full name of this node.*
property System::String	ToolTip = `/* multi line expression /` Gets the tool-tip of this node.*
event NodeEventHandler	Updated Event for notification on status changes.
property bool	VerifyRead Gets or sets whether this `Node` should verify the values being read.
property bool	VerifyWrite Gets or sets whether this `Node` should verify the values being written.
property SpinnakerNET::GenApi::Visibility	Visibility = `/* multi line expression /` Gets the* `Visibility` of this node.

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

See SpinnakerNET::GenApi::ISelector

Type	Name
property bool	IsSelector = `/* multi line expression /` Gets whether this node is a selector node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectedFeatures = `/* multi line expression /` Gets all feature nodes which are affected by this selected node.*
property array< SpinnakerNET::GenApi::IValue^>	SelectingFeatures = `/* multi line expression /` Gets all selector nodes which select this feature.*

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

See SpinnakerNET::GenApi::IBase

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for the`Node` .

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

See SpinnakerNET::GenApi::IBase

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for the`Node` .

Public Functions¶

Type	Name
virtual void __clrcall	FromString (System::String ^ value) Called by the `Node.FromString` method to parse the given__value . If the parsing succeeds the value is written to this`Integer` .
__clrcall	PortNode (SpinnakerNET::GenApi::NodeMap ^ map, System::IntPtr handle) Initializes all member fields of this `PortNode` .
__clrcall	PortNode (SpinnakerNET::GenApi::INode ^ obj) Creates an `PortNode` from a`Node` object when possible.
virtual void __clrcall	Read (System::IntPtr buffer, __int64 address, __int64 length) Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
virtual void __clrcall	Read (__int64 address, array< System::Byte > ^ buffer) Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
virtual System::String __clrcall	ToString (void) override Called by the `Node.ToString` method to return a`System.System::String` representation of this`Integer` __
virtual void __clrcall	Write (System::IntPtr buffer, __int64 address, __int64 length) Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
virtual void __clrcall	Write (__int64 address, array< System::Byte > ^ buffer) Writes buffer .Length bytes to__address of this`Port` from the given__buffer .
virtual __clrcall	~PortNode (void) Destroys this `PortNode` and frees managed and unmanaged resources if needed.

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

See SpinnakerNET::GenApi::Node

Type	Name
virtual void __clrcall	ImposeAccessMode (SpinnakerNET::GenApi::AccessMode accessMode) Overwrites the XML access mode of this node.
virtual void __clrcall	ImposeVisibility (SpinnakerNET::GenApi::Visibility visibility) Overwrites the XML visibility of this node.
virtual void __clrcall	Invalidate (void) Invalidates the node so that the value is reread from the device.
virtual bool __clrcall	IsVisible (SpinnakerNET::GenApi::Visibility reference) Gets whether this `Node` is visible compared to the__reference visibility.
__clrcall	Node (NodeMap ^ map, System::IntPtr handle) Initializes all member fields of this `Node` as a top level node.
virtual __clrcall	~Node (void) Destroys this `Node` and frees managed and unmanaged resources.

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

See SpinnakerNET::GenApi::INode

Type	Name
void __clrcall	ImposeAccessMode (SpinnakerNET::GenApi::AccessMode accessMode) Overwrites the XML access mode of this node.
void __clrcall	ImposeVisibility (SpinnakerNET::GenApi::Visibility visibility) Overwrites the XML visibility of this node.
void __clrcall	Invalidate (void) Invalidates the node so that the value is reread from the device.
bool __clrcall	IsVisible (SpinnakerNET::GenApi::Visibility reference) Gets whether this `Node` is visible compared to the__reference visibility.

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

See SpinnakerNET::GenApi::IPort

Type	Name
void	Read (System::IntPtr buffer, __int64 address, __int64 length) Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
void	Read (__int64 address, array< System::Byte > ^ buffer) Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
void	Write (System::IntPtr buffer, __int64 address, __int64 length) Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
void	Write (__int64 address, array< System::Byte > ^ buffer) Writes buffer .Length bytes to__address of this`Port` from the given__buffer .

Protected Attributes inherited from SpinnakerNET::GenApi::Node¶

See SpinnakerNET::GenApi::Node

Type	Name
property System::IntPtr	Handle = `/* multi line expression /` Gets or sets the handle to the unmanaged* `GenApi::INode` object.
property bool	IgnoreCache Gets or sets whether this `Node` should be read ignoring any caches.
property System::Collections::Generic::Dictionary< System::String^, Property^>	Properties = `/* multi line expression /` Gets all properties set during initialization. These are the underlying feature node connections.*
event NodeEventHandler	Updated = `/* multi line expression /` Event for notification on status changes.*
property bool	VerifyRead Gets or sets whether this `Node` should verify the values being read.
property bool	VerifyWrite Gets or sets whether this `Node` should verify the values being written.

Protected Functions inherited from SpinnakerNET::GenApi::Node¶

See SpinnakerNET::GenApi::Node

Type	Name
virtual void __clrcall	CheckStatus (void) Checks if the object status is valid (not disposed and node map valid).
virtual void	raise (SpinnakerNET::GenApi::INode ^ node)
virtual void	remove (NodeEventHandler ^ handler)
void __clrcall	set (SpinnakerNET::GenApi::NodeMap ^ map)
void __clrcall	set (bool disposed)
void __clrcall	set (System::IntPtr handle)

Public Functions Documentation¶

function FromString¶

Called by the Node.FromString method to parse the given__value . If the parsing succeeds the value is written to thisInteger .

virtual void  __clrcall SpinnakerNET::GenApi::PortNode::FromString (
    System::String ^ value
)

Parameters:

value Text to be parsed.

function PortNode [1/2]¶

Initializes all member fields of this PortNode .

__clrcall SpinnakerNET::GenApi::PortNode::PortNode (
    SpinnakerNET::GenApi::NodeMap ^ map,
    System::IntPtr handle
)

Parameters:

map SpinnakerNET::GenApi::NodeMap which holds this node.
handle GenApi::IPort handle from which this Node is built.

function PortNode [2/2]¶

Creates an PortNode from aNode object when possible.

__clrcall SpinnakerNET::GenApi::PortNode::PortNode (
    SpinnakerNET::GenApi::INode ^ obj
)

Parameters:

obj Object to create PortNode from.

function Read [1/2]¶

Reads length bytes from__address of thisPort to the preallocated memory at__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::PortNode::Read (
    System::IntPtr buffer,
    __int64 address,
    __int64 length
)

Parameters:

buffer Pointer to the preallocated memory chunk of at least length bytes.
address Register address to access. Must be multiples of four.
length Number of bytes to be read from Port. Must be multiples of four.

Implements SpinnakerNET::GenApi::IPort::Read

function Read [2/2]¶

Reads buffer .Length bytes from__address of thisPort to the given__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::PortNode::Read (
    __int64 address,
    array < System::Byte > ^ buffer
)

Parameters:

address Register address to access. Must be multiples of four.
buffer Array to which the data is written to. Length must be multiples of four.

Implements SpinnakerNET::GenApi::IPort::Read

function ToString¶

Called by the Node.ToString method to return aSystem.System::String representation of thisInteger __

virtual System::String __clrcall SpinnakerNET::GenApi::PortNode::ToString (
    void
) override

Returns:

System.System::String containing the value of this node.

function Write [1/2]¶

Writes length bytes to__address of thisPort from the preallocated memory at__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::PortNode::Write (
    System::IntPtr buffer,
    __int64 address,
    __int64 length
)

Parameters:

buffer Pointer to the preallocated memory chunk of at least length bytes.
address Register address to access. Must be multiples of four.
length Number of bytes to be written to Port. Must be multiples of four.

Implements SpinnakerNET::GenApi::IPort::Write

function Write [2/2]¶

Writes buffer .Length bytes to__address of thisPort from the given__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::PortNode::Write (
    __int64 address,
    array < System::Byte > ^ buffer
)

Parameters:

address Register address to access. Must be multiples of four.
buffer Array from which the data is written. Length must be multiples of four.

Implements SpinnakerNET::GenApi::IPort::Write

function ~PortNode¶

Destroys this PortNode and frees managed and unmanaged resources if needed.

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

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