Automaton
A hybrid state machine that needs to be located on a CellularSpace, and is replicated over each Cell of the space. It has independent States in each Cell.
Arguments
- id: A string that names the Automanton.
Attributes
Some attributes of Automaton have internal semantics. They can be used as read-only by the modeler.
- parent: The Environment it belongs.
Usage
automaton = Automaton {
id = "MyAutomaton",
State {...},
-- ...
State {...}
}Functions
| add | Add a new Trajectory or State to the Automaton. |
| execute | Execute the State machine. |
| getId | Return the unique identifier name of the Automaton. |
| getState | Get a State of the Automaton according to a given position. |
| getStateName | Return the name of the current State. |
| getStates | Get all the States inside the Automaton. |
| notify | Notify every Observer connected to the Automaton. |
| setId | Set the unique identifier of the Automaton. |
| setTrajectoryStatus | Activate or not the Trajectories defined for the Automaton. |
add
Add a new Trajectory or State to the Automaton. It returns a boolean value indicating whether the new element was successfully added.
Arguments
- #1: A Trajectory or State.
Usage
automaton:add(state)
automaton:add(trajectory)execute
Execute the State machine. First, it executes the Jump of the current State while it jumps from State to State. When the machine stops jumping, it executes all the Flows of the current State. Usually, this function is called within an Event, thus the time of the Event can be got from the Timer. It returns a boolean value indicating whether the Jumps were executed correctly.
Arguments
- #1: An Event.
Usage
automaton:execute(event)getId
Return the unique identifier name of the Automaton.
Usage
automaton:getId()getState
Get a State of the Automaton according to a given position.
Arguments
- #1: A number indicating the position of the State to be retrieved.
Usage
state = automaton:getState(1)getStateName
Return the name of the current State. As an Automaton has independent States in each Cell, it requires a location to return its State name.
Arguments
- #1: A Cell.
Usage
id = automaton:getStateName(cell)getStates
Get all the States inside the Automaton. It returns a vector.
Usage
state = automaton:getStates()[1]notify
Notify every Observer connected to the Automaton.
Arguments
- #1: An integer number representing the notification time. The default value is zero. It is also possible to use an Event as argument. In this case, it will use the result of Event:getTime().
Usage
automaton:notify()setId
Set the unique identifier of the Automaton. Return a boolean value indicating whether the id was changed correctly.
Arguments
- #1: A string that names the Automaton.
Usage
automaton:setId("newid")setTrajectoryStatus
Activate or not the Trajectories defined for the Automaton. Returns whether the change was successfully executed. When the Automaton is built its status is not activated.
Arguments
- #1: A boolean that indicates if the Trajectories will be activated.
Usage
automaton:setTrajectoryStatus(true)