Struct EventBuilder 

pub struct EventBuilder { /* private fields */ }

Fluent builder for UDM events.

Example

use phytrace_sdk::core::{EventBuilder, PhyTraceConfig};
use phytrace_sdk::{EventType, SourceType};

let config = PhyTraceConfig::new("robot-001")
    .with_source_type(SourceType::Amr);

let event = EventBuilder::new(&config)
    .event_type(EventType::TelemetryPeriodic)
    .position_local(10.0, 20.0, 0.0)
    .heading_deg(90.0)
    .battery_soc(85.0)
    .build()
    .unwrap();

Implementations

impl EventBuilder

pub fn new(config: &PhyTraceConfig) -> Self

Create a new event builder with configuration.

pub fn event_type(self, event_type: EventType) -> Self

Set the event type.

pub fn source_type(self, source_type: SourceType) -> Self

Override the source type.

pub fn source_id(self, source_id: impl Into<String>) -> Self

Set the source ID (robot/system identifier). This sets both the top-level source_id (for PhyCloud) and the identity domain.

pub fn model_info( self, _manufacturer: impl Into<String>, model: impl Into<String>, firmware: impl Into<String>, ) -> Self

Set model/firmware information.

pub fn tag(self, tag: impl Into<String>) -> Self

Add a tag.

pub fn position_local(self, x: f64, y: f64, z: f64) -> Self

Set local position (x, y, z in meters).

pub fn position_2d(self, x: f64, y: f64) -> Self

Set 2D position (convenience for x, y only).

pub fn position_3d(self, x: f64, y: f64, z: f64) -> Self

Set 3D position (convenience alias).

pub fn heading_deg(self, heading: f64) -> Self

Set heading in degrees (0-360).

pub fn heading(self, heading_rad: f64) -> Self

Set heading in radians (converted to degrees).

pub fn gps(self, latitude: f64, longitude: f64) -> Self

Set GPS coordinates.

pub fn floor(self, floor: i32) -> Self

Set floor number.

pub fn map(self, map_id: impl Into<String>, frame_id: impl Into<String>) -> Self

Set map ID and frame.

pub fn linear_velocity(self, vx: f64, vy: f64, vz: f64) -> Self

Set linear velocity (m/s).

pub fn angular_velocity( self, roll_rps: f64, pitch_rps: f64, yaw_rps: f64, ) -> Self

Set angular velocity (rad/s) - converts to degrees/s internally.

pub fn speed(self, speed_mps: f64) -> Self

Set speed (m/s) - for 2D motion.

pub fn battery_soc(self, soc_percent: f64) -> Self

Set battery state of charge (0-100%).

pub fn battery_voltage(self, voltage_v: f64) -> Self

Set battery voltage.

pub fn battery_health(self, health_percent: f64) -> Self

Set battery health (0-100%).

pub fn charging(self, is_charging: bool) -> Self

Set charging status.

pub fn operational_mode(self, mode: OperationalMode) -> Self

Set operational mode.

pub fn operational_state(self, state: OperationalState) -> Self

Set operational state.

pub fn task( self, task_id: impl Into<String>, task_type: impl Into<String>, ) -> Self

Set current task.

pub fn safety_state(self, state: SafetyState) -> Self

Set safety state.

pub fn estop_active(self, active: bool) -> Self

Set e-stop status.

pub fn localization_quality(self, quality: LocalizationQuality) -> Self

Set localization quality.

pub fn path_state(self, state: PathState) -> Self

Set path state.

pub fn identity(self, identity: IdentityDomain) -> Self

Set the full identity domain.

pub fn location(self, location: LocationDomain) -> Self

Set the full location domain.

pub fn motion(self, motion: MotionDomain) -> Self

Set the full motion domain.

pub fn power(self, power: PowerDomain) -> Self

Set the full power domain.

pub fn operational(self, operational: OperationalDomain) -> Self

Set the full operational domain.

pub fn navigation(self, navigation: NavigationDomain) -> Self

Set the full navigation domain.

pub fn perception(self, perception: PerceptionDomain) -> Self

Set the full perception domain.

pub fn safety(self, safety: SafetyDomain) -> Self

Set the full safety domain.

pub fn actuators(self, actuators: ActuatorsDomain) -> Self

Set the full actuators domain.

pub fn communication(self, communication: CommunicationDomain) -> Self

Set the full communication domain.

pub fn compute(self, compute: ComputeDomain) -> Self

Set the full compute domain.

pub fn ai(self, ai: AiDomain) -> Self

Set the full AI domain.

pub fn maintenance(self, maintenance: MaintenanceDomain) -> Self

Set the full maintenance domain.

pub fn context(self, context: ContextDomain) -> Self

Set the full context domain.

pub fn payload(self, payload: PayloadDomain) -> Self

Set the full payload domain.

pub fn manipulation(self, manipulation: ManipulationDomain) -> Self

Set the full manipulation domain.

pub fn hri(self, hri: HriDomain) -> Self

Set the full HRI domain.

pub fn coordination(self, coordination: CoordinationDomain) -> Self

Set the full coordination domain.

pub fn simulation(self, simulation: SimulationDomain) -> Self

Set the full simulation domain.

pub fn thermal(self, thermal: ThermalDomain) -> Self

Set the full thermal domain.

pub fn audio(self, audio: AudioDomain) -> Self

Set the full audio domain.

pub fn environment_interaction( self, environment_interaction: EnvironmentInteractionDomain, ) -> Self

Set the full environment interaction domain.

pub fn compliance(self, compliance: ComplianceDomain) -> Self

Set the full compliance domain.

pub fn extensions(self, extensions: Value) -> Self

Set custom extensions.

pub fn build(self) -> PhyTraceResult<UdmEvent>

Build the event, validating and optionally signing.

pub fn build_unchecked(self) -> UdmEvent

Build without validation.

pub fn peek(&self) -> &UdmEvent

Get a reference to the event being built.

Trait Implementations

impl Clone for EventBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.