DBC Framework
DBC parsing and CAN signal decoding framework
Loading...
Searching...
No Matches
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.
 
 TreeNode (const FrameInfo &frame)
 Create frame node.
 
 TreeNode (const SignalInfo &signal)
 Create signal node.
 
 TreeNode (const TreeNode &)=delete
 
TreeNode & operator= (const TreeNode &)=delete
 
 TreeNode (TreeNode &&)=default
 
TreeNode & operator= (TreeNode &&)=default
 
void AddChild (std::unique_ptr< TreeNode > child)
 Add child node.
 
std::size_t GetChildCount () const
 Get child count.
 
const TreeNode * GetChild (std::size_t index) const
 Get child by index.
 
TreeNode * GetChild (std::size_t index)
 Get mutable child by index.
 
NodeType GetType () const
 Get node type.
 
const std::string & GetName () const
 Get display name.
 
const FrameInfo * GetFrame () const
 Get frame payload if node is frame.
 
const SignalInfo * GetSignal () const
 Get signal payload if node is signal.
 

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 18 of file tree_node.cpp.

◆ TreeNode() [3/3]

TreeNode::TreeNode ( const SignalInfo &  signal)
explicit

Create signal node.

Parameters
signalSignal payload.

Definition at line 22 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 26 of file tree_node.cpp.

◆ GetChildCount()

std::size_t TreeNode::GetChildCount ( ) const

Get child count.

Returns
Number of children.

Definition at line 31 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 35 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 42 of file tree_node.cpp.

◆ GetType()

NodeType TreeNode::GetType ( ) const

Get node type.

Returns
Node type.

Definition at line 49 of file tree_node.cpp.

◆ GetName()

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

Get display name.

Returns
Node name.

Definition at line 53 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 57 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 61 of file tree_node.cpp.


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