Every Parm in OpenVSP can be accessed and modified through the functions defined in this API group. Every Parm has an associated ParmContainer.
Click here to return to the main page.
More...
|
bool | ValidParm (const string &in id) |
|
double | SetParmVal (const string &in parm_id, double val) |
|
double | SetParmValLimits (const string &in parm_id, double val, double lower_limit, double upper_limit) |
|
double | SetParmValUpdate (const string &in parm_id, double val) |
|
double | SetParmVal (const string &in geom_id, const string &in name, const string &in group, double val) |
|
double | SetParmValUpdate (const string &in geom_id, const string &in parm_name, const string &in parm_group_name, double val) |
|
double | GetParmVal (const string &in parm_id) |
|
double | GetParmVal (const string &in geom_id, const string &in name, const string &in group) |
|
int | GetIntParmVal (const string &in parm_id) |
|
bool | GetBoolParmVal (const string &in parm_id) |
|
void | SetParmUpperLimit (const string &in parm_id, double val) |
|
double | GetParmUpperLimit (const string &in parm_id) |
|
void | SetParmLowerLimit (const string &in parm_id, double val) |
|
double | GetParmLowerLimit (const string &in parm_id) |
|
int | GetParmType (const string &in parm_id) |
|
string | GetParmName (const string &in parm_id) |
|
string | GetParmGroupName (const string &in parm_id) |
|
string | GetParmDisplayGroupName (const string &in parm_id) |
|
string | GetParmContainer (const string &in parm_id) |
|
void | SetParmDescript (const string &in parm_id, const string &in desc) |
|
string | FindParm (const string &in parm_container_id, const string &in parm_name, const string &in group_name) |
|
string | GetParm (const string &in geom_id, const string &in name, const string &in group) |
|
◆ FindParm()
Find a Parm ID given the Parm Container ID, Parm name, and Parm group
- Parameters
-
[in] | parm_container_id | Parm Container ID |
[in] | parm_name | Parm name |
[in] | group_name | Parm group name |
- Returns
- Parm ID
◆ GetBoolParmVal()
bool GetBoolParmVal |
( |
const string &in |
parm_id | ) |
|
Get the value of the specified bool type Parm
- Parameters
-
- Returns
- Parm value
◆ GetIntParmVal()
int GetIntParmVal |
( |
const string &in |
parm_id | ) |
|
Get the value of the specified int type Parm
- Parameters
-
- Returns
- Parm value
◆ GetParm()
Get Parm ID
- Parameters
-
[in] | geom_id | Geom ID |
[in] | name | Parm name |
[in] | group | Parm group name |
- Returns
- Array of Parm ID
◆ GetParmContainer()
Get Parm Container ID for the specified Parm
- Parameters
-
- Returns
- Parm Container ID
◆ GetParmDisplayGroupName()
Get the display group name for the specified Parm
- Parameters
-
- Returns
- Parm display group name
◆ GetParmGroupName()
Get the group name for the specified Parm
- Parameters
-
- Returns
- Parm group name
◆ GetParmLowerLimit()
double GetParmLowerLimit |
( |
const string &in |
parm_id | ) |
|
Get the lower limit value for the specified Parm
- Parameters
-
- Returns
- Parm lower limit
◆ GetParmName()
Get the name for the specified Parm
- Parameters
-
- Returns
- Parm name
◆ GetParmType()
int GetParmType |
( |
const string &in |
parm_id | ) |
|
Get the data type for the specified Parm
- See also
- PARM_TYPE
- Parameters
-
- Returns
- Parm data type enum (i.e. PARM_BOOL_TYPE)
◆ GetParmUpperLimit()
double GetParmUpperLimit |
( |
const string &in |
parm_id | ) |
|
Get the upper limit value for the specified Parm
- Parameters
-
- Returns
- Parm upper limit
◆ GetParmVal() [1/2]
double GetParmVal |
( |
const string &in |
parm_id | ) |
|
Get the value of the specified Parm. The data type of the Parm value will be cast to a double
- Parameters
-
- Returns
- Parm value
◆ GetParmVal() [2/2]
double GetParmVal |
( |
const string &in |
geom_id, |
|
|
const string &in |
name, |
|
|
const string &in |
group |
|
) |
| |
Get the value of the specified double type Parm. This function includes a call to GetParm to identify the Parm ID given the Geom ID, Parm name, and Parm group. The data type of the Parm value will be cast to a double.
- Parameters
-
[in] | geom_id | Geom ID |
[in] | name | Parm name |
[in] | group | Parm group name |
- Returns
- Parm value
◆ SetParmDescript()
void SetParmDescript |
( |
const string &in |
parm_id, |
|
|
const string &in |
desc |
|
) |
| |
Set the description of the specified Parm
- Parameters
-
[in] | parm_id | Parm ID |
[in] | desc | Parm description |
◆ SetParmLowerLimit()
void SetParmLowerLimit |
( |
const string &in |
parm_id, |
|
|
double |
val |
|
) |
| |
Set the lower limit value for the specified Parm
- See also
- SetParmValLimits
- Parameters
-
[in] | parm_id | Parm ID |
[in] | val | Parm lower limit |
◆ SetParmUpperLimit()
void SetParmUpperLimit |
( |
const string &in |
parm_id, |
|
|
double |
val |
|
) |
| |
Set the upper limit value for the specified Parm
- See also
- SetParmValLimits
- Parameters
-
[in] | parm_id | Parm ID |
[in] | val | Parm upper limit |
◆ SetParmVal() [1/2]
double SetParmVal |
( |
const string &in |
parm_id, |
|
|
double |
val |
|
) |
| |
Set the value of the specified Parm.
- See also
- SetParmValUpdate
- Parameters
-
[in] | parm_id | Parm ID |
[in] | val | Parm value to set |
- Returns
- Value that the Parm was set to
◆ SetParmVal() [2/2]
double SetParmVal |
( |
const string &in |
geom_id, |
|
|
const string &in |
name, |
|
|
const string &in |
group, |
|
|
double |
val |
|
) |
| |
Set the value of the specified Parm. This function includes a call to GetParm to identify the Parm ID given the Geom ID, Parm name, and Parm group.
- See also
- SetParmValUpdate
- Parameters
-
[in] | geom_id | Geom ID |
[in] | name | Parm name |
[in] | group | Parm group name |
[in] | val | Parm value to set |
- Returns
- Value that the Parm was set to
◆ SetParmValLimits()
double SetParmValLimits |
( |
const string &in |
parm_id, |
|
|
double |
val, |
|
|
double |
lower_limit, |
|
|
double |
upper_limit |
|
) |
| |
Set the value along with the upper and lower limits of the specified Parm
- See also
- SetParmLowerLimit, SetParmUpperLimit
- Parameters
-
[in] | parm_id | Parm ID |
[in] | val | Parm value to set |
[in] | lower_limit | Parm lower limit |
[in] | upper_limit | Parm upper limit |
- Returns
- Value that the Parm was set to
◆ SetParmValUpdate() [1/2]
double SetParmValUpdate |
( |
const string &in |
parm_id, |
|
|
double |
val |
|
) |
| |
Set the value of the specified Parm and force an Update.
- See also
- SetParmVal
- Parameters
-
[in] | parm_id | Parm ID |
[in] | val | Parm value to set |
- Returns
- Value that the Parm was set to
◆ SetParmValUpdate() [2/2]
double SetParmValUpdate |
( |
const string &in |
geom_id, |
|
|
const string &in |
parm_name, |
|
|
const string &in |
parm_group_name, |
|
|
double |
val |
|
) |
| |
Set the value of the specified Parm and force an Update. This function includes a call to GetParm to identify the Parm ID given the Geom ID, Parm name, and Parm group.
- See also
- SetParmVal
- Parameters
-
[in] | geom_id | Geom ID |
[in] | parm_name | Parm name |
[in] | parm_group_name | Parm group name |
[in] | val | Parm value to set |
- Returns
- Value that the Parm was set to
◆ ValidParm()
bool ValidParm |
( |
const string &in |
id | ) |
|
Check if given Parm is valid
- Parameters
-
- Returns
- True if Parm ID is valid, false otherwise