BFGTLUtilities::BaseNode Class Reference

Base class for BFGTLUtilities::Device node access and modification. More...

#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::BaseNode:

Public Member Functions
	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)

Static Public Attributes
static const NodeType	Type = NodeType::Base

Protected Member Functions
virtual void	copy (BaseNode const &to_alias)
virtual void	copy (BaseNode &&to_take)

Protected Attributes
PrivateData *	m_pd

Detailed Description

Base class for BFGTLUtilities::Device node access and modification.

Constructor & Destructor Documentation

BaseNode::BaseNode

(

BFVOID

)

Initialize a BaseNode instance with no data.

    : m_pd ( new PrivateData )
{ }

BaseNode::BaseNode

(

BaseNode const &

to_alias

)

Initialize a BaseNode instance referencing the same data as the given node.

References m_pd.

    : m_pd ( new PrivateData )
{
    m_pd->m_nodePtr = to_alias.m_pd->m_nodePtr;
}

BaseNode::BaseNode

(

BaseNode &&

to_take

)

Initialize a BaseNode instance referencing the same data as the given node. to_take will lose its reference.

    : m_pd (to_take.m_pd)
{
    to_take.m_pd = nullptr;
}

BaseNode::~BaseNode ( BFVOID  )

virtual

Cleanup and deallocate the node.

References m_pd.

{
    delete m_pd;
}

Member Function Documentation

Access BaseNode::access

(

BFVOID

)

const

Retrieve the node accessibility.

Returns

The accessibility of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node accessibility cannot be determined.

References BFCiException::check(), and m_pd.

{
    BFU32 accessCode;
    size_t iSize = sizeof(accessCode);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_ACCESS, &accessCode, &iSize) );
    return (Access)accessCode;
}

void BaseNode::copy ( BaseNode const &  to_alias )

protectedvirtual

References m_pd.

Referenced by operator=().

{
    if (*this != to_alias)
        m_pd->m_nodePtr = to_alias.m_pd->m_nodePtr;
}

void BaseNode::copy ( BaseNode &&  to_take )

protectedvirtual

References m_pd.

{
    if (*this != to_take)
    {
        delete m_pd;
        m_pd = to_take.m_pd;
        to_take.m_pd = nullptr;
    }
}

std::string BaseNode::description

(

BFVOID

)

const

Retrieve the node description text. The node must be valid.

Returns

The description text of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node description text cannot be retrieved.

References BFCiException::check(), and m_pd.

Referenced by getDescription().

{
    size_t iSize;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_DESCRIPTION, nullptr, &iSize) );

    std::vector<char> cData (iSize);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_DESCRIPTION, cData.data(), &iSize) );
    cData.back() = 0;

    return cData.data();
}

std::string BaseNode::displayName

(

BFVOID

)

const

Retrieve the node display name text. The node must be valid.

Returns

The display name text of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node display name text cannot be retrieved.

References BFCiException::check(), and m_pd.

Referenced by getDisplayName().

{
    size_t iSize;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_DISPLAY_NAME, nullptr, &iSize) );

    std::vector<char> cData (iSize);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_DISPLAY_NAME, cData.data(), &iSize) );
    cData.back() = 0;

    return cData.data();
}

bool BaseNode::getDescription	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the node description text. The node must be valid.

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 name cannot be retrieved.

References description().

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

bool BaseNode::getDisplayName	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the node display name text. The node must be valid.

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 name cannot be retrieved.

References displayName().

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

bool BaseNode::getName	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the node name string. This value is unique to each node. The node must be valid.

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 name cannot be retrieved.

References name().

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

bool BaseNode::getToolTip	(	BFCHAR *const	hBuf,
		BFSIZET *const	pSize
	)		const

Retrieve the node tool-tip text. The node must be valid.

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 name cannot be retrieved.

References toolTip().

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

bool BaseNode::ignoreCache

(

BFVOID

)

const

Whether or not to ignore any cached data.

Returns

Status of the cache ignore flag.

Exceptions

BFCiException

- Thrown if the node ignore cache status cannot be determined.

References BFCiException::check(), and m_pd.

{
    BFBOOL bVal;
    size_t iSize = sizeof(bVal);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_IGNORE_CACHE, &bVal, &iSize) );
    return !!bVal;
}

bool BaseNode::isNull

(

BFVOID

)

const

Inverse of isValid.

Returns

False if this handle references a Device node, true otherwise.

References isValid().

{
    return !isValid();
}

bool BaseNode::isValid

(

BFVOID

)

const

Check whether or not this handle references a Device node.

Returns

True if this handle references a Device node, false otherwise.

References m_pd.

Referenced by isNull(), and operator!().

{
    return !!m_pd->m_nodePtr;
}

std::string BaseNode::name

(

BFVOID

)

const

Retrieve the node name string. This value is unique to each node. The node must be valid.

Returns

The name of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node name cannot be retrieved.

References BFCiException::check(), and m_pd.

Referenced by getName(), and operator==().

{
    size_t iSize;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_NAME, nullptr, &iSize) );

    std::vector<char> cData (iSize);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_NAME, cData.data(), &iSize) );
    cData.back() = 0;

    return cData.data();
}

BaseNode::operator bool

(

BFVOID

)

const

Equivalent to isValid.

Returns

True if this handle references a Device node, false otherwise.

{
    return !!m_pd->m_nodePtr;
}

bool BaseNode::operator!

(

BFVOID

)

const

Equivalent to isNull.

Returns

False if this handle references a Device node, true otherwise.

References isValid().

{
    return !isValid();
}

bool BaseNode::operator!=

(

BaseNode const &

other

)

const

Determine if this node is inequivalent to a different node. Null instances are not considered equivalent.

Returns

True if either handle isNull, or if the handles reference different Device nodes. False, otherwise.

{
    return !(*this == other);
}

BaseNode & BaseNode::operator=

(

BaseNode const &

to_alias

)

Make this node reference the same data as the node to_alias.

Returns

A reference to this node.

References copy().

{
    copy(to_alias);
    return *this;
}

BaseNode & BaseNode::operator=

(

BaseNode &&

to_take

)

Make this node reference the same data as the node to_take. to_take will lose its reference.

Returns

A reference to this node.

References copy().

{
    copy(std::move(to_take));
    return *this;
}

bool BaseNode::operator==

(

BaseNode const &

other

)

const

Determine if this node is equivalent to a different node. Null instances are not considered equivalent.

Returns

True if the node handles are valid, and reference the same Device node. False, otherwise.

References m_pd, and name().

{
    if (!(*this) || !other)
        return false;
    
    return (&m_pd->m_nodePtr->m_device == &other.m_pd->m_nodePtr->m_device) && (name() == other.name());
}

BFVOID BaseNode::setIgnoreCache

(

const bool

ignore

)

Set whether or not to ignore any cached data.

Exceptions

BFCiException

- Thrown if the node ignore cache status cannot be set.

References BFCiException::check(), and m_pd.

{
    BFBOOL bVal = ignore;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeWrite(*m_pd->m_nodePtr, BFGTL_NODE_IGNORE_CACHE, &bVal, sizeof(bVal)) );
}

std::string BaseNode::toolTip

(

BFVOID

)

const

Retrieve the node tool-tip text. The node must be valid.

Returns

The tool-tip text of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node tool-tip text cannot be retrieved.

References BFCiException::check(), and m_pd.

Referenced by getToolTip().

{
    size_t iSize;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_TOOL_TIP, nullptr, &iSize) );

    std::vector<char> cData (iSize);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_TOOL_TIP, cData.data(), &iSize) );
    cData.back() = 0;

    return cData.data();
}

NodeType BaseNode::type

(

BFVOID

)

const

Retrieve the node type.

Returns

The type of the referenced Device node.

Exceptions

BFCiException

- Thrown if the node type cannot be determined.

References BFCiException::check(), and m_pd.

Referenced by BFGTLUtilities::PRIVATE_IMP::NodeImpT< NodeT, NODE_TYPE >::is_convertible().

{
    BFU32 typeCode;
    size_t iSize = sizeof(typeCode);
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_TYPE, &typeCode, &iSize) );
    return (NodeType)typeCode;
}

Member Data Documentation

PrivateData* BFGTLUtilities::BaseNode::m_pd

protected

Referenced by access(), BaseNode(), copy(), description(), displayName(), ignoreCache(), isValid(), name(), operator==(), setIgnoreCache(), toolTip(), BFGTLUtilities::PRIVATE_IMP::ValueNodeBase::toString(), type(), and ~BaseNode().

const NodeType BFGTLUtilities::BaseNode::Type = NodeType::Base

static

---

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

• BFGTLUtilities.hpp
• BFGTLUtilities.cpp