data_element modify string
Allows you to modify an existing character string.
Format:
data_element modify string |
|---|
string_name = | an existing astring |
new_string_name = | a new astring |
adams_id = | adams_id |
comments = | string |
string = | string |
Example:
data_element modify string & |
|---|
string_name = | string__1 & |
string_name = | string__2 & |
adams_id = | 1 & |
comments = | " a modified string" & |
string = | "sample string modified" |
Description:
Parameter | Value Type | Description |
|---|
string_name | An Existing Astring | Specifies the name of an existing string. |
new_string_name | A New Astring | Specifies the name of the new string. You may use this name later to refer to this string. |
adams_id | Adams_id | Specifies an integer used to identify this element in the Adams data file. |
comments | Strings | Specifies comments for the object being created or modified. |
string | Strings | A STRING element defines a character string that may be referred to later in the execution of Adams. |
Extended Definition:
1. A STRING element defines a character string that may be referred to later in the execution of Adams. The character string cannot be broken and continued on the following line; however, the STRING element can be longer than a single line. A GTSTRG subroutine can be used to retrieve this character string in a user-written subroutine.
2. Normally, entity names are composed of alphabetic, numeric, or '_' (underscore) characters, and start with an alphabetic or '_' character. They may be any length. For more information, see
Using Extended Names.
By enclosing the name in double quotes, you may use other printable characters, or start the name with a numeral. If a name contains characters, or starts with a numeral, you must always quote the name when entering it.
Note that you can specify the parentage of an entity (for example, what part "owns" a marker or a geometry element) when you CREATE it by changing the name. If you enter just the entity name, then the default parent will be assigned by Adams View. If you type in the full name, then you may over ride the default parent. In most cases, when creating an entity, Adams View will provide a default name. The default name that Adams View provides will specify the parentage that it has assumed.
You may, or course, delete this name and use your own. The form of a full name is:
"...._NAME.GRAND_PARENT_NAME.PARENT_NAME.ENTITY_NAME"
The number of levels used varies from case to case and the parentage must exist before an entity can be assigned to it.
3. When you use the FILE ADAMS_DATA_SET WRITE command, Adams View writes an Adams data file for your model. Adams requires that each modeling element be identified by a unique integer identifier. If you use this parameter to specify a non-zero identifier, Adams View will use it in the corresponding statement in the Adams data file.
You may also enter zero as an identifier, either explicitly or by default. The next time you write an Adams file, Adams View will replace the zero with a unique, internally-generated identifier.
Adams View will permanently store this identifier with the element just as if you had entered it yourself.
Normally, you would let all identifiers default to zero, and Adams View would generate the identifiers for you. You are never required to enter a non-zero identifier. You only need to specify it if, for some reason, you wish to control the Adams file output.
4. When an Adams Solver data file (.adm) is read into Adams View, all comments associated with a statement (from the end of the previous statement through the end of the current statement) are stored with the object. Comments in the data file can be associated with model.
These comments must follow the title statement and be followed by the comment 'END OF MODEL COMMENTS'. This string must be uppercase.
When an Adams Solver data file is written, the comments for an object are written before the statement corresponding to the object.
5. The character string cannot be broken and continued on the following line; however, the STRING element can be longer than a single line. An Adams interactive STRING command can be used to alter or review this character string. A GTSTRG subroutine can be used to retrieve this character string in a user-written subroutine.
Cautions:
1. Adams View will not allow you to have two strings with the same full name, so you must provide a unique name.