#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::CategoryNodeBase:

Public Types
typedef std::vector< std::string >	FeatureNames

typedef BaseNode	Feature

typedef std::vector< Feature >	Features

Public Member Functions
BFS64	featureCount (BFVOID) const

FeatureNames	featureNames (BFVOID) const

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

Features	features (BFVOID) const

bool	getFeature (const BFS64 index, Feature *const pFeature) 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 Typedef Documentation

typedef BaseNode BFGTLUtilities::PRIVATE_IMP::CategoryNodeBase::Feature

typedef std::vector<std::string> BFGTLUtilities::PRIVATE_IMP::CategoryNodeBase::FeatureNames

typedef std::vector<Feature> BFGTLUtilities::PRIVATE_IMP::CategoryNodeBase::Features

Member Function Documentation

bool PRIVATE_IMP::CategoryNodeBase::enumerateFeatureName	(	const BFS64	index,
		BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Iteratively retrieve the child feature names for the category.

Parameters

[in]	index	- The feature index.
[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 feature name cannot be retrieved.

References BFCiException::check().

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

BFS64 PRIVATE_IMP::CategoryNodeBase::featureCount ( BFVOID ) const

Return the number of child features for the category.

Returns: The number of child features for the category.

Exceptions

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

References BFCiException::check().

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

PRIVATE_IMP::CategoryNodeBase::FeatureNames PRIVATE_IMP::CategoryNodeBase::featureNames ( BFVOID ) const

Return a list of the child feature names for the category.

Returns: A list of the child feature names for the category.

Exceptions

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

References BFCiException::check().

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

PRIVATE_IMP::CategoryNodeBase::Features PRIVATE_IMP::CategoryNodeBase::features ( BFVOID ) const

Return a list of the child feature nodes for the category.

Returns: A list of the child feature nodes for the category.

Exceptions

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

 {
     Features fs;
     for (auto const& fNames : featureNames())
         fs.push_back( m_pd->m_nodePtr->m_device.getNode(fNames) );
     return fs;
 }

bool PRIVATE_IMP::CategoryNodeBase::getFeature	(	const BFS64	index,
		Feature *const	pFeature
	)		const

Retrieve the feature at the given index.

Parameters

[in]	index	- The feature index.
[out]	pFeature	- The feature handle pointer.

Returns: True if the feature exists, false otherwise.

Exceptions

BFCiException - Thrown if the feature name cannot be retrieved.

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

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