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

#include <cvb/genapi/port_node.hpp>

Inherits Node.

Public Member Functions
void	Read (std::int64_t address, void *buffer, size_t bufferLenght) const
	Reads memory from the remote device into the given buffer.

void	Write (std::int64_t address, const void *buffer, size_t bufferLenght)
	Writes memory from the given buffer to the remote device.

Public Member Functions inherited from Node
void *	Handle () const noexcept
	Classic API node handle.

String	Name () const
	Gets the full name of this node.

String	DisplayName () const
	Gets the display name of this node.

String	ToolTip () const
	Gets the short descriptive text of this node.

String	Description () const
	Gets the long descriptive text of this node.

Cvb::GenApi::AccessMode	AccessMode () const
	Gets the access mode of this node.

bool	IsImplemented () const
	Helper to check whether this node is implemented.

bool	IsAvailable () const
	Helper to check whether this node is available.

bool	IsReadable () const
	Helper to check whether this node is readable.

bool	IsWriteable () const
	Helper to check whether this node is writable.

Cvb::GenApi::CacheMode	CacheMode () const
	Gets the cache mode of this node.

String	EventID () const
	Nodes with an event identifier may become invalidated, if an event / message is delivered from the device.

bool	IsFeature () const
	Returns whether this node is considered a feature node.

bool	IsDeprecated () const
	Gets whether this node is considered deprecated.

Cvb::GenApi::Visibility	Visibility () const
	Gets the complexity level of this node.

NodePtr	AliasNode () const
	Gets the node, that is an alias value for this node.

EventCookie	RegisterEventUpdated (std::function< void(Node &)> handler)
	Register a listener to node updated event.

void	UnregisterEventUpdated (EventCookie eventCookie) noexcept
	Manually unregister a listener to the node updated event.

NodeMapPtr	NodeMap () const noexcept
	Gets the node map this node resides in.

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()

void Read	(	std::int64_t	address,
		void *	buffer,
		size_t	bufferLenght ) const

inline

Reads memory from the remote device into the given buffer.

Parameters

[in]	address	Address to read from.
[in]	buffer	Buffer to store data into.
[in]	bufferLenght	Number of bytes to read; buffer must have at least that many bytes of allocated memory.

Exceptions

Any	exception derived from std::exception including CvbException.

Use of this method is unsafe; prefer using the typed nodes instead.

◆ Write()

void Write	(	std::int64_t	address,
		const void *	buffer,
		size_t	bufferLenght )