#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::StringNodeBase:

Public Types
typedef std::string	Value

Public Member Functions
Value	value (BFVOID) const

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

BFS64	max_length (BFVOID) const

BFVOID	setValue (Value const &val)

BFVOID	setValue (const BFCHAR *const val)

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::string BFGTLUtilities::PRIVATE_IMP::StringNodeBase::Value

Member Function Documentation

bool PRIVATE_IMP::StringNodeBase::getValue	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Get the string node value.

Parameters

[out]	hBuf	- The string buffer pointer, filled with as much data as is possible. May be nullptr.
[in,out]	pSize	- As input, the size of hBuf. As output, the buffer size requried.

Returns: True on success, false otherwise.

Exceptions

BFCiException - Thrown if the node value cannot be retrieved.

 {
     return BufInHelpers::set_str(value(), hBuf, pSize);
 }

BFS64 PRIVATE_IMP::StringNodeBase::max_length ( BFVOID ) const

Get the maximum string length in characters that this string node may represent.

Returns: The maximum string length in characters that this string node may represent.

Exceptions

BFCiException - Thrown if the node's max_length value couldn't 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_MAX_LENGTH, &iVal, &iSize) );
     return iVal;
 }

BFVOID PRIVATE_IMP::StringNodeBase::setValue ( Value const & val )

Set the value of the string node. The input string value length in characters may not exceed max_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.c_str(), val.length()) );
 }

BFVOID PRIVATE_IMP::StringNodeBase::setValue ( const BFCHAR *const val )

Set the value of the string node. The input string value length in characters may not exceed max_length.

Exceptions

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

 {
     const std::string cppVal (val);
     setValue(cppVal);
 }

PRIVATE_IMP::StringNodeBase::Value PRIVATE_IMP::StringNodeBase::value ( BFVOID ) const

Get the string node value.

Returns: The string value of the node.

Exceptions

BFCiException - Thrown if the node value cannot be read.

References BFCiException::check().

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

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