#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase:

Public Types
typedef BFS64	Value

typedef std::vector< std::string >	EntryStrings

typedef std::vector< Value >	EntryValues

typedef NodeImpT< EnumEntryNodeBase, NodeType::EnumEntry >	Entry

typedef std::vector< Entry >	Entries

Public Member Functions
Value	entryValue (BFVOID) const

std::string	entryName (BFVOID) const

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

std::string	entrySymbolic (BFVOID) const

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

BFS64	entryCount (BFVOID) const

EntryValues	entryValues (BFVOID) const

bool	enumerateEntryValue (const BFS64 index, Value *const pVal) const

EntryStrings	entryNames (BFVOID) const

bool	enumerateEntryName (const BFS64 index, BFCHAR const hBuf, BFSIZET const pSize) const

EntryStrings	entrySymbolics (BFVOID) const

bool	enumerateEntrySymbolic (const BFS64 index, BFCHAR const hBuf, BFSIZET const pSize) const

Entry	entry (BFVOID) const

Entries	entries (BFVOID) const

bool	enumerateEntry (const BFS64 index, Entry *const pEntry) const

BFVOID	setEntryValue (const Value val)

BFVOID	setEntryName (std::string const &name)

BFVOID	setEntryName (const BFCHAR *const name)

BFVOID	setEntrySymbolic (std::string const &symbolic)

BFVOID	setEntrySymbolic (const BFCHAR *const symbolic)

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<Entry> BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase::Entries

typedef NodeImpT<EnumEntryNodeBase,NodeType::EnumEntry> BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase::Entry

typedef std::vector<std::string> BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase::EntryStrings

typedef std::vector<Value> BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase::EntryValues

typedef BFS64 BFGTLUtilities::PRIVATE_IMP::EnumerationNodeBase::Value

Member Function Documentation

PRIVATE_IMP::EnumerationNodeBase::Entries PRIVATE_IMP::EnumerationNodeBase::entries ( BFVOID ) const

Return a list of the enumeration entry nodes.

Returns: A list of the enumeration entry nodes.

Exceptions

BFCiException - Thrown if the node entries couldn't be found and opened.

 {
     Entries es;
     for (auto const& eName : entryNames())
         es.push_back( m_pd->m_nodePtr->m_device.getNode(eName) );
     return es;
 }

PRIVATE_IMP::EnumerationNodeBase::Entry PRIVATE_IMP::EnumerationNodeBase::entry ( BFVOID ) const

Return the current enumeration entry node.

Returns: The current enumeration entry node.

Exceptions

BFCiException - Thrown if the node entry couldn't be found and opened.

 {
     return m_pd->m_nodePtr->m_device.getNode(entryName());
 }

BFS64 PRIVATE_IMP::EnumerationNodeBase::entryCount ( BFVOID ) const

Return the number of entries in this enumeration.

Returns: The number of entries in this enumeration.

Exceptions

BFCiException - Thrown if the node entry count couldn't determined.

References BFCiException::check().

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

std::string PRIVATE_IMP::EnumerationNodeBase::entryName ( BFVOID ) const

Return the node name of the currently selected enumeration entry.

Returns: The node name of the currently selected enumeration entry.

Exceptions

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

References BFCiException::check().

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

PRIVATE_IMP::EnumerationNodeBase::EntryStrings PRIVATE_IMP::EnumerationNodeBase::entryNames ( BFVOID ) const

Return a list of the enumeration entries' node names.

Returns: A list of the enumeration entries' node names.

Exceptions

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

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_NAMES, nullptr, &iSize) );
     
     std::vector<char> iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_NAMES, iVal.data(), &iSize) );
 
     size_t *strOffsets = reinterpret_cast<size_t*>(iVal.data());
 
     EntryStrings eNames;
     while (*strOffsets)
         eNames.push_back(&iVal[*strOffsets++]);
 
     return eNames;
 }

std::string PRIVATE_IMP::EnumerationNodeBase::entrySymbolic ( BFVOID ) const

Return the symbolic name of the currently selected enumeration entry.

Returns: The symbolic name of the currently selected enumeration entry.

Exceptions

BFCiException - Thrown if the node current entry symbolic name couldn't 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();
 }

PRIVATE_IMP::EnumerationNodeBase::EntryStrings PRIVATE_IMP::EnumerationNodeBase::entrySymbolics ( BFVOID ) const

Return a list of the enumeration entries' symbolic names.

Returns: A list of the enumeration entries' symbolic names.

Exceptions

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

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_SYMBOLICS, nullptr, &iSize) );
     
     std::vector<char> iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_SYMBOLICS, iVal.data(), &iSize) );
 
     size_t *strOffsets = reinterpret_cast<size_t*>(iVal.data());
 
     EntryStrings eNames;
     while (*strOffsets)
         eNames.push_back(&iVal[*strOffsets++]);
 
     return eNames;
 }

PRIVATE_IMP::EnumerationNodeBase::Value PRIVATE_IMP::EnumerationNodeBase::entryValue ( BFVOID ) const

Return the integer value of the currently selected enumeration entry.

Returns: The integer value of the currently selected enumeration entry.

Exceptions

BFCiException - Thrown if the node current 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;
 }

PRIVATE_IMP::EnumerationNodeBase::EntryValues PRIVATE_IMP::EnumerationNodeBase::entryValues ( BFVOID ) const

Return a list of the enumeration entries' integer values.

Returns: A list of the enumeration entries' integer values.

Exceptions

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

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_VALUES, nullptr, &iSize) );
 
     std::vector<BFU8> iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_VALUES, iVal.data(), &iSize) );
 
     const size_t entryCnt = iSize / sizeof(BFS64);
     BFS64 *entryVals = reinterpret_cast<BFS64*>(iVal.data());
     return EntryValues (entryVals, entryVals + entryCnt);
 }

bool PRIVATE_IMP::EnumerationNodeBase::enumerateEntry	(	const BFS64	index,
		Entry *const	pEntry
	)		const

Retrieve an enumeration entry for the given index.

Parameters

[in]	index	- The index of the enumeration entry to retrieve.
[out]	pEntry	- The enumeration entry handle.

Returns: True if the entry was successfully retrieve, otherwise false.

Exceptions

BFCiException - Thrown if the node entry couldn't be found and opened.

 {
     const auto ens = entryNames();
     if (ens.size() <= (size_t)index)
         return false;
 
     *pEntry = m_pd->m_nodePtr->m_device.getNode(ens[(size_t)index]);
     return true;
 }

bool PRIVATE_IMP::EnumerationNodeBase::enumerateEntryName	(	const BFS64	index,
		BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the enumeration entry string name for the given index.

Parameters

[in]	index	- The index of the enumeration entry to query.
[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 names couldn't be determined.

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_NAMES, nullptr, &iSize) );
     
     std::vector<char> iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_NAMES, iVal.data(), &iSize) );
 
     size_t *strOffsets = reinterpret_cast<size_t*>(iVal.data());
 
     for (BFS64 i = 0; *strOffsets; i++, strOffsets++)
     {
         if (index == i)
             return BufInHelpers::set_str(&iVal[*strOffsets], hBuf, pSize);
     }
 
     return false;
 }

bool PRIVATE_IMP::EnumerationNodeBase::enumerateEntrySymbolic	(	const BFS64	index,
		BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the enumeration entry string symbolic for the given index.

Parameters

[in]	index	- The index of the enumeration entry to query.
[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 couldn't be determined.

References BFCiException::check().

 {
     size_t iSize;
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_SYMBOLICS, nullptr, &iSize) );
     
     std::vector<char> iVal (iSize);
     BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ENTRY_SYMBOLICS, iVal.data(), &iSize) );
 
     size_t *strOffsets = reinterpret_cast<size_t*>(iVal.data());
 
     for (BFS64 i = 0; *strOffsets; i++, strOffsets++)
     {
         if (index == i)
             return BufInHelpers::set_str(&iVal[*strOffsets], hBuf, pSize);
     }
 
     return false;
 }

bool PRIVATE_IMP::EnumerationNodeBase::enumerateEntryValue	(	const BFS64	index,
		Value *const	pVal
	)		const

Retrieve the enumeration entry integer value for the given index.

Returns: True on success, false otherwise.

Exceptions

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

 {
     const auto evs = entryValues();
     if (evs.size() <= (size_t)index)
         return false;
 
     *pVal = evs[(size_t)index];
     return true;
 }

bool PRIVATE_IMP::EnumerationNodeBase::getEntryName	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Return the node name of the currently selected 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 current entry name couldn't determined.

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

bool PRIVATE_IMP::EnumerationNodeBase::getEntrySymbolic	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Return the symbolic name of the currently selected 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 current entry symbolic name couldn't determined.

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

BFVOID PRIVATE_IMP::EnumerationNodeBase::setEntryName ( std::string const & name )

Set the current entry by its node name.

Exceptions