All Parms in OpenVSP are stored in Parm Containers. The functions in this group can be used to work with Parm Containers through the API.
Click here to return to the main page.
More...
◆ AddUserParm()
Function to add a new user Parm of input type, name, and group
- See also
- PARM_TYPE
- Parameters
-
[in] | type | Parm type enum (i.e. PARM_DOUBLE_TYPE) |
[in] | name | Parm name |
[in] | group | Parm group |
- Returns
- Parm ID
◆ DeleteAllUserParm()
void DeleteAllUserParm |
( |
| ) |
|
Get the user parm container ID
◆ DeleteUserParm()
void DeleteUserParm |
( |
const string &in |
parm_id | ) |
|
Get the user parm container ID
if ( id_arr.size() > n )
{
}
◆ FindContainer()
Get the ID of a Parm Container with specified name at input index
- See also
- FindContainersWithName
- Parameters
-
[in] | name | Parm Container name |
[in] | index | Parm Container index |
- Returns
- Parm Container ID
◆ FindContainerGroupNames()
string [] FindContainerGroupNames |
( |
const string &in |
parm_container_id | ) |
|
Get an array of Parm group names included in the specified Container
Print(
"---> UserParms Container Group IDs: " );
for ( int i = 0; i < int( grp_arr.size() ); i++ )
{
string message = "\t" + grp_arr[i] + "\n";
}
- Parameters
-
[in] | parm_container_id | Parm Container ID |
- Returns
- Array of Parm group names
◆ FindContainerParmIDs()
string [] FindContainerParmIDs |
( |
const string &in |
parm_container_id | ) |
|
Get an array of Parm IDs included in the specified Container
string parm_container_id =
FindContainer( parm_container_name, struct_ind );
for ( uint i = 0; i < uint(parm_ids.length()); i++ )
{
}
- Parameters
-
[in] | parm_container_id | Parm Container ID |
- Returns
- Array of Parm IDs
◆ FindContainers()
Get an array of all Parm Container IDs
Print(
"---> API Parm Container IDs: " );
for ( int i = 0; i < int( ctr_arr.size() ); i++ )
{
string message = "\t" + ctr_arr[i] + "\n";
}
- Returns
- Array of Parm Container IDs
◆ FindContainersWithName()
Get an array of Parm Container IDs for Containers with the specified name
if ( ctr_arr.size() > 0 ) {
Print( (
"UserParms Parm Container ID: " + ctr_arr[0] ) ); }
- Parameters
-
[in] | name | Parm Container name |
- Returns
- Array of Parm Container IDs
◆ GetAllUserParms()
Get the vector of id's for all user parameters
Print(
"---> User Parm IDs: " );
for ( int i = 0; i < int( id_arr.size() ); i++ )
{
string message = "\t" + id_arr[i] + "\n";
}
- Returns
- Array of user parameter ids
◆ GetContainerName()
string GetContainerName |
( |
const string &in |
parm_container_id | ) |
|
Get the name of the specified Parm Container
- Parameters
-
[in] | parm_container_id | Parm Container ID |
- Returns
- Parm Container name
◆ GetNumPredefinedUserParms()
int GetNumPredefinedUserParms |
( |
| ) |
|
Get the number of pre-defined user parameters
- Returns
- Number of pre-defined user Parms
◆ GetNumUserParms()
Get the number of user parameters
- Returns
- Number of user Parms
◆ GetUserParmContainer()
string GetUserParmContainer |
( |
| ) |
|
Get the user parm container ID
- Returns
- User parm container ID
◆ GetVehicleID()
Get the ID of the Vehicle Parm Container
- Returns
- Vehicle ID