Single-Element Functions : List of Functions

List of Functions

As previously mentioned, the extraction functions take the form:

stm_r_<element_type><task>
 

For example, stm_r_uc_attr_name returns the names of attributes associated with the specified use case. Because this function can retrieve values for other elements besides use cases, it is denoted as stm_r_xx_attr_name. This function would be included in the A section (for attr_name).

For ease-of-use, the functions are presented in alphabetical order, by task. The functions are as follows:

 
Returns the actual binding of the formal parameter name in the specified instance chart or component.
Returns the type of the formal parameter name in the specified instance chart or component.
Retrieves the information on the element’s Design-Attributes as would appear when using the Info tool within Rational Statemate.
Returns a list of names of formal parameters that appear in bindings of instance boxes and components.
Retrieves the action language local data associated with the specified subroutine.
Retrieves the local data of the procedural statechart implemented by the specified subroutine.
Returns the names of attributes associated with the specified element. Attributes are associated with elements through element forms.
Returns the string of the specified cell (row & column) in a Truth-Table associated with the specified element.
Retrieves the contents of the specified cell in the given truth table, including hyperlinks to referenced elements.
Returns the type of the specified cell (row & column) in a Truth-Table associated with the specified element.
Retrieves the number of columns (including blank ones) in the specified truth table, as viewed in the truth table editor.
Retrieves the number of rows (including blank ones) in the specified truth table, as viewed in the truth table editor
Returns a list of strings that represents a row in the truth table, including hyperlinks to referenced elements.
Returns both the textual and graphical information associated with a specified element.
Retrieves attribute values associated with a particular attribute name for the specified element.
Retrieves the values of a given Design-Attribute values associated with the specified element.
Returns the name of a chart, as it appears in the graphic editor where the specified element is located.
Returns the definition expression of the specified element found in the Definition field of the element’s form, including hyperlinks to referenced elements.
Returns the definition expression of the specified element found in the Definition field of the element’s form.
Returns the file name associated with the "Link to External File" entry in the element's properties of the specified element.
Returns the name of the instance as it appears in the chart for a specific hierarchical Rational Statemate element.
Retrieves the parameter mode, including subroutine parameters and the parameters of generic charts and components.
Returns the structure or type of the specified textual element. The structure or type can be single, array, or queue.
Retrieves the synonym of the specified element. The synonym is defined in the element’s form.