RigDef::Node::Id Class Reference

Abstract node ID (numbered or named) Node name is always available. More...

#include <RigDef_Node.h>

Public Member Functions
	BITMASK_PROPERTY_GET (m_flags, 1, IS_VALID, IsValid)
	BITMASK_PROPERTY_GET (m_flags, 2, IS_TYPE_NUMBERED, IsTypeNumbered)
	BITMASK_PROPERTY_GET (m_flags, 3, IS_TYPE_NAMED, IsTypeNamed)
	Id ()
	Id (unsigned int id_num)
	Id (std::string const &id_str)
void	SetNum (unsigned int id_num)
void	setStr (std::string const &id_str)
const std::string &	Str () const
unsigned int	Num () const
void	Invalidate ()
std::string	ToString () const

Private Attributes
unsigned int	m_id_num
std::string	m_id_str
unsigned int	m_flags

Detailed Description

Abstract node ID (numbered or named) Node name is always available.

For numbered nodes, it's the number converted to string. Node number is only available for explicitly numbered nodes (legacy).

Definition at line 44 of file RigDef_Node.h.

Constructor & Destructor Documentation

Id() [1/3]

Node::Id::Id

(

)

Definition at line 34 of file RigDef_Node.cpp.

Id() [2/3]

Node::Id::Id

(

unsigned int

id_num

)

Definition at line 39 of file RigDef_Node.cpp.

Id() [3/3]

Node::Id::Id

(

std::string const &

id_str

)

Definition at line 46 of file RigDef_Node.cpp.

Member Function Documentation

BITMASK_PROPERTY_GET() [1/3]

RigDef::Node::Id::BITMASK_PROPERTY_GET	(	m_flags	,
		1	,
		IS_VALID	,
		IsValid
	)

BITMASK_PROPERTY_GET() [2/3]

RigDef::Node::Id::BITMASK_PROPERTY_GET	(	m_flags	,
		2	,
		IS_TYPE_NUMBERED	,
		IsTypeNumbered
	)

BITMASK_PROPERTY_GET() [3/3]

RigDef::Node::Id::BITMASK_PROPERTY_GET	(	m_flags	,
		3	,
		IS_TYPE_NAMED	,
		IsTypeNamed
	)

Invalidate()

void Node::Id::Invalidate

(

)

Definition at line 72 of file RigDef_Node.cpp.

Num()

unsigned int RigDef::Node::Id::Num ( ) const

inline

Definition at line 62 of file RigDef_Node.h.

SetNum()

void Node::Id::SetNum

(

unsigned int

id_num

)

Definition at line 55 of file RigDef_Node.cpp.

setStr()

void Node::Id::setStr

(

std::string const &

id_str

)

Definition at line 63 of file RigDef_Node.cpp.

Str()

const std::string& RigDef::Node::Id::Str ( ) const

inline

Definition at line 61 of file RigDef_Node.h.

ToString()

std::string Node::Id::ToString

(

)

const

Definition at line 129 of file RigDef_Node.cpp.

Field Documentation

m_flags

unsigned int RigDef::Node::Id::m_flags

private

Definition at line 72 of file RigDef_Node.h.

m_id_num

unsigned int RigDef::Node::Id::m_id_num

private

Definition at line 70 of file RigDef_Node.h.

m_id_str

std::string RigDef::Node::Id::m_id_str

private

Definition at line 71 of file RigDef_Node.h.

---

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

• source/main/resources/rig_def_fileformat/RigDef_Node.h
• source/main/resources/rig_def_fileformat/RigDef_Node.cpp