Base class for hierarchy nodes. More...

#include <hierarchy.h>

Inheritance diagram for BlamScenarioHierarchyNode:

Collaboration diagram for BlamScenarioHierarchyNode:

Public Member Functions
	BlamScenarioHierarchyNode (BlamScenarioHierarchyNodeType _node_type)
	Constructs a new scenario hierarchy node. More...

	BlamScenarioHierarchyNode (BlamScenarioHierarchyNodeType _node_type, std::string _display_name_override)
	Constructs a new scenario hierarchy node. More...

virtual	~BlamScenarioHierarchyNode ()

BlamScenarioHierarchyNodeType	GetType ()
	Retrieves the type of this node. More...

virtual std::string	GetName ()
	Retrieves the display name of the hierarchy node. More...

Public Attributes
BlamScenarioHierarchyNode *	parent_node = nullptr
	The parent node, if any, of this hierarchy node. More...

Protected Attributes
bool	use_custom_name = false
	Whether or not to use a custom display name for the node. More...

std::string	display_name_override = "unspecified"
	The custom display name of this hierarchy node. More...

Detailed Description

Base class for hierarchy nodes.

Constructor & Destructor Documentation

◆ BlamScenarioHierarchyNode() [1/2]

BlamScenarioHierarchyNode::BlamScenarioHierarchyNode ( BlamScenarioHierarchyNodeType _node_type )

Constructs a new scenario hierarchy node.

Parameters

_node_type - The type of the new node.

◆ BlamScenarioHierarchyNode() [2/2]

BlamScenarioHierarchyNode::BlamScenarioHierarchyNode	(	BlamScenarioHierarchyNodeType	_node_type,
		std::string	_display_name_override
	)

Constructs a new scenario hierarchy node.

Parameters

_node_type	- The type of the new node.
_display_name_override	- A custom display name to use instead of the default one.

◆ ~BlamScenarioHierarchyNode()

virtual BlamScenarioHierarchyNode::~BlamScenarioHierarchyNode ( )

inlinevirtual

Member Function Documentation

◆ GetName()

std::string BlamScenarioHierarchyNode::GetName ( )

virtual

Retrieves the display name of the hierarchy node.

Returns: The display name of this hierarchy node.

Reimplemented in BlamScenarioHierarchyNode_Object.

Here is the caller graph for this function:

◆ GetType()

BlamScenarioHierarchyNodeType BlamScenarioHierarchyNode::GetType ( )

Retrieves the type of this node.

Returns: The type of this node.

Here is the caller graph for this function:

Member Data Documentation

◆ display_name_override

std::string BlamScenarioHierarchyNode::display_name_override = "unspecified"

protected

The custom display name of this hierarchy node.

In the case of objects, this name will only be used if use_custom_name is set to true. In the case of groups, this name is always used regardless of the use_custom_name value.

◆ parent_node

BlamScenarioHierarchyNode* BlamScenarioHierarchyNode::parent_node = nullptr

The parent node, if any, of this hierarchy node.

◆ use_custom_name

bool BlamScenarioHierarchyNode::use_custom_name = false