Class VelocityLinear3DStamped

Defined in File velocity_linear_3d_stamped.hpp

Inheritance Relationships

Base Types

public fuse_variables::FixedSizeVariable< 3 > (Template Class FixedSizeVariable)
public fuse_variables::Stamped (Class Stamped)

Class Documentation

class VelocityLinear3DStamped : public fuse_variables::FixedSizeVariable<3>, public fuse_variables::Stamped 

Variable representing a 3D linear velocity (vx, vy, vz) at a specific time, with a specific piece of hardware.

This is commonly used to represent a robot’s velocity. The UUID of this class is static after construction. As such, the timestamp and device id cannot be modified. The value of the velocity can be modified.

Public Types

enum [anonymous]

Can be used to directly index variables in the data array.

Values:

enumerator X

enumerator Y

enumerator Z

Public Functions

VelocityLinear3DStamped() = default: Default constructor.

explicit VelocityLinear3DStamped(const rclcpp::Time &stamp, const fuse_core::UUID &device_ids = fuse_core::uuid::NIL)

Construct a 3D velocity at a specific point in time.

Parameters:

stamp – [in] The timestamp attached to this velocity.
device_id – [in] An optional device id, for use when variables originate from multiple robots or devices

inline double &x(): Read-write access to the X-axis linear velocity.

inline const double &x() const: Read-only access to the X-axis linear velocity.

inline double &y(): Read-write access to the Y-axis linear velocity.

inline const double &y() const: Read-only access to the Y-axis linear velocity.

inline double &z(): Read-write access to the Z-axis linear velocity.

inline const double &z() const: Read-only access to the Z-axis linear velocity.

void print(std::ostream &stream = std::cout) const override

Print a human-readable description of the variable to the provided stream.

Parameters:: stream – [out] The stream to write to. Defaults to stdout.

Friends

friend class boost::serialization::access