Skip to content

Interface SpinnakerNET::GenApi::IRegister

ClassList > SpinnakerNET > GenApi > IRegister

Register interface only containing register methods.

  • #include <Register.h>

Inherits the following classes: SpinnakerNET::GenApi::IValue

Inherited by the following classes: SpinnakerNET::GenApi::Register

Public Attributes

Type Name
property __int64 Address = /* multi line expression */
Gets the address of this register.
property __int64 Length = /* multi line expression */
Gets the number of bytes this register consists of.

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 thisNode .
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 theNode .

Public Functions

Type Name
void __clrcall Read (IntPtr buffer, __int64 length)
Reads length bytes from this register of thisPort to the preallocated memory at__buffer .
void __clrcall Read (array< System::Byte > ^% buffer)
Reads Length bytes from this register of thisPort to the__buffer .
void __clrcall Write (IntPtr buffer, __int64 length)
Writes length bytes to this register of thisPort from the preallocated memory at__buffer .
void __clrcall Write (array< System::Byte > ^ buffer)
Writes buffer .Length bytes to this register of thisPort from the__buffer .

Public Functions inherited from SpinnakerNET::GenApi::IValue

See SpinnakerNET::GenApi::IValue

Type Name
void __clrcall FromString (System::String ^ value)
Sets the value in this Node to the value given in__value .

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 Attributes Documentation

variable Address

Gets the address of this register. 

property __int64 SpinnakerNET::GenApi::IRegister::Address;

Register address.

variable Length

Gets the number of bytes this register consists of. 

property __int64 SpinnakerNET::GenApi::IRegister::Length;

Number of bytes.

Public Functions Documentation

function Read [1/2]

Reads length bytes from this register of thisPort to the preallocated memory at__buffer . 

void  __clrcall SpinnakerNET::GenApi::IRegister::Read (
    IntPtr buffer,
    __int64 length
)

Parameters:

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

function Read [2/2]

Reads Length bytes from this register of thisPort to the__buffer . 

void  __clrcall SpinnakerNET::GenApi::IRegister::Read (
    array < System::Byte > ^% buffer
)

Parameters:

  • buffer Array containing the data of this register.

function Write [1/2]

Writes length bytes to this register of thisPort from the preallocated memory at__buffer . 

void  __clrcall SpinnakerNET::GenApi::IRegister::Write (
    IntPtr buffer,
    __int64 length
)

Parameters:

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

function Write [2/2]

Writes buffer .Length bytes to this register of thisPort from the__buffer . 

void  __clrcall SpinnakerNET::GenApi::IRegister::Write (
    array < System::Byte > ^ buffer
)

Parameters:

  • buffer Array where the data is written from. Length must multiples of four.

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