Class encapsulated robot status data. The robot status data is meant to mirror the industrial_msgs/RobotStatus message.
More...
#include <robot_status.h>
Class encapsulated robot status data. The robot status data is meant to mirror the industrial_msgs/RobotStatus message.
The byte representation of a robot status is as follows (in order lowest index to highest). The standard sizes are given, but can change based on type sizes:
member: type size drives_powered (industrial::shared_types::shared_int) 4 bytes e_stopped (industrial::shared_types::shared_int) 4 bytes error_code (industrial::shared_types::shared_int) 4 bytes in_error (industrial::shared_types::shared_int) 4 bytes in_motion (industrial::shared_types::shared_int) 4 bytes mode (industrial::shared_types::shared_int) 4 bytes motion_possible (industrial::shared_types::shared_int) 4 bytes
THIS CLASS IS NOT THREAD-SAFE
Definition at line 118 of file robot_status.h.
◆ RobotStatus()
industrial::robot_status::RobotStatus::RobotStatus |
( |
void |
| ) |
|
Default constructor.
This method creates empty data.
Definition at line 115 of file robot_status.cpp.
◆ ~RobotStatus()
industrial::robot_status::RobotStatus::~RobotStatus |
( |
void |
| ) |
|
◆ byteLength()
unsigned int industrial::robot_status::RobotStatus::byteLength |
( |
| ) |
|
|
inlinevirtual |
◆ copyFrom()
void industrial::robot_status::RobotStatus::copyFrom |
( |
RobotStatus & |
src | ) |
|
◆ getDrivesPowered()
TriState industrial::robot_status::RobotStatus::getDrivesPowered |
( |
| ) |
|
|
inline |
◆ getErrorCode()
◆ getEStopped()
TriState industrial::robot_status::RobotStatus::getEStopped |
( |
| ) |
|
|
inline |
◆ getInError()
TriState industrial::robot_status::RobotStatus::getInError |
( |
| ) |
|
|
inline |
◆ getInMotion()
TriState industrial::robot_status::RobotStatus::getInMotion |
( |
| ) |
|
|
inline |
◆ getMode()
RobotMode industrial::robot_status::RobotStatus::getMode |
( |
| ) |
|
|
inline |
◆ getMotionPossible()
TriState industrial::robot_status::RobotStatus::getMotionPossible |
( |
| ) |
|
|
inline |
◆ init() [1/2]
void industrial::robot_status::RobotStatus::init |
( |
| ) |
|
◆ init() [2/2]
◆ load()
Virtual method for loading an object into a ByteArray.
This method should load all the required data to reconstruct the class object into the buffer
- Parameters
-
buffer | pointer to ByteArray |
- Returns
- true on success, false otherwise (buffer not large enough)
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 160 of file robot_status.cpp.
◆ operator==()
bool industrial::robot_status::RobotStatus::operator== |
( |
RobotStatus & |
rhs | ) |
|
== operator implementation
- Returns
- true if equal
Definition at line 153 of file robot_status.cpp.
◆ setDrivesPowered()
void industrial::robot_status::RobotStatus::setDrivesPowered |
( |
TriState |
drivesPowered | ) |
|
|
inline |
◆ setErrorCode()
◆ setEStopped()
void industrial::robot_status::RobotStatus::setEStopped |
( |
TriState |
eStopped | ) |
|
|
inline |
◆ setInError()
void industrial::robot_status::RobotStatus::setInError |
( |
TriState |
inError | ) |
|
|
inline |
◆ setInMotion()
void industrial::robot_status::RobotStatus::setInMotion |
( |
TriState |
inMotion | ) |
|
|
inline |
◆ setMode()
void industrial::robot_status::RobotStatus::setMode |
( |
RobotMode |
mode | ) |
|
|
inline |
◆ setMotionPossible()
void industrial::robot_status::RobotStatus::setMotionPossible |
( |
TriState |
motionPossible | ) |
|
|
inline |
◆ unload()
Virtual method for unloading an object from a ByteArray.
This method should unload all the required data to reconstruct the class object (in place)
- Parameters
-
buffer | pointer to ByteArray |
- Returns
- true on success, false otherwise (buffer not large enough)
Implements industrial::simple_serialize::SimpleSerialize.
Definition at line 183 of file robot_status.cpp.
◆ drives_powered_
◆ e_stopped_
◆ error_code_
◆ in_error_
◆ in_motion_
◆ mode_
◆ motion_possible_
The documentation for this class was generated from the following files: