This reference describes unreleased code on main; no release documents it yet.

rlmesh::adapters::StateTag

structPreviewuse rlmesh::adapters::StateTag;[source]

A numeric proprioception entry in an environment observation.

struct StateTag

role

field[source]
role: String

Semantic role used for matching, e.g. proprio/eef_pos.

encoding

field[source]
encoding: Option<Vec<Tolerant<RotationEncoding>>>

Rotation encoding when the role is a rotation. A single encoding, or a sequence of them (the env’s native first, then alternatives it can emit) for cross-version negotiation.

range

field[source]
range: Option<(f64, f64)>

Optional (low, high) value range, supplying the bounds where the space leaves this leaf unbounded. If the space declares finite bounds that disagree with it, resolution errors rather than silently overriding them.

frame

field[source]
frame: Option<Tolerant<Frame>>

Coordinate frame this entry’s values are expressed in, when the role is an absolute pose (proprio/eef_*). Omitted from the wire when unset. A model that declares a different one fails resolution; a model that declares one the env does not draws a caution.

provenance

field[source]
provenance: Option<Tolerant<Provenance>>

Where this entry’s numbers come from: "sensed" (a physical sensor or its simulated equivalent), "estimated" (a state estimator) or "privileged" (simulator truth with no hardware counterpart). Part of the leaf’s identity, so an env may publish one role twice under two provenances; a model that declares one the env contradicts fails resolution. Omitted from the wire when unset.

part

field[source]
part: Option<String>

The body part this entry belongs to, when the role repeats across a body (LEFT_ARM, RIGHT_ARM, or any identifier both sides agree on). An identity key the resolver matches on; see ImageTag. Omitted from the wire when unset.

labels

field[source]
labels: Option<Vec<String>>

The axis names of this entry in the order the env emits them, one per element of the space leaf (checked at join). A model that names labels must name this same set; another order is gathered by name. Omitted from the wire when unset.

new

associated function[source]
fn new(role: impl Into<String>) -> Self

Construct a state tag with only its role declared.

Trait implementations

  • impl Clone for StateTag
  • impl Debug for StateTag
  • impl StructuralPartialEq for StateTag
  • impl PartialEq for StateTag
  • impl Serialize for StateTag
  • impl<'de> Deserialize<'de> for StateTag
  • impl Display for StateTag
  • impl From<StateTag> for ObsNode