Buffer Interface
Public Types | Public Member Functions | List of all members
BFGTLUtilities::PRIVATE_IMP::BooleanNodeBase Struct Reference

#include <BFGTLUtilities.hpp>

Inheritance diagram for BFGTLUtilities::PRIVATE_IMP::BooleanNodeBase:
BFGTLUtilities::PRIVATE_IMP::ValueNodeBase BFGTLUtilities::BaseNode BFGTLUtilities::BooleanNode

Public Types

typedef bool Value
 

Public Member Functions

Value value (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)
 
BaseNodeoperator= (BaseNode const &to_alias)
 
BaseNodeoperator= (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

Member Function Documentation

BFVOID PRIVATE_IMP::BooleanNodeBase::setValue ( const Value  val)

Set the value of the boolean node, true or false.

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

References BFCiException::check().

842 {
843  BFBOOL iVal = val ? 1 : 0;
844  BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeWrite(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, &iVal, sizeof(iVal)) );
845 }
PrivateData * m_pd
Definition: BFGTLUtilities.hpp:304
static void check(Bd hBoard, const BFU32 error)
Definition: BFException.cpp:212
int BFBOOL
Definition: BFTypeNT.h:34
PRIVATE_IMP::BooleanNodeBase::Value PRIVATE_IMP::BooleanNodeBase::value ( BFVOID  ) const

Get the boolean node value.

Returns
The boolean value of the node.
Exceptions
BFCiException- Thrown if the node value cannot be read.

References BFCiException::check().

829 {
830  BFBOOL iVal;
831  size_t iSize = sizeof(iVal);
832  BFCiException::check((*m_pd)->m_hBoard, BFGTLNodeRead(*m_pd->m_nodePtr, BFGTL_NODE_VALUE, &iVal, &iSize) );
833  return !!iVal;
834 }
PrivateData * m_pd
Definition: BFGTLUtilities.hpp:304
static void check(Bd hBoard, const BFU32 error)
Definition: BFException.cpp:212
int BFBOOL
Definition: BFTypeNT.h:34

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