Enum openrr_command::RobotCommand

pub enum RobotCommand {
    SendJoints {
        name: String,
        duration: f64,
        use_interpolation: bool,
        joint: Vec<(usize, f64)>,
        max_resolution_for_interpolation: f64,
        min_number_of_points_for_interpolation: i32,
    },
    SendJointsPose {
        name: String,
        pose_name: String,
        duration: f64,
    },
    MoveIk {
        name: String,
        x: Option<f64>,
        y: Option<f64>,
        z: Option<f64>,
        yaw: Option<f64>,
        pitch: Option<f64>,
        roll: Option<f64>,
        duration: f64,
        use_interpolation: bool,
        is_local: bool,
        max_resolution_for_interpolation: f64,
        min_number_of_points_for_interpolation: i32,
    },
    GetState {
        name: String,
    },
    LoadCommands {
        command_file_path: PathBuf,
    },
    List,
    Speak {
        name: String,
        message: Vec<String>,
    },
    ExecuteCommand {
        command: Vec<String>,
    },
    GetNavigationCurrentPose,
    SendNavigationGoal {
        x: f64,
        y: f64,
        yaw: f64,
        frame_id: String,
        timeout_secs: f64,
    },
    CancelNavigationGoal,
    SendBaseVelocity {
        x: f64,
        y: f64,
        theta: f64,
        duration_secs: f64,
    },
    ShellCompletion(ShellType),
}

Variants

SendJoints

Fields

name: String

duration: f64

use_interpolation: bool

Interpolate target in cartesian space. If you use this flag, joint values are not used as references but used in forward kinematics.

joint: Vec<(usize, f64)>

Specify joint parameters. Like --joint 0=1.2. In accordance with the sequence in which the “joint names” are defined in the configuration, they are numbered starting at 0.

max_resolution_for_interpolation: f64

min_number_of_points_for_interpolation: i32

Send joint positions.

SendJointsPose

Fields

name: String

pose_name: String

duration: f64

Send predefined joint positions.

MoveIk

Fields

name: String

x: Option<f64>

y: Option<f64>

z: Option<f64>

yaw: Option<f64>

pitch: Option<f64>

roll: Option<f64>

duration: f64

use_interpolation: bool

Interpolate target in cartesian space.

is_local: bool

max_resolution_for_interpolation: f64

min_number_of_points_for_interpolation: i32

Move with ik

GetState

Fields

name: String

Get joint positions and end pose if applicable.

LoadCommands

Fields

command_file_path: PathBuf

Load commands from file and execute them.

List

List available clients.

Speak

Fields

name: String

message: Vec<String>

Speak text message.

ExecuteCommand

Fields

command: Vec<String>

Execute an external command.

GetNavigationCurrentPose

Get navigation current pose.

SendNavigationGoal

Fields

x: f64

y: f64

yaw: f64

frame_id: String

timeout_secs: f64

Send navigation goal pose.

CancelNavigationGoal

Cancel navigation goal.

SendBaseVelocity

Fields

x: f64

y: f64

theta: f64

duration_secs: f64

Send base velocity.

ShellCompletion(ShellType)

Shell completion

Trait Implementations

impl CommandFactory for RobotCommand

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for RobotCommand

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

Formats the value using the given formatter.

impl FromArgMatches for RobotCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for RobotCommand

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for RobotCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand