Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::utils::Node Class Referenceabstract

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

#include <Node.h>

Inheritance diagram for BIORBD_NAMESPACE::utils::Node:
BIORBD_NAMESPACE::rigidbody::Segment BIORBD_NAMESPACE::utils::RotoTransNode BIORBD_NAMESPACE::utils::Vector2d BIORBD_NAMESPACE::utils::Vector3d BIORBD_NAMESPACE::rigidbody::IMU BIORBD_NAMESPACE::internal_forces::ViaPoint BIORBD_NAMESPACE::internal_forces::WrappingObject BIORBD_NAMESPACE::rigidbody::NodeSegment BIORBD_NAMESPACE::internal_forces::WrappingHalfCylinder BIORBD_NAMESPACE::internal_forces::WrappingSphere BIORBD_NAMESPACE::rigidbody::SoftContactNode BIORBD_NAMESPACE::rigidbody::SoftContactSphere

Public Member Functions

 Node ()
 Construct Node.
 Node (const Node &other)
 Construct Node from another node.
 Node (const String &name)
 Construct Node.
 Node (const String &name, const String &parentName)
 Construct Node.
virtual ~Node ()
 Destroy class properly.
void DeepCopy (const Node &other)
 Deep copy of the node in another node.
void setName (const String &name)
 Set the name of the node.
const String & name () const
 Return the name of the node.
const String & parent () const
 Return the parent name of the node.
void setParent (const String &name)
 Set the parent name of the node.
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< String > m_name
 The name of the node.
std::shared_ptr< String > m_parentName
 The parent name of the node.
std::shared_ptr< 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 17 of file Node.h.

Constructor & Destructor Documentation

◆ Node() [1/4]

utils::Node::Node ( )

Construct Node.

Definition at line 8 of file Node.cpp.

◆ Node() [2/4]

utils::Node::Node ( const Node & other)

Construct Node from another node.

Parameters
otherThe other node

Definition at line 14 of file Node.cpp.

◆ Node() [3/4]

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

Construct Node.

Parameters
nameName of the node

Definition at line 21 of file Node.cpp.

◆ Node() [4/4]

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

Construct Node.

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

Definition at line 27 of file Node.cpp.

◆ ~Node()

utils::Node::~Node ( )
virtual

Destroy class properly.

Definition at line 33 of file Node.cpp.

Member Function Documentation

◆ DeepCopy()

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

Deep copy of the node in another node.

Parameters
otherThe node to copy

Definition at line 35 of file Node.cpp.

◆ name()

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

Return the name of the node.

Returns
The name of the node

Definition at line 43 of file Node.cpp.

◆ parent()

const utils::String & utils::Node::parent ( ) const

Return the parent name of the node.

Returns
The parent name of the node

Definition at line 45 of file Node.cpp.

◆ setName()

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

Set the name of the node.

Parameters
nameName to set

Definition at line 41 of file Node.cpp.

◆ setParent()

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

Set the parent name of the node.

Parameters
nameThe name of the parent

Definition at line 47 of file Node.cpp.

◆ setType()

◆ typeOfNode()

utils::NODE_TYPE utils::Node::typeOfNode ( ) const

Return the type of node.

Returns
The type of node

Definition at line 49 of file Node.cpp.

Member Data Documentation

◆ m_name

std::shared_ptr<String> BIORBD_NAMESPACE::utils::Node::m_name
protected

The name of the node.

Definition at line 90 of file Node.h.

◆ m_parentName

std::shared_ptr<String> BIORBD_NAMESPACE::utils::Node::m_parentName
protected

The parent name of the node.

Definition at line 91 of file Node.h.

◆ m_typeOfNode

std::shared_ptr<NODE_TYPE> BIORBD_NAMESPACE::utils::Node::m_typeOfNode
protected

The type of the node.

Definition at line 92 of file Node.h.


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