DBC Framework
DBC parsing and CAN signal decoding framework
TreeNode Class Reference

Tree node for later use in model/view or other hierarchy consumers. More...

#include <tree_node.h>

Public Member Functions

 TreeNode ()
 Create root node. More...
 
 TreeNode (const FrameInfo &frame)
 Create frame node. More...
 
 TreeNode (const SignalInfo &signal)
 Create signal node. More...
 
 TreeNode (const TreeNode &)=delete
 
TreeNodeoperator= (const TreeNode &)=delete
 
 TreeNode (TreeNode &&)=default
 
TreeNodeoperator= (TreeNode &&)=default
 
void AddChild (std::unique_ptr< TreeNode > child)
 Add child node. More...
 
std::size_t GetChildCount () const
 Get child count. More...
 
const TreeNodeGetChild (std::size_t index) const
 Get child by index. More...
 
TreeNodeGetChild (std::size_t index)
 Get mutable child by index. More...
 
NodeType GetType () const
 Get node type. More...
 
const std::string & GetName () const
 Get display name. More...
 
const FrameInfoGetFrame () const
 Get frame payload if node is frame. More...
 
const SignalInfoGetSignal () const
 Get signal payload if node is signal. More...
 

Detailed Description

Tree node for later use in model/view or other hierarchy consumers.

Definition at line 35 of file tree_node.h.

Constructor & Destructor Documentation

◆ TreeNode() [1/3]

TreeNode::TreeNode ( )

Create root node.

Definition at line 14 of file tree_node.cpp.

◆ TreeNode() [2/3]

TreeNode::TreeNode ( const FrameInfo frame)
explicit

Create frame node.

Parameters
frameFrame payload.

Definition at line 22 of file tree_node.cpp.

◆ TreeNode() [3/3]

TreeNode::TreeNode ( const SignalInfo signal)
explicit

Create signal node.

Parameters
signalSignal payload.

Definition at line 30 of file tree_node.cpp.

Member Function Documentation

◆ AddChild()

void TreeNode::AddChild ( std::unique_ptr< TreeNode child)

Add child node.

Parameters
childChild node to add.

Definition at line 38 of file tree_node.cpp.

◆ GetChildCount()

std::size_t TreeNode::GetChildCount ( ) const

Get child count.

Returns
Number of children.

Definition at line 43 of file tree_node.cpp.

◆ GetChild() [1/2]

const TreeNode * TreeNode::GetChild ( std::size_t  index) const

Get child by index.

Parameters
indexChild index.
Returns
Child pointer or nullptr if index is invalid.

Definition at line 47 of file tree_node.cpp.

◆ GetChild() [2/2]

TreeNode * TreeNode::GetChild ( std::size_t  index)

Get mutable child by index.

Parameters
indexChild index.
Returns
Child pointer or nullptr if index is invalid.

Definition at line 54 of file tree_node.cpp.

◆ GetType()

NodeType TreeNode::GetType ( ) const

Get node type.

Returns
Node type.

Definition at line 61 of file tree_node.cpp.

◆ GetName()

const std::string & TreeNode::GetName ( ) const

Get display name.

Returns
Node name.

Definition at line 65 of file tree_node.cpp.

◆ GetFrame()

const FrameInfo * TreeNode::GetFrame ( ) const

Get frame payload if node is frame.

Returns
Pointer to frame info or nullptr.

Definition at line 69 of file tree_node.cpp.

◆ GetSignal()

const SignalInfo * TreeNode::GetSignal ( ) const

Get signal payload if node is signal.

Returns
Pointer to signal info or nullptr.

Definition at line 73 of file tree_node.cpp.


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