panel set twindow_function state_value_for_plant
The STATE_VALUE function returns the COMPONENT of a STATE_VALUE you identify in the PLANT_STATE_NAME parameter.
A PLANT_STATE is made up of a list of VARIABLES (algebraic expressions). The COMPONENT parameter is an integer indicating the kth VARIABLE in the list. For example, if the PLANT_STATE is defined by a list of ten VARIABLEs, and you list the component as 7, the STATE_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.
Format:
panel set twindow_function state_value_for_plant |
|---|
plant_state_name= | existing plant state |
component= | integer |
Example:
panel set twindow_function state_value_for_plant & |
|---|
plant_state_name = | pstate_01 & |
component = | 2 |
The STATE_VALUE_FOR_PLANT function returns the value for the 2nd VARIABLE in the list since the component value specified is 2.
Description:
Parameter | Value Type | Description |
|---|
Plant_state_name | Existing Plant State | Specifies an existing plant_state. |
Component | Integer | Specifies which VARIABLE value should be returned for the STATE_VALUE_FOR_PLANT or STATE_VALUE_FOR_PLANT function. |
Extended Definition:
1. You may identify a plant_state by typing its name or by picking it from the screen.
Since plant_state do not have a geometric position, Adams View displays plant_state icons at or near the model origin. If the plant_state icon is not visible on the screen, you must type the name. You may also find it convenient to type the name even if the plant_state icon is displayed.
If a plant_state is owned by the default model, you may identify it by entering only its name. If it is not, you must enter its full name. To identify a plant_state under a different model, for instance, you may need to enter the model name as well. For example, you may specify plant_state 'actual_velocity' from model 'motor' by entering ".motor.actual_velocity'". If you type a "?", Adams View will list the plant_state available by default.
You must separate multiple plant_state names by commas.
If the plant_state is visible in one of your views, you may identify it by picking on any of the graphics associated with it.
You need not separate multiple plant_state picks by commas.
2. The COMPONENT is an integer indicating the kth VARIABLE in the list.
For example, A PLANT_STATE is made up of a list of VARIABLES (algebraic expressions). The COMPONENT parameter for the OUTPUT_VALUE_FOR_PLANT function is an integer indicating the kth VARIABLE in the list. Therefore, if the PLANT_STATE is defined by a list of ten VARIABLEs, and you request the 7th component to be returned, the OUTPUT_VALUE_FOR_PLANT function returns the value for the 7th VARIABLE in the list.