systemcomposer.activity.TimeAction

R2026b

Time action node in activity diagram

Since R2026b

Description

A TimeAction object represents a time action node in an activity diagram model. A time action node outputs a control token after a specified duration or at a specific simulation time.

Creation

Create a time action node in an activity diagram using the addNode function with the nodeType argument specified as timeaction.

timeAction1 = addNode(activity,'Warmup Delay','timeaction');

Properties

expand all

`EventType` — Time mode of time action node
`Absolute` (default) | `Relative`

Time mode of the time action node, specified as one of these options:

Absolute — Node activates when the simulation clock reaches the specified time value.
Relative — Node activates when the specified duration elapses after the input control token arrives.

Dependencies

When TimeMode is set to Relative, the time action node requires an input control flow.

Data Types: char

`TimeValue` — Time value for time delay
positive double

Time value for the time delay, specified as a positive double in simulation time units. The time expression appears below the node on the canvas as for relative mode or at T for absolute mode.

Data Types: double

`Parent` — Activity that contains time action node
activity object

Activity that contains the time action node, specified as a systemcomposer.activity.Activity object.

`Name` — Name of time action node
character vector

Name of time action node, specified as a character vector.

Example: 'Warmup Delay'

Data Types: char

`Position` — Position on canvas
vector of coordinates

Position on canvas, specified as a vector of coordinates, in pixels: [left top right bottom].

Each vector specifies the location of the top left corner and bottom right corner of the component, specified as a 1-by-4 numeric array. The array denotes the top left corner in terms of its x and y coordinates followed by the x and y coordinates of the bottom right corner.

Data Types: double

`Model` — Parent activity diagram model
model object

Parent activity diagram model, specified as a systemcomposer.activity.Model object.

`SimulinkHandle` — Simulink handle
double

Simulink^® handle, specified as a double.

This property is necessary for several Simulink workflows and for using Requirements Toolbox™ programmatic interfaces.

Example: handle = get(object,'SimulinkHandle')

Data Types: double

`UUID` — Universal unique identifier
character vector

Universal unique identifier, specified as a character vector.

Example: '91d5de2c-b14c-4c76-a5d6-5dd0037c52df'

Data Types: char

`ExternalUID` — Unique external identifier
character vector

Unique external identifier, specified as a character vector. The external ID is preserved over the lifespan of the element and through all operations that preserve the UUID.

Data Types: char

Object Functions

`applyStereotype`	Apply stereotype to model element
`changeStereotype`	Change currently applied stereotype to new stereotype in its stereotype hierarchy
`destroy`	Remove model element
`getFlow`	Get flow from activity diagram
`getPins`	Get pins from action node
`getStereotypes`	Get stereotypes applied on model element
`hasStereotype`	Find if element has stereotype applied
`removeStereotype`	Remove stereotype from profile
`connect`	Create activity diagram flows

Examples

collapse all

Create Time Action Nodes in Activity Diagram

Create an activity diagram model and get the root activity.

adModel = systemcomposer.createActivity("timeActionModel");
activity = get(adModel,"Activity");

Add an initial node, an action node, and an activity final node.

initialNode = addNode(activity,"Start","initial");
action1 = addNode(activity,"Process Data","action");
finalNode = addNode(activity,"End","activityfinal");

Add a time action node with a relative time delay. A relative time action delays execution by a specified duration after the input control token arrives.

warmupDelay = addNode(activity,"Warmup Delay","timeaction");
warmupDelay.EventType = "relative";
warmupDelay.TimeValue = 5

warmupDelay =

  TimeAction with properties:

              EventType: Relative
              TimeValue: 5
                 Parent: [1×1 systemcomposer.activity.Activity]
                   Pins: [0×0 systemcomposer.activity.Pin]
                   Name: 'Warmup Delay'
               Position: [230 245 270 295]
                  Model: [1×1 systemcomposer.activity.Model]
         SimulinkHandle: 178.0001
    SimulinkModelHandle: 159.0004
                   UUID: 'e3ac4720-8876-4c63-83ea-f706ebed5872'
            ExternalUID: ''

Add a second time action node with an absolute time. An absolute time action activates when the simulation clock reaches the specified time value.

timeout = addNode(activity,"Timeout","timeaction");
timeout.EventType = "absolute";
timeout.TimeValue = 30

timeout =

  TimeAction with properties:

              EventType: Absolute
              TimeValue: 30
                 Parent: [1×1 systemcomposer.activity.Activity]
                   Pins: [0×0 systemcomposer.activity.Pin]
                   Name: 'Timeout'
               Position: [230 245 270 295]
                  Model: [1×1 systemcomposer.activity.Model]
         SimulinkHandle: 179.0001
    SimulinkModelHandle: 159.0004
                   UUID: 'a11a0fff-6431-40bb-90ff-660b495a9ee8'
            ExternalUID: ''

Connect nodes to create the activity flow. The relative time action delays execution between the initial node and the action, while the absolute time action provides a timeout path to the final node.

connect(initialNode,warmupDelay);
connect(warmupDelay,action1);
connect(action1,finalNode);
connect(timeout,finalNode);

More About

expand all

Definitions

Term	Definition	Application	More Information
Activity	An activity describes system behavior that models the flow of tokens from inputs to outputs through a controlled sequence of actions. An activity contains activity nodes and flows.	Use activity elements to create a clear, visual representation of the workflow like a dynamic flow chart. You can use an activity object either at the top level of the model or as a nested activity within an action to describe behavior at different levels of the system.	Describe System Behavior Using Activity Diagrams
Activity Diagram	An activity diagram is a visual representation of an activity.	Use activity diagram to conceptualize a system, visualize functional flow through actions or decisions, and understand how system components interact with one another.	Create New Activity Diagram
Model	An activity diagram model is the file that contains activity information, such as action nodes, control nodes, flows and tokens.	Perform operations on a model including extracting top-level activity, applying profiles or linking interface data dictionaries. An activity model is stored as an SLX file.	Author a Simple Activity Diagram Establish Traceability and Extend Model Elements
Token	Tokens are objects that flow in the activity diagram. A token can represent data such as structures and integers, or a token can simply pass on the control.	An object token represents an object, such as a piece of data. A control token represents a control or a triggering event that does not carry any data.	Use Control Nodes to Manipulate Token Flows Use MATLAB Action Node Without MATLAB Function to Initialize Object Token
Action node	An action node is a key building block in an activity diagram. An action node represents an action to be executed. Action nodes consume input tokens and produce output tokens on pins.	Use a MATLAB^® function or a nested activity diagram to describe the behavior of an action node.	Author Action Node with MATLAB Function Behavior Use Nested Activity to Describe Action
Control node	A control node routes a logical flow of tokens through the system.	Use control nodes and flows to route tokens. Control nodes can be used to initialize, split, merge, and terminate token flows.	Use Control Nodes to Manipulate Token Flows
Pin	A pin acts as a buffer for object tokens and directs tokens into or out of an action node. The directionality of the pin represents input or output. You can connect pins by object flows.	Use pins to route an object token to or from an Action Node. Pins are also used to store object tokens before or during execution. You can use pins only for object flows.	Types Editor
Type	A type defines the contents of a token that flows through a pin. A type has dimension, unit, complexity, minimum, maximum and description.	A value type token is a type assigned to a single value. A composite type token is equivalent to a bus structure that contains field of different values and data types. A MATLAB class type token references a MATLAB class on the path that defines a complex object with properties and methods. You can use a built-in MATLAB class or define your own MATLAB class.	Action Node Model Complex Objects in Activity Diagrams Using MATLAB Class Tokens
Parameter node	A parameter node routes tokens into or out of a nested activity diagram. When a pin is created, a corresponding parameter node will be created inside the nested activity.	Use a parameter node to define how tokens enter or leave a nested activity. There are two types of parameter nodes input and output.	Use Nested Activity to Describe Action
Flow	A flow in an activity diagram connects two nodes. A dashed line represents a control flow. A solid line represents an object flow.	Tokens in an object flow contains token data on which actions operate. You can use object flows to route input or output tokens to carry information or physical items between object nodes. Tokens in a control flow trigger the execution of actions. You can use control flows to model transfer of control from one Action Node to another.	Simulate, Visualize, and Validate Activity Diagrams

Version History

Introduced in R2026b

systemcomposer.activity.TimeAction

Description

Creation

Properties

`EventType` — Time mode of time action node
`Absolute` (default) | `Relative`

Dependencies

`TimeValue` — Time value for time delay
positive double

`Parent` — Activity that contains time action node
activity object

`Name` — Name of time action node
character vector

`Position` — Position on canvas
vector of coordinates

`Model` — Parent activity diagram model
model object

`SimulinkHandle` — Simulink handle
double

`UUID` — Universal unique identifier
character vector

`ExternalUID` — Unique external identifier
character vector

Object Functions

Examples

Create Time Action Nodes in Activity Diagram

More About

Definitions

Version History

See Also

Functions

Objects

Tools

Blocks

Topics

systemcomposer.activity.TimeAction

Description

Creation

Properties

EventType — Time mode of time action node Absolute (default) | Relative

Dependencies

TimeValue — Time value for time delay positive double

Parent — Activity that contains time action node activity object

Name — Name of time action node character vector

Position — Position on canvas vector of coordinates

Model — Parent activity diagram model model object

SimulinkHandle — Simulink handle double

UUID — Universal unique identifier character vector

ExternalUID — Unique external identifier character vector

Object Functions

Examples

Create Time Action Nodes in Activity Diagram

More About

Definitions

Version History

See Also

Functions

Objects

Tools

Blocks

Topics

`EventType` — Time mode of time action node
`Absolute` (default) | `Relative`

`TimeValue` — Time value for time delay
positive double

`Parent` — Activity that contains time action node
activity object

`Name` — Name of time action node
character vector

`Position` — Position on canvas
vector of coordinates

`Model` — Parent activity diagram model
model object

`SimulinkHandle` — Simulink handle
double

`UUID` — Universal unique identifier
character vector

`ExternalUID` — Unique external identifier
character vector