State (automation interface)
A State is the Modeler Automation Interface object for the following items:
• Atomic State
• Concurrent State
• Entry State
• Exit State
• Final State
• Fork State
• History State
• Initial State
• Join State
• Junction State
• Sequential State
• Submachine State
To create a State through the Modeler Automation Interface, you must use the AddByType function. For more information, see
Add by Type.
ATTRIBUTES:
In addition to the
common attributes.
Description
A textual property that gives an overview of the dictionary item.
Access is read/write.
Is Deep History
A string that specifies whether a History State stores deep history. Possible values are TRUE or FALSE.
Is Deep History applies only when the UML State Type is set to History.
Access is read/write.
Is History State
A string that indicates whether a State represents a History State. Possible values are TRUE or FALSE.
Access is read-only.
Is Start State
A string that indicates whether a State represents an Initial State. Possible values are TRUE or FALSE.
Access is read-only.
Is Result State
A string that indicates whether a State represents a Final State. Possible values are TRUE or FALSE.
Access is read-only.
UML State Type
A string that specifies whether the State is an Atomic State, Concurrent State, Entry State, Exit State, Final State, Fork State, History State, Initial State, Join State, Junction State, Sequential State or Submachine State.
Possible values are as follows:
• Atomic
• Concurrent
• Entry
• Exit
• Final
• Fork
• History
• Initial
• Join
• Junction
• Sequential
• Submachine
Access is read/write.
ASSOCIATIONS:
In addition to the
common associations.
Relationship to Comments that are applied to the State.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are applied to the State.
Multiplicity is 0+, access is read/write.
Relationship to Connection Point References that are owned by the Submachine State.
The Connection Point Reference association applies only when the UML State Type is set to Submachine.
Multiplicity is 0+, access is read/write.
Do Activity
Relationship to Activities, Operations and State Machines that are do activities for the State.
The Do Activity association applies only when the UML State Type is set to Atomic, Sequential or Concurrent.
Multiplicity is 0+, access is read/write.
Relationship to Event Action Blocks that are owned by the State.
Multiplicity is 0+, access is read/write.
Relationship to Comments that are owned by the State.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are owned by the State.
Multiplicity is 0+, access is read/write.
Owned State
A collection of sub states of this state.
Multiplicity is 0+, access is read/write.
Owner
Relationship to the item owns the State.
Multiplicity is 1, access is read/write.
Scoping Item
The State Machine or Sequential State that owns the state.
Multiplicity is 1, access is read-only.
The State Machine that owns the State.
Multiplicity is 1, access is read-only.
Relationship to a Submachine's State Machine.
The Submachine State Machine association applies only when the UML State Type is set to Submachine.
Multiplicity is 0+, access is read/write.
Transition End
Relationship to Transitions that end at the state.
Multiplicity is 0+, access is read/write.
Transition From States
A collection of States that this State can transition from.
Multiplicity is 0+, access is read-only.
Transition Start
Relationship to Transitions that start from the State.
Multiplicity is 0+, access is read/write.
Transition To States
A collection of States that this State can transition to.
Multiplicity is 0+, access is read-only.