HEBI C++ API  3.11.1
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
hebi::robot_model::MetadataBase Class Reference

Base class for all metadata. Do not instantiate directly. More...

#include <robot_model.hpp>

Public Member Functions

 MetadataBase ()=default
 
 MetadataBase (const MetadataBase &)=delete
 
MetadataBaseoperator= (const MetadataBase &)=delete
 
 MetadataBase (MetadataBase &&)=default
 
MetadataBaseoperator= (MetadataBase &&)=default
 
ElementType elementType () const
 
const ActuatorMetadataasActuator () const
 View the actuator specific fields, if this metadata describes an actuator. More...
 
const BracketMetadataasBracket () const
 View the bracket specific fields, if this metadata describes a bracket. More...
 
const JointMetadataasJoint () const
 View the joint specific fields, if this metadata describes a joint. More...
 
const LinkMetadataasLink () const
 View the link specific fields, if this metadata describes a link. More...
 
const RigidBodyMetadataasRigidBody () const
 View the rigid body specific fields, if this metadata describes a rigid body. More...
 

Protected Member Functions

const HebiRobotModelElementMetadata & metadata () const
 

Friends

class RobotModel
 

Detailed Description

Base class for all metadata. Do not instantiate directly.

Constructor & Destructor Documentation

◆ MetadataBase() [1/3]

hebi::robot_model::MetadataBase::MetadataBase ( )
default

◆ MetadataBase() [2/3]

hebi::robot_model::MetadataBase::MetadataBase ( const MetadataBase )
delete

◆ MetadataBase() [3/3]

hebi::robot_model::MetadataBase::MetadataBase ( MetadataBase &&  )
default

Member Function Documentation

◆ operator=() [1/2]

MetadataBase& hebi::robot_model::MetadataBase::operator= ( const MetadataBase )
delete

◆ operator=() [2/2]

MetadataBase& hebi::robot_model::MetadataBase::operator= ( MetadataBase &&  )
default

◆ elementType()

ElementType hebi::robot_model::MetadataBase::elementType ( ) const
inline

◆ asActuator()

const ActuatorMetadata* hebi::robot_model::MetadataBase::asActuator ( ) const
inline

View the actuator specific fields, if this metadata describes an actuator.

Note: This will return nullptr if this metadata does not describe an actuator.

◆ asBracket()

const BracketMetadata* hebi::robot_model::MetadataBase::asBracket ( ) const
inline

View the bracket specific fields, if this metadata describes a bracket.

Note: This will return nullptr if this metadata does not describe a bracket.

◆ asJoint()

const JointMetadata* hebi::robot_model::MetadataBase::asJoint ( ) const
inline

View the joint specific fields, if this metadata describes a joint.

Note: This will return nullptr if this metadata does not describe a joint.

◆ asLink()

const LinkMetadata* hebi::robot_model::MetadataBase::asLink ( ) const
inline

View the link specific fields, if this metadata describes a link.

Note: This will return nullptr if this metadata does not describe a link.

◆ asRigidBody()

const RigidBodyMetadata* hebi::robot_model::MetadataBase::asRigidBody ( ) const
inline

View the rigid body specific fields, if this metadata describes a rigid body.

Note: This will return nullptr if this metadata does not describe a rigid body.

◆ metadata()

const HebiRobotModelElementMetadata& hebi::robot_model::MetadataBase::metadata ( ) const
inlineprotected

Friends And Related Function Documentation

◆ RobotModel

friend class RobotModel
friend

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