Struct ObsMetadata 

pub struct ObsMetadata {
    pub tick_id: TickId,
    pub age_ticks: u64,
    pub coverage: f64,
    pub world_generation_id: WorldGenerationId,
    pub parameter_version: ParameterVersion,
}

Metadata accompanying an observation extraction.

Populated by ObsPlan::execute from the snapshot being observed. All six fields are guaranteed to be set.

Fields

tick_id: TickId

Tick at which the observed snapshot was produced.

age_ticks: u64

Age of the snapshot relative to the current engine tick. In Lockstep mode this is always 0. In RealtimeAsync it may be > 0 if reading a stale snapshot.

coverage: f64

Fraction of the observation tensor filled with valid data (i.e., valid_ratio from the region plan).

world_generation_id: WorldGenerationId

Arena generation of the observed snapshot.

parameter_version: ParameterVersion

Parameter version at the time of the snapshot.

Trait Implementations

impl Clone for ObsMetadata

fn clone(&self) -> ObsMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObsMetadata

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

Formats the value using the given formatter.

impl PartialEq for ObsMetadata

fn eq(&self, other: &ObsMetadata) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ObsMetadata