sdf::v12::InterfaceJoint Class Reference

Interface element representing a Joint. More...

#include <InterfaceJoint.hh>

Public Member Functions
	InterfaceJoint (const std::string &_name, const std::string &_childName, const ignition::math::Pose3d &_pose)
	Constructor. More...
const std::string &	ChildName () const
	Get the name of the joint's child. More...
const std::string &	Name () const
	Get the name of the joint. More...
const ignition::math::Pose3d &	PoseInChildFrame () const
	Get the pose of this joint in the child frame. More...

Detailed Description

Interface element representing a Joint.

Constructor & Destructor Documentation

InterfaceJoint()

sdf::v12::InterfaceJoint::InterfaceJoint	(	const std::string &	_name,
		const std::string &	_childName,
		const ignition::math::Pose3d &	_pose
	)

Constructor.

Parameters

[in]	name	The local name.
[in]	_childName	Name of the child link or frame.
[in]	_pose	The pose of the joint relative to the child frame.

Member Function Documentation

ChildName()

const std::string& sdf::v12::InterfaceJoint::ChildName

(

)

const

Get the name of the joint's child.

Returns

The name of the joint's child link or frame.

Name()

const std::string& sdf::v12::InterfaceJoint::Name

(

)

const

Get the name of the joint.

Returns

Local name of the joint.

PoseInChildFrame()

const ignition::math::Pose3d& sdf::v12::InterfaceJoint::PoseInChildFrame

(

)

const

Get the pose of this joint in the child frame.

Returns

The pose of this joint in the child frame.

---

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

• InterfaceJoint.hh