Struct Model

pub struct Model<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> { /* private fields */ }

A complete model.

Implementations

impl<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>

pub fn with_validator( size: usize, last_agent_type: Rc<dyn AgentType<StateId, Payload>>, validator: <Self as MetaModel>::Validator, ) -> Self

Create a new model, without computing anything yet, with a validation function.

pub fn new( size: usize, last_agent_type: Rc<dyn AgentType<StateId, Payload>>, ) -> Self

Create a new model, without a validation function.

This allows querying the model for the agent_index of all the agents to use the results as a target for messages.

impl<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>

pub fn add_condition( &mut self, name: &'static str, condition: <Self as MetaModel>::Condition, help: &'static str, )

Add a named condition for defining paths through the configuration space.

pub fn agents_count(&self) -> usize

Return the total number of agents.

pub fn agent_label_index(&self, agent_label: &str) -> Option<usize>

Return the index of the agent with the specified label.

pub fn agent_instance(&self, agent_index: usize) -> usize

Return the index of the agent instance within its type.

pub fn agent_label(&self, agent_index: usize) -> &str

Return the label (short name) of an agent.

pub fn is_valid(&self) -> bool

Return whether all the reachable configurations are valid.

pub fn get_configuration( &self, configuration_id: ConfigurationId, ) -> <Self as MetaModel>::Configuration

Access a configuration by its identifier.

pub fn get_message(&self, message_id: MessageId) -> <Self as MetaModel>::Message

Access a message by its identifier.

impl<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>

pub fn display_message_id(&self, message_id: MessageId) -> &str

Display a message by its identifier.

pub fn display_message(&self, message: &<Self as MetaModel>::Message) -> String

Display a message.

pub fn display_configuration_id( &self, configuration_id: ConfigurationId, ) -> String

Display a configuration by its identifier.

Trait Implementations

impl<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> ClapModel for Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>

fn do_compute(&mut self, arg_matches: &ArgMatches<'_>)

Compute the model.

fn do_clap_agents( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the agents clap subcommand, if requested to.

fn do_clap_conditions( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the conditions clap subcommand, if requested to.

fn do_clap_compute( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Only compute the model (no output).

fn do_clap_configurations( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the configurations clap subcommand, if requested to.

fn do_clap_transitions( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the transitions clap subcommand, if requested to.

fn do_clap_path( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the path clap subcommand, if requested to.

fn do_clap_sequence( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the sequence clap subcommand, if requested to.

fn do_clap_states( &mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write, ) -> bool

Execute the states clap subcommand, if requested to.

fn do_clap(&mut self, arg_matches: &ArgMatches<'_>, stdout: &mut dyn Write)

Execute the chosen clap subcommand.

impl<StateId: IndexLike, MessageId: IndexLike, InvalidId: IndexLike, ConfigurationId: IndexLike, Payload: DataLike, const MAX_AGENTS: usize, const MAX_MESSAGES: usize> MetaModel for Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>

const MAX_AGENTS: usize = MAX_AGENTS

The maximal number of agents.

const MAX_MESSAGES: usize = MAX_MESSAGES

The maximal number of in-flight messages.

type StateId = StateId

The type of state identifiers.

type MessageId = MessageId

The type of message identifiers.

type InvalidId = InvalidId

The type of invalid condition identifiers.

type ConfigurationId = ConfigurationId

The type of configuration identifiers.

type Payload = Payload

The type of message payloads.

type AgentTypeRc = Rc<dyn AgentType<StateId, Payload>>

The type of boxed agent type.

type Message = Message<Payload>

The type of in-flight messages.

type Reaction = Reaction<StateId, Payload>

The type of a event handling by an agent.

type Action = Action<StateId, Payload>

The type of an action from an agent.

type Emit = Emit<Payload>

The type of an emitted messages.

type Invalid = Invalid<MessageId>

The type of invalid conditions.

type Configuration = Configuration<StateId, MessageId, InvalidId, MAX_AGENTS, MAX_MESSAGES>

The type of the included configurations.

type ConfigurationHashEntry = (Configuration<StateId, MessageId, InvalidId, MAX_AGENTS, MAX_MESSAGES>, ConfigurationId)

The type of a hash table entry for the configurations (should be cache-friendly).

type Validator = fn(&Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>, &Configuration<StateId, MessageId, InvalidId, MAX_AGENTS, MAX_MESSAGES>) -> Option<&'static str>

The type of a configuration validation function.

type Condition = fn(&Model<StateId, MessageId, InvalidId, ConfigurationId, Payload, MAX_AGENTS, MAX_MESSAGES>, &Configuration<StateId, MessageId, InvalidId, MAX_AGENTS, MAX_MESSAGES>) -> bool

A condition on model configurations.