Biorbd
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
biorbd::utils::Node Class Referenceabstract

A node is an abstract element which is assigned to a parent. More...

#include <Node.h>

Inheritance diagram for biorbd::utils::Node:
biorbd::rigidbody::Segment biorbd::utils::RotoTransNode biorbd::utils::Vector3d biorbd::rigidbody::IMU biorbd::muscles::ViaPoint biorbd::muscles::WrappingObject biorbd::rigidbody::NodeSegment biorbd::muscles::WrappingCylinder biorbd::muscles::WrappingSphere

Public Member Functions

 Node ()
 Construct Node.
 
 Node (const biorbd::utils::Node &other)
 Construct Node from another node. More...
 
 Node (const biorbd::utils::String &name)
 Construct Node. More...
 
 Node (const biorbd::utils::String &name, const biorbd::utils::String &parentName)
 Construct Node. More...
 
virtual ~Node ()
 Destroy class properly.
 
void DeepCopy (const biorbd::utils::Node &other)
 Deep copy of the node in another node. More...
 
void setName (const biorbd::utils::String &name)
 Set the name of the node. More...
 
const biorbd::utils::Stringname () const
 Return the name of the node.
 
const biorbd::utils::Stringparent () const
 Return the parent name of the node.
 
void setParent (const biorbd::utils::String &name)
 Set the parent name of the node. More...
 
biorbd::utils::NODE_TYPE typeOfNode () const
 Return the type of node.
 

Protected Member Functions

virtual void setType ()=0
 To set the type.
 

Protected Attributes

std::shared_ptr< biorbd::utils::Stringm_name
 The name of the node.
 
std::shared_ptr< biorbd::utils::Stringm_parentName
 The parent name of the node.
 
std::shared_ptr< biorbd::utils::NODE_TYPE > m_typeOfNode
 The type of the node.
 

Detailed Description

A node is an abstract element which is assigned to a parent.

Definition at line 15 of file Node.h.

Constructor & Destructor Documentation

◆ Node() [1/3]

biorbd::utils::Node::Node ( const biorbd::utils::Node other)

Construct Node from another node.

Parameters
otherThe other node

Definition at line 14 of file Node.cpp.

◆ Node() [2/3]

biorbd::utils::Node::Node ( const biorbd::utils::String name)

Construct Node.

Parameters
nameName of the node

Definition at line 23 of file Node.cpp.

◆ Node() [3/3]

biorbd::utils::Node::Node ( const biorbd::utils::String name,
const biorbd::utils::String parentName 
)

Construct Node.

Parameters
nameName of the node
parentNameName of the parent of the node

Definition at line 31 of file Node.cpp.

Member Function Documentation

◆ DeepCopy()

void biorbd::utils::Node::DeepCopy ( const biorbd::utils::Node other)

Deep copy of the node in another node.

Parameters
otherThe node to copy

Definition at line 46 of file Node.cpp.

◆ setName()

void biorbd::utils::Node::setName ( const biorbd::utils::String name)

Set the name of the node.

Parameters
nameName to set

Definition at line 54 of file Node.cpp.

◆ setParent()

void biorbd::utils::Node::setParent ( const biorbd::utils::String name)

Set the parent name of the node.

Parameters
nameThe name of the parent

Definition at line 69 of file Node.cpp.


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