Each Result object is also characterized by two integer and two real identifiers. Several methods allow retrieval or modification of the Result data.
“Name” returns a String containing the name of the Result. The method has no argument.
“Name=” has one String argument and sets the name of the Result.
“Format” returns an integer corresponding to the format of the Result (1="Real", 2="Real-Imaginary", 3="Magnitude-Phase").
“Format=” has one integer argument and sets the format of the Result object. (Same possible values as for “Format” attribute “getter”.)
“TensorOrder” returns an integer corresponding to the tensorial order of the Result. (Possible values are 0, 1, 2 and -10.)
“TensorOrder=” has one integer argument and sets the tensorial order of the object. (Possible values are 0, 1, 2 and -10.)
“clearData” has no argument and clears the keys and values stored in a Result object. The method returns the modified “Result” object.
“insert” has two Array arguments corresponding to a result::key and a result::values respectively:
The “Key” argument is an Array of between 1 and 4 elements corresponding to element, node and layer identifiers respectively. These elements can be of String or integer types.
The “Values” argument is an Array of elements the number of which depends on the tensorial order of the Result object that is filled. (This tensorial order must have been defined already.) The first element of the Array is always the coordinate system identifier (a String or integer object). The other elements of the Array are Real values corresponding to the components.
The method returns the modified “Result” object.
“insertRklVals” has two arguments corresponding to a ResKeyList or Result object and a result::values object respectively:
The “Rkl” is a ResKeyList or Result object containing the list of keys for which values are inserted. This argument can be replaced by a Result object; then, only the keys of the Result are used for insertion of data.
The “Values” is the same argument as in “insert” method described above. Note that one inserts identical values for the different keys of the “Rkl” ResKeyList object.
The method returns the modified “Result” object.
“insertResultValues” has one “Result” argument. The keys and values of the argument “Result” object are inserted to the Result object on which the method is called. The method returns the modified “Result” object.
“setComponent” has two or three arguments and allows modification of a selected component of the values stored in the Result object on which the method is called:
If the method has three arguments:
The first “oComp” argument is an integer corresponding to the index of the component that shall be modified.
The second “inRes” argument is a Result object from which the new component values are read.
The third “iComp” argument is an integer corresponding to the index of the component that is read from the “inRes” Result object.
The values of the target Result object (on which the method is called) are modified only for the keys that are found in the “inRes” Result argument. It is the responsibility of the user to define correct “oComp” and “iComp” indices. (First component corresponds to index 0.)
If the method has two arguments:
The first “oComp” argument is an integer corresponding to the index of the component that shall be modified.
The second “fValue” argument is a real value corresponding to the new component value.
With this version of the method, all the values of the target Result object are modified. Here again, the user is responsible for the correct definition of “oComp” argument.
The method returns the modified “Result” object.
“removeKeysAndValues” is used to remove keys and values from an existing “Result” object. If the method has one argument, the arguments is either a “Result” or a “ResKeyList” object. Then, keys and values are removed for all the keys found in the argument. If two arguments are provided, they must be a “method” String argument, and a “Group” argument, and the method keys are eliminated according to the “getData” method. The method returns the modified “Result” object.
“setIntId” has two arguments: the index of integer ID to be set, and its new value.
“getIntId” has one argument: the index of integer ID that is to be retrieved.
“setRealId” has two arguments: the index of real ID to be set, and its new value.
“getRealId” has one argument: the index of real ID that is to be retrieved.
For the four last methods listed above, the value of index argument can be 0 or 1. Note that several of the methods listed above correspond to the “Name”, “Format” and “TensorOrder” attributes.
All these methods can be used with Real Results as well as with Complex Results.