Returns the requested single value.
Value = GetRequestedSingleValue(
revdbm,
revdbf,
output_parameter,
dof,
node_no,
element_no,
local_node_no,
stored_timesteps,
timestep_index,
single_value,
label)
Argument |
Description |
revdbm |
Revision number of the motion database file. Integer scalar (input) |
revdbf |
Revision number of the force database file. Integer scalar (input) |
output_parameter |
Requested output parameter. Integer scalar (input). See Table of Outputs for more details. |
dof |
Requested output parameter degree of freedom. Integer scalar (input). See Table of Outputs in the GetRequestedHistory function for more details. |
node_no |
Node number. Integer scalar (input/output). This may also be used to specify a guide surface, zero-gap guide or pipe-in-pipe connection number. If a node label is specified and a value of zero is specified for this variable, then the actual node number designated by the label is returned here. |
element_no |
Element number. Integer scalar (input). |
local_node_no |
Element local node number. Integer scalar (input). |
stored_timesteps |
Number of outputted time-steps to the database. Integer scalar (input). Call GetDatabaseInfo function to retrieve this value. |
timestep_index |
The time-step index at which the output is requested. Integer scalar (input). |
single_value |
Output parameter value. Real scalar (output). |
label |
Node label. Character string of unspecified length (input). This is relevant only if the node number was specifed as zero otherwise the node number specified takes precedence. |
Value |
Description |
0 |
Successful. History is returned |
A positive value |
Errors occured. Please call the GetRequestedSingleValueError function to check which errors occured. |