#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::EnumEntryNodeBase:

Public Member Functions
BFS64	value (BFVOID) const

std::string	symbolic (BFVOID) const

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

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

bool PRIVATE_IMP::EnumEntryNodeBase::getSymbolic	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Return the symbolic name of the enumeration entry.

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 entry symbolic name couldn't be determined.

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

std::string PRIVATE_IMP::EnumEntryNodeBase::symbolic ( BFVOID ) const

Return the symbolic name of the enumeration entry.

Returns: The symbolic name of the enumeration entry.

Exceptions

BFCiException - Thrown if the node entry symbolic name couldn't be determined.

References BFCiException::check().

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

BFS64 PRIVATE_IMP::EnumEntryNodeBase::value ( BFVOID ) const

Return the integer value of the enumeration entry.

Returns: The integer value of the enumeration entry.

Exceptions

BFCiException - Thrown if the node entry value couldn't be read.

References BFCiException::check().

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

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

Public Member Functions

Additional Inherited Members

Member Function Documentation