#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::RegisterNodeBase:

Public Types
typedef std::vector< BFU8 >	DataArray

Public Member Functions
BFS64	address (BFVOID) const

BFS64	length (BFVOID) const

DataArray	data (BFVOID) const

void	getData (BFU8 *const dataBuf, const BFSIZET bufLen) const

BFVOID	setData (DataArray const &val)

BFVOID	setData (const BFU8 *const dataBuf, const BFSIZET bufLen)

Public Member Functions inherited from BFGTLUtilities::PRIVATE_IMP::ValueNodeBase
std::string	toString (BFVOID) const

bool	getToString (BFCHAR const hBuf, BFSIZET const pSize) const

BFVOID	fromString (std::string const &strVal)

BFVOID	fromString (const BFCHAR *const strVal)

Public Member Functions inherited from BFGTLUtilities::BaseNode
	BaseNode (BFVOID)

	BaseNode (BaseNode const &to_alias)

	BaseNode (BaseNode &&to_take)

virtual	~BaseNode (BFVOID)

BaseNode &	operator= (BaseNode const &to_alias)

BaseNode &	operator= (BaseNode &&to_take)

bool	isValid (BFVOID) const

	operator bool (BFVOID) const

bool	isNull (BFVOID) const

bool	operator! (BFVOID) const

bool	operator== (BaseNode const &other) const

bool	operator!= (BaseNode const &other) const

std::string	name (BFVOID) const

bool	getName (BFCHAR const hBuf, BFSIZET const pSize) const

std::string	displayName (BFVOID) const

bool	getDisplayName (BFCHAR const hBuf, BFSIZET const pSize) const

std::string	toolTip (BFVOID) const

bool	getToolTip (BFCHAR const hBuf, BFSIZET const pSize) const

std::string	description (BFVOID) const

bool	getDescription (BFCHAR const hBuf, BFSIZET const pSize) const

NodeType	type (BFVOID) const

Access	access (BFVOID) const

bool	ignoreCache (BFVOID) const

BFVOID	setIgnoreCache (const bool ignore)

Additional Inherited Members
Static Public Attributes inherited from BFGTLUtilities::BaseNode
static const NodeType	Type = NodeType::Base

Protected Member Functions inherited from BFGTLUtilities::BaseNode
virtual void	copy (BaseNode const &to_alias)

virtual void	copy (BaseNode &&to_take)

Protected Attributes inherited from BFGTLUtilities::BaseNode
PrivateData *	m_pd

Member Typedef Documentation

typedef std::vector<BFU8> BFGTLUtilities::PRIVATE_IMP::RegisterNodeBase::DataArray

Member Function Documentation

BFS64 PRIVATE_IMP::RegisterNodeBase::address ( BFVOID ) const

Get the register node register address.

Returns: The register node register address.

Exceptions

BFCiException - Thrown if the node address cannot be retrieved.

References BFCiException::check().

 {
     BFS64 iVal;
     size_t iSize = sizeof(iVal);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ADDRESS, &iVal, &iSize) );
     return iVal;
 }

PRIVATE_IMP::RegisterNodeBase::DataArray PRIVATE_IMP::RegisterNodeBase::data ( BFVOID ) const

Read the entire register node data.

Returns: The entire register node data.

Exceptions

BFCiException - Thrown if the node data read failed.

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, nullptr, &iSize) );
     
     DataArray iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, iVal.data(), &iSize) );
 
     return iVal;
 }

void PRIVATE_IMP::RegisterNodeBase::getData	(	BFU8 *const	dataBuf,
		const BFSIZET	bufLen
	)		const

Read the register node data into the externally allocated buffer.

Exceptions

BFCiException - Thrown if the node data read failed.

References BFCiException::check().

 {
     size_t iSize = bufLen;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, dataBuf, &iSize) );
 }

BFS64 PRIVATE_IMP::RegisterNodeBase::length ( BFVOID ) const

Get the register node data length.

Returns: The register node data length.

Exceptions

BFCiException - Thrown if the node data length cannot be retrieved.

References BFCiException::check().

 {
     BFS64 iVal;
     size_t iSize = sizeof(iVal);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_LENGTH, &iVal, &iSize) );
     return iVal;
 }

BFVOID PRIVATE_IMP::RegisterNodeBase::setData ( DataArray const & val )

Set the value of the register node from the input DataArray. The DataArray length should not exceed the register length.

Exceptions

BFCiException - Thrown if the node's value couldn't be set.

References BFCiException::check().

 {
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeWrite(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, val.data(), val.size()) );
 }

BFVOID PRIVATE_IMP::RegisterNodeBase::setData	(	const BFU8 *const	dataBuf,
		const BFSIZET	bufLen
	)

Set the value of the register node from the input data buffer. The buffer length should not exceed the register length.

Exceptions

BFCiException - Thrown if the node's value couldn't be set.

References BFCiException::check().

 {
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeWrite(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, dataBuf, bufLen) );
 }

The documentation for this struct was generated from the following files:

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

Member Function Documentation