Struct AgentTypeData

pub struct AgentTypeData<State: DataLike, StateId: IndexLike, Payload: DataLike> { /* private fields */ }

The data we need to implement an agent type.

This should be placed in a Singleton to allow the agent states to get services from it.

Implementations

impl<State: DataLike, StateId: IndexLike, Payload: DataLike> AgentTypeData<State, StateId, Payload>

pub fn new( name: &'static str, instances: Instances, prev_agent_type: Option<Rc<dyn AgentType<StateId, Payload>>>, ) -> Self

Create new agent type data with the specified name and number of instances.

pub fn set_order(&mut self, instance: usize, order: usize)

Set the horizontal order of an instance of the agent in a sequence diagram.

pub fn get_state(&self, state_id: StateId) -> State

Access the actual state by its identifier.

Trait Implementations

impl<State: DataLike, StateId: IndexLike, Payload: DataLike> AgentInstances<StateId, Payload> for AgentTypeData<State, StateId, Payload>

fn prev_agent_type(&self) -> Option<Rc<dyn AgentType<StateId, Payload>>>

Return the previous agent type in the chain, if any.

fn first_index(&self) -> usize

The index of the first agent of this type.

fn next_index(&self) -> usize

The next index after the last agent of this type.

fn is_singleton(&self) -> bool

Whether this type only has a single instance.

fn instances_count(&self) -> usize

The number of agents of this type that will be used in the system.

fn instance_order(&self, instance: usize) -> usize

The order of the agent (for sequence diagrams).

fn display_state(&self, state_id: StateId) -> Rc<String>

Display the state.

fn terse_id(&self, state_id: StateId) -> StateId

Convert the full state identifier to the terse state identifier.

fn display_terse(&self, terse_id: StateId) -> String

Return the name of the terse state (just the state name).

impl<State: DataLike + AgentState<State, Payload>, StateId: IndexLike, Payload: DataLike> AgentType<StateId, Payload> for AgentTypeData<State, StateId, Payload>

fn reaction( &self, instance: usize, state_ids: &[StateId], payload: &Payload, ) -> Reaction<StateId, Payload>

Return the actions that may be taken by an agent instance with some state when receiving a payload.

fn activity(&self, instance: usize, state_ids: &[StateId]) -> Activity<Payload>

Return the actions that may be taken by an agent with some state when time passes.

fn state_is_deferring(&self, instance: usize, state_ids: &[StateId]) -> bool

Whether any agent in the state is deferring messages.

fn state_invalid_because( &self, instance: usize, state_ids: &[StateId], ) -> Option<&'static str>

Return a reason that a state is invalid (unless it is valid).

fn state_max_in_flight_messages( &self, instance: usize, state_ids: &[StateId], ) -> Option<usize>

The maximal number of messages sent by an agent which may be in-flight when it is in the state.

fn states_count(&self) -> usize

The total number of states seen so far.

fn compute_terse(&self)

Compute mapping from full states to terse states (name only).

impl<State: DataLike, StateId: IndexLike, Payload: DataLike> Name for AgentTypeData<State, StateId, Payload>

fn name(&self) -> String

impl<State: DataLike, StateId: IndexLike, Payload: DataLike> PartType<State, StateId> for AgentTypeData<State, StateId, Payload>

fn part_state_by_id(&self, state_id: StateId) -> State

Access the part state by the state identifier.

fn part_first_index(&self) -> usize

The index of the first agent of this type.

fn parts_count(&self) -> usize

The number of agent instances of this type.