BFGTLUtilities::PRIVATE_IMP::FloatNodeBase Struct Reference

#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::FloatNodeBase:

Public Types
typedef BFDOUBLE	Value

Public Member Functions
Value	value (BFVOID) const
Value	minimum (BFVOID) const
Value	maximum (BFVOID) const
Value	increment (BFVOID) const
BFVOID	setValue (const Value 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 BFDOUBLE BFGTLUtilities::PRIVATE_IMP::FloatNodeBase::Value

Member Function Documentation

PRIVATE_IMP::FloatNodeBase::Value PRIVATE_IMP::FloatNodeBase::increment

(

BFVOID

)

const

Get the increment of values of the float node, counting from the minimum. If exactly zero, than the node has no effective increment.

Returns

The increment of values of the float node, counting from the minimum.

Exceptions

BFCiException

- Thrown if the node's increment value couldn't be retrieved.

References BFCiException::check().

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

PRIVATE_IMP::FloatNodeBase::Value PRIVATE_IMP::FloatNodeBase::maximum

(

BFVOID

)

const

Get the maximum valid value of the float node.

Returns

The maximum valid value of the float node.

Exceptions

BFCiException

- Thrown if the node's maximum value couldn't be retrieved.

References BFCiException::check().

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

PRIVATE_IMP::FloatNodeBase::Value PRIVATE_IMP::FloatNodeBase::minimum

(

BFVOID

)

const

Get the minimum valid value of the float node.

Returns

The minimum valid value of the float node.

Exceptions

BFCiException

- Thrown if the node's minimum value couldn't be retrieved.

References BFCiException::check().

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

BFVOID PRIVATE_IMP::FloatNodeBase::setValue

(

const Value

val

)

Set the value of the float node. This must be in the range: minimum <= value <= maximum If the increment is NOT zero, the value must conform to the system: value[N] = minimum + increment * N;

Exceptions

BFCiException

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

References BFCiException::check().

{
    BFDOUBLE iVal = val;
    BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeWrite(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, &iVal, sizeof(iVal)) );
}

PRIVATE_IMP::FloatNodeBase::Value PRIVATE_IMP::FloatNodeBase::value

(

BFVOID

)

const

Get the float node value.

Returns

The float value of the node.

Exceptions

BFCiException

- Thrown if the node value cannot be read.

References BFCiException::check().

{
    BFDOUBLE 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:

• BFGTLUtilities.hpp
• BFGTLUtilities.cpp