Struct robot_description_builder::Robot

pub struct Robot { /* private fields */ }

Implementations

impl Robot

pub fn name(&self) -> &String

Gets a refence to the name of the Robot

Example

let robot: Robot = LinkBuilder::new("my-link")
    .build_tree()
    .to_robot("my-robot-called-rob");

assert_eq!(robot.name(), "my-robot-called-rob")

Trait Implementations

impl Debug for Robot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl KinematicInterface for Robot

fn get_root_link(&self) -> Arc<RwLock<Link>>

Returns the root link of the Kinematic Tree

fn get_newest_link(&self) -> Arc<RwLock<Link>>

Returns the newest link of the Kinematic Tree

fn get_links(&self) -> Arc<RwLock<HashMap<String, Weak<RwLock<Link>>>>>

fn get_joints(&self) -> Arc<RwLock<HashMap<String, Weak<RwLock<Joint>>>>>

fn get_materials( &self ) -> Arc<RwLock<HashMap<String, Arc<RwLock<MaterialData>>>>>

FIXME: This not Ok end-user should not interact wiht MaterialData

fn get_transmissions( &self ) -> Arc<RwLock<HashMap<String, Arc<RwLock<Transmission>>>>>

fn get_link(&self, name: &str) -> Option<Arc<RwLock<Link>>>

fn get_joint(&self, name: &str) -> Option<Arc<RwLock<Joint>>>

fn get_material(&self, name: &str) -> Option<Material>

fn get_transmission(&self, name: &str) -> Option<Arc<RwLock<Transmission>>>

fn try_add_transmission( &self, transmission: TransmissionBuilder<WithJoints, WithActuator> ) -> Result<(), AddTransmissionError>

TODO: NOT FINAL TODO: Maybe remove rcrefcell from transmission parameter

fn purge_links( &self ) -> Result<(), PoisonError<RwLockWriteGuard<'_, HashMap<String, Weak<RwLock<Link>>>>>>

Cleans up orphaned/broken Link entries from the links HashMap.

fn purge_joints( &self ) -> Result<(), PoisonError<RwLockWriteGuard<'_, HashMap<String, Weak<RwLock<Joint>>>>>>

Cleans up orphaned/broken Joint entries from the joints HashMap.

fn purge_materials( &self ) -> Result<(), PoisonError<RwLockWriteGuard<'_, HashMap<String, Arc<RwLock<MaterialData>>>>>>

Cleans up orphaned/unused Material entries from material_index HashMap

fn purge_transmissions( &self ) -> Result<(), PoisonError<RwLockWriteGuard<'_, HashMap<String, Arc<RwLock<Transmission>>>>>>

Cleans up orphaned/broken Transmission entries from the transmissions HashMap

fn yank_link(&self, name: &str) -> Option<Chained<LinkBuilder>>

TODO: DOCS

fn yank_root(self) -> Chained<LinkBuilder>

Cosumes the KinematicInterface implementor and creates a Chained<LinkBuilder> to rebuild it.

fn yank_joint(&self, name: &str) -> Option<Chained<JointBuilder>>

impl ToURDF for Robot

fn to_urdf( &self, writer: &mut Writer<Cursor<Vec<u8>>>, urdf_config: &URDFConfig ) -> Result<(), Error>

Represents the element as in URDF format.