Struct Entity 

pub struct Entity {
    pub name: String,
    pub parent: Option<Rc<Entity>>,
    pub id: Id,
    pub tracker: Tracker,
    /* private fields */
}

A simulation entity

An entity is a part of a hierarchical simulation in which it must have a parent. The simulation top-level should be created using toplevel("name").

The entity is used when logging so that its unique ID can be emitted and it can determine which messages are emitted to both the binary and textual outputs.

Fields

name: String

Name of this entity.

parent: Option<Rc<Entity>>

Optional parent entity (only the top-level should be None).

id: Id

Unique simulation identifier used for bin/log messages.

tracker: Tracker

Tracker used to handle trace/log events.

Implementations

impl Entity

pub fn new(parent: &Rc<Entity>, name: &str) -> Self

Create a new entity.

pub fn new_with_renames( parent: &Rc<Entity>, name: &str, aka: Option<&Aka>, ) -> Self

Create a new entity with a potential list of alternative names

pub fn full_name(&self) -> String

Returns the full hierarchical name of this entity

pub fn trace_enabled(&self) -> bool

Return whether trace-level events for this entity will be emitted.

pub fn enabled_for(&self, level: Level) -> bool

Return whether events at the given level will be emitted for this entity.

pub fn track_capacity(&self, value: usize, units: impl Into<String>)

Emit the capacity represented by this simulation entity.

pub fn track_enter(&self, entered: Id)

Emit an enter event for an object.

pub fn track_exit(&self, exited: Id)

Emit an exit event for an object.

Trait Implementations

impl Debug for Entity

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

Formats the value using the given formatter.

impl Display for Entity

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

Formats the value using the given formatter.

impl Drop for Entity

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.