PortNode Class Reference

Port nodes are the connection to the remote device. More...

Inherits Node, and IPortNode.

Public Member Functions
void	Read (long address, IntPtr bufferPointer, long bufferLength)
	Reads memory from the remote device into the given buffer.
unsafe void	Read (long address, byte[] buffer)
	Reads memory from the remote device into the given buffer .
void	Write (long address, IntPtr bufferPointer, long bufferLength)
	Writes memory from the given buffer to the remote device.
unsafe void	Write (long address, byte[] buffer)
	Writes the the given buffer to the remote device.
Public Member Functions inherited from Node
void	Dispose ()
	Disposes the native object wrapped by this object immediately.
void	Close ()
	Alias of the Dispose() method.

Additional Inherited Members
Protected Member Functions inherited from Node
void	Detach ()
	Detaches this Image object from the native object.
virtual void	Dispose (bool disposing)
	IDispose helper function.
Protected Attributes inherited from Node
readonly IntPtr	UpdatedCallbackID
	Identifier of the registered updated callback.
Properties inherited from Node
bool	IsDisposed [get]
	Tests whether the native handle has been disposed.
IntPtr	Handle [get]
	Native CVB NODE handle.
NodeMap	NodeMap [get]
	Gets the GenApi.NodeMap this node resides in.
string	Name [get]
	Gets the full name of this node.
string	ToolTip [get]
	Gets the short descriptive text of this node.
string	Description [get]
	Gets the long descriptive text of this node.
AccessMode	AccessMode [get]
	Gets the GenApi.AccessMode of this node.
bool	IsImplemented [get]
	AccessMode helper to check whether this node is implemented.
bool	IsAvailable [get]
	AccessMode helper to check whether this node is available.
bool	IsReadable [get]
	AccessMode helper to check whether this node is readable.
bool	IsWritable [get]
	AccessMode helper to check whether this node is writable.
CacheMode	CacheMode [get]
	Gets the cache mode of this node.
string	EventID [get]
	Nodes with an event identifier may become invalidated, if an event / message is delivered from the device.
bool	IsFeature [get]
	Returns whether this node is considered a feature node.
bool	IsDeprecated [get]
	Gets whether this node is considered deprecated.
Visibility	Visibility [get]
	Gets the complexity level of this node.
Node	AliasNode [get]
	Gets the node, that is an alias value for this node.
Events inherited from Node
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.
EventHandler	Updated
	Event signaling that a node property has been updated.
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Detailed Description

Port nodes are the connection to the remote device.

Port nodes enable direct memory access on the remote device.

Member Function Documentation

Read() [1/2]

unsafe void Read	(	long	address,
		byte[]	buffer )

Reads memory from the remote device into the given buffer .

The number of bytes read depend on the Array.Length of the given buffer .

Parameters

address	Address to read from.
buffer	Byte array to read to.

Implements IPortNode.

Read() [2/2]

void Read	(	long	address,
		IntPtr	bufferPointer,
		long	bufferLength )

Reads memory from the remote device into the given buffer.

Use of this method is unsafe; prefer using the typed nodes instead or reading into byte-arrays if necessary.

Parameters

address	Address to read from.
bufferPointer	Buffer to store data into.
bufferLength	Number of bytes to read; buffer must have at least that many bytes of allocated memory.

Implements IPortNode.

Write() [1/2]

unsafe void Write	(	long	address,
		byte[]	buffer )

Writes the the given buffer to the remote device.

The number of bytes written depend on the Array.Length of the given buffer .

Parameters

address	Address to write to.
buffer	Byte array to write.

Implements IPortNode.

Write() [2/2]

void Write	(	long	address,
		IntPtr	bufferPointer,
		long	bufferLength )

Writes memory from the given buffer to the remote device.

Use of this method is unsafe; prefer using the typed nodes instead or writing from byte-arrays if necessary.

Parameters

address	Address to write to.
bufferPointer	Buffer to write to device.
bufferLength	Number of bytes in the buffer.

Implements IPortNode.