hebi::robot_model::MetadataBase Class Reference

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

#include <robot_model.hpp>

Inheritance diagram for hebi::robot_model::MetadataBase:

Public Member Functions
const ActuatorMetadata *	asActuator () const
	View the actuator specific fields, if this metadata describes an actuator. More...
const BracketMetadata *	asBracket () const
	View the bracket specific fields, if this metadata describes a bracket. More...
const JointMetadata *	asJoint () const
	View the joint specific fields, if this metadata describes a joint. More...
const LinkMetadata *	asLink () const
	View the link specific fields, if this metadata describes a link. More...
const RigidBodyMetadata *	asRigidBody () const
	View the rigid body specific fields, if this metadata describes a rigid body. More...
ElementType	elementType () const
	MetadataBase ()=default
	MetadataBase (const MetadataBase &)=delete
	MetadataBase (MetadataBase &&)=default
MetadataBase &	operator= (const MetadataBase &)=delete
MetadataBase &	operator= (MetadataBase &&)=default

Protected Member Functions
const HebiRobotModelElementMetadata &	metadata () const

Private Attributes
HebiRobotModelElementMetadata	metadata_

Friends
class	RobotModel

Detailed Description

Base class for all metadata. Do not instantiate directly.

Definition at line 274 of file robot_model.hpp.

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

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.

Definition at line 292 of file robot_model.hpp.

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.

Definition at line 304 of file robot_model.hpp.

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.

Definition at line 316 of file robot_model.hpp.

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.

Definition at line 328 of file robot_model.hpp.

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.

Definition at line 340 of file robot_model.hpp.

elementType()

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

inline

Definition at line 283 of file robot_model.hpp.

metadata()

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

inlineprotected

Definition at line 349 of file robot_model.hpp.

operator=() [1/2]

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

delete

operator=() [2/2]

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

default

Friends And Related Function Documentation

RobotModel

friend class RobotModel

friend

Definition at line 275 of file robot_model.hpp.

Member Data Documentation

metadata_

HebiRobotModelElementMetadata hebi::robot_model::MetadataBase::metadata_

private

Definition at line 351 of file robot_model.hpp.

---

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

• robot_model.hpp