Operation (automation interface)
An operation is a behavioral feature of a classifier that specifies the name, type, parameters, and constraints for invoking an associated behavior.
ATTRIBUTES:
In addition to the
common attributes
Access
This indicates the visibility of the Operation. Possible values are Public, Protected, Private or Package.
By default the Access will be Public.
Access is read/write.
Ada Text
A textual property that returns the Body code of an Operation with Model Object Reference names changed as necessary through the Ada code's Ada_mangle.ini file.
Access is read-only.
See also, Body, C Text, C++ Text, Java Text, Text, Token RTF and Token Text.
Binding
This indicates how calls to the Operation are bound. Possible values are At Compile or At Runtime.
The default value of Binding is At Compile.
Access is read/write.
Body
A rich text property that specifies the Body code of an Operation as rich text.
Access is read/write.
See also, Ada Text, C Text, C++ Text, Java Text, Text, Token RTF and Token Text.
C Text
A textual property that returns the Body code of an Operation with Model Object Reference names changed as necessary through the C code's C_mangle.ini file.
Access is read-only.
See also, Ada Text, Body, C++ Text, Java Text, Text, Token RTF and Token Text.
C++ Text
A textual property that returns the Body code of an Operation with Model Object Reference names changed as necessary through the C++ code's mangle.ini file.
Access is read-only.
See also, Ada Text, Body, C Text, Java Text, Text, Token RTF and Token Text.
Data Usage
This indicates what data the Operation uses. Possible values are Instance Data, Class Data or Instance And Class Data.
The default value of Data Usage is Instance Data.
Access is read/write.
Description
A textual property that gives an overview of the dictionary item.
Access is read/write.
Duration
A textual property that specifies the length of time that the receiving object takes in consuming the Operation, including the units used.
Access is read/write.
Exception Order
A Cr/Lf separated list of ordered Exceptions.
Access is read/write.
You can use the ReorderItem function to change the order of the Exceptions. For more information, click here
.
Immutable
A string indicating whether the Operation is immutable. Possible values are TRUE or FALSE.
Access is read/write.
Effective Language
A derived string that specifies the Code Editor language that is used to edit the Body property of an Operation in Modeler when no value is set for the Language attribute.
If the Language and Effective Language attributes are both blank, the Code Editor uses the default language of C++.
When a value is set for the Language attribute, the Effective Language attribute is blank.
For information about how the Code Editor language can be derived, click here
.Access is read-only.
Language
A string that specifies the Code Editor language that is used to edit the Body property of an Operation in Modeler.
If no Language value is set, the Code Editor uses the language that is specified by the derived Effective Language attribute.
For information about the supported languages, click here
.
Access is read/write.
Is Abstract
A string indicating whether the Operation is abstract. Possible values are TRUE or FALSE.
Access is read/write.
Java Text
A textual property that returns the Body code of an Operation with Model Object Reference names changed as necessary through the Java code's mangle.ini file.
Access is read-only.
See also, Ada Text, Body, C Text, C++ Text, Text, Token RTF and Token Text.
Param Order
Cr/Lf separated list of parameters.
Access is read/write.
You can use the ReorderItem function to change the order of the Parameters. For more information, click here
.
Post Conditions
String specifying any post-conditions for this Operation.
Access is read/write.
Pre Conditions
String specifying any pre-conditions for this Operation.
Access is read/write.
Return Type
The data type of the argument returned for Operations defined as functions.
Access is read/write.
Return Type <language> Name
Where <language> can be Ada, C, C++, IDL or Java.
A string returning the mangled name of the Return Type's data type.
Access is read-only.
Signature
String, representing the signature of the Operation.
Access is read/write.
Synchronisation
Values can be:
• Asynchronous
• Balking
• Call
• Timed
• Waiting
Access is read/write.
Text
A textual property that is derived from the Body property as plain text.
Access is read/write.
See also, Ada Text, Body, C Text, C++ Text, Java Text, Token RTF and Token Text.
Token Delimiter
A textual property that specifies the delimiter used in Token Text.
Access is read-only.
Token RTF
A textual property that is derived from the Body property as rich text.
Token RTF replaces Model Object References with their Modeler IDs delimited by the Token Delimiter.
Access is read/write.
See also, Ada Text, Body, C Text, C++ Text, Java Text, Text and Token Text.
Token Text
A textual property that is derived from the Body property as plain text.
Token Text replaces Model Object References with their Modeler IDs delimited by \£.
Access is read/write.
See also, Ada Text, Body, C Text, C++ Text, Java Text, Text and Token RTF.
Visibility
Note that for an Operation, the Visibility attribute is derived from the Access attribute. When you set the Visibility property of an Operation in Modeler, Modeler sets the Access attribute.
Access is read-only.
ASSOCIATIONS
In addition to the
common associations.
Relationship to Action Nodes (Call Operation Actions only) that use the Operation as their Linked Item.
Multiplicity is 0+, access is read/write.
Relationship to Comments that are applied to the Operation.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are applied to the Operation.
Multiplicity is 0+, access is read/write.
Relationship to scoping Package.
Multiplicity is 0-1, access is read/write.
Relationship to State Machines that are owned by the Operation.
Multiplicity is 0+, access is read/write.
A relationship with the owning Class object (Class, Data Type, Interface or Signal item), Project or Package.
Multiplicity is 1, access is read/write.
A collection of linked Events.
Multiplicity is 0+, access is read/write.
Relationship with Event Action Blocks that use the Operation as a trigger.
Multiplicity is 0+, access is read/write.
A collection of Exceptions raised by this Operation.
Multiplicity is 0+, access is read/write.
A relationship to Activity items that are owned by the Operation.
Multiplicity is 0+, access is read/write.
Relationship to Comments that are owned by the Operation.
Multiplicity is 0+, access is read/write.
Relationship to Constraints that are owned by the Operation.
Multiplicity is 0+, access is read/write.
A collection of Parameters of this operation.
Multiplicity is 0+, access is read/write.
Relationship with a data type item.
For uninterpreted data types, see the Data Type <language> Name attribute.
Multiplicity is 0-1, access is read/write.