Flexiv TDK APIs 1.7
Loading...
Searching...
No Matches
flexiv::tdk::TeleopIssue Struct Reference

One restriction or interruption that the operator should understand. More...

#include <data.hpp>

Public Attributes

TeleopIssueCode code = TeleopIssueCode::NONE
TeleopIssueLevel level = TeleopIssueLevel::INFO
TeleopIssueSide side = TeleopIssueSide::NONE
int joint_index = 0
bool active = false
bool motion_locked = false
bool forced_disengage = false
double value = 0.0
double threshold = 0.0
std::string title
std::string description
std::string suggestion

Detailed Description

Typical host usage: show [title] as a banner, [description] as the explanation, and [suggestion] as the next action. Use [code] if the UI needs a localized string table.

Examples
transparent_cartesian_teleop_wan.cpp, and transparent_cartesian_teleop_wan_pro.cpp.

Definition at line 338 of file data.hpp.

Member Data Documentation

◆ active

bool flexiv::tdk::TeleopIssue::active = false

True if this issue is happening now. False if it is the last remembered event after the condition has already cleared.

Definition at line 358 of file data.hpp.

◆ code

TeleopIssueCode flexiv::tdk::TeleopIssue::code = TeleopIssueCode::NONE

◆ description

std::string flexiv::tdk::TeleopIssue::description

What happened, English, for a non-expert operator.

Definition at line 379 of file data.hpp.

◆ forced_disengage

bool flexiv::tdk::TeleopIssue::forced_disengage = false

True if teleoperation was force-disengaged because of this issue.

Definition at line 364 of file data.hpp.

◆ joint_index

int flexiv::tdk::TeleopIssue::joint_index = 0

1-based joint index (A1 = 1). 0 if the issue is not joint-specific.

Definition at line 352 of file data.hpp.

◆ level

TeleopIssueLevel flexiv::tdk::TeleopIssue::level = TeleopIssueLevel::INFO

Presentation urgency.

Definition at line 344 of file data.hpp.

◆ motion_locked

bool flexiv::tdk::TeleopIssue::motion_locked = false

True if the controller froze motion to stop the condition from getting worse.

Definition at line 361 of file data.hpp.

◆ side

TeleopIssueSide flexiv::tdk::TeleopIssue::side = TeleopIssueSide::NONE

Which robot or the network this issue belongs to.

Definition at line 347 of file data.hpp.

◆ suggestion

std::string flexiv::tdk::TeleopIssue::suggestion

What the operator should do next, English.

Definition at line 382 of file data.hpp.

◆ threshold

double flexiv::tdk::TeleopIssue::threshold = 0.0

Limit that [value] was compared against. Same unit as [value].

Definition at line 373 of file data.hpp.

◆ title

std::string flexiv::tdk::TeleopIssue::title

Short operator-facing title, English.

Definition at line 376 of file data.hpp.

◆ value

double flexiv::tdk::TeleopIssue::value = 0.0

Measured quantity associated with the issue. Unit depends on [code]: latency in ms, joint position in rad, joint velocity in rad/s.

Definition at line 370 of file data.hpp.


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