Parm Container Functions

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...

Functions
std::vector< std::string >	vsp::FindContainers ()
std::vector< std::string >	vsp::FindContainersWithName (const std::string &name)
std::string	vsp::FindContainer (const std::string &name, int index)
void	vsp::SetContainerName (const std::string &parm_container_id, const std::string &name)
std::vector< std::string >	vsp::FindContainerGroupNames (const std::string &parm_container_id)
std::vector< std::string >	vsp::FindContainerParmIDs (const std::string &parm_container_id)
std::string	vsp::GetVehicleID ()
int	vsp::GetNumUserParms ()
int	vsp::GetNumPredefinedUserParms ()
std::vector< std::string >	vsp::GetAllUserParms ()
std::string	vsp::GetUserParmContainer ()
std::string	vsp::AddUserParm (int type, const std::string &name, const std::string &group)
void	vsp::DeleteUserParm (const std::string &id)
void	vsp::DeleteAllUserParm ()

Detailed Description

Function Documentation

AddUserParm()

std::string vsp::AddUserParm ( int type, const std::string & name, const std::string & group )

extern

Function to add a new user Parm of input type, name, and group

string length = AddUserParm( PARM_DOUBLE_TYPE, "Length", "Design" );
 
SetParmValLimits( length, 10.0, 0.001, 1.0e12 );
 
SetParmDescript( length, "Length user parameter" );
 
if ( length.length() == 0 || length == "NONE" )
{
    Print( "ERROR: AddUserParm returned no id" );
    __failure++;
}

See also

PARM_TYPE

Parameters

[in]	type	int Parm type enum (i.e. PARM_DOUBLE_TYPE)
[in]	name	string Parm name
[in]	group	string Parm group

Returns

string Parm ID

DeleteAllUserParm()

void vsp::DeleteAllUserParm ( )

extern

Delete all user created Parms. The predefined User_0 through User_15 Parms belong to the vehicle and are not removed.

// A fresh model already carries the predefined user Parms, so record the
// starting count rather than expecting to end at zero.
int num_before = GetNumUserParms();
 
AddUserParm( PARM_DOUBLE_TYPE, "Param1", "Group1" );
AddUserParm( PARM_DOUBLE_TYPE, "Param2", "Group1" );
 
if ( GetNumUserParms() != num_before + 2 )
{
    Print( "ERROR: AddUserParm" );
    __failure++;
}
 
DeleteAllUserParm();
 
if ( GetNumUserParms() != num_before )
{
    Print( "ERROR: DeleteAllUserParm" );
    __failure++;
}

DeleteUserParm()

void vsp::DeleteUserParm ( const std::string & id )

extern

Get the user parm container ID

int n = GetNumPredefinedUserParms();
array<string> @id_arr = GetAllUserParms();
 
if ( int( id_arr.size() ) > n )
{
    int num_before_del = GetNumUserParms();
    DeleteUserParm( id_arr[n] );
    if ( GetNumUserParms() >= num_before_del )
    {
        Print( "ERROR: DeleteUserParm removed nothing" );
        __failure++;
    }
 
}

FindContainer()

std::string vsp::FindContainer ( const std::string & name, int index )

extern

Get the ID of a Parm Container with specified name at input index

//===== Get Vehicle Parm Container ID ====//
string veh_id = FindContainer( "Vehicle", 0 );
if ( veh_id.length() == 0 )
{
    Print( "ERROR: FindContainer found nothing" );
    __failure++;
}

See also

FindContainersWithName

Parameters

[in]	name	string Parm Container name
[in]	index	int Parm Container index

Returns

string Parm Container ID

FindContainerGroupNames()

std::vector< std::string > vsp::FindContainerGroupNames ( const std::string & parm_container_id )

extern

Get an array of Parm group names included in the specified Container

string user_ctr = FindContainer( "UserParms", 0 );
 
array<string> @grp_arr = FindContainerGroupNames( user_ctr );
if ( grp_arr.length() == 0 )
{
    Print( "ERROR: FindContainerGroupNames found nothing" );
    __failure++;
}
 
Print( "---> UserParms Container Group IDs: " );
for ( int i = 0; i < int( grp_arr.size() ); i++ )
{
    string message = "\t" + grp_arr[i] + "\n";
 
    Print( message );
}

Parameters

[in]

parm_container_id

string Parm Container ID

Returns

vector<string> Array of Parm group names

FindContainerParmIDs()

std::vector< std::string > vsp::FindContainerParmIDs ( const std::string & parm_container_id )

extern

Get an array of Parm IDs included in the specified Container

//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
 
//==== Add FeaStructure to Pod ====//
int struct_ind = AddFeaStruct( pod_id );
 
//==== Get Structure Name and Parm Container ID ====//
string parm_container_name = GetFeaStructName( pod_id, struct_ind );
 
string parm_container_id = FindContainer( parm_container_name, struct_ind );
 
//==== Get and List All Parms in the Container ====//
array<string> parm_ids = FindContainerParmIDs( parm_container_id );
if ( parm_ids.length() == 0 )
{
    Print( "ERROR: FindContainerParmIDs found nothing" );
    __failure++;
}
 
for ( uint i = 0; i < uint(parm_ids.length()); i++ )
{
    string name_id = GetParmName( parm_ids[i] ) + string(": ") + parm_ids[i] + string("\n");
 
    Print( name_id );
}

Parameters

[in]

parm_container_id

string Parm Container ID

Returns

vector<string> Array of Parm IDs

FindContainers()

std::vector< std::string > vsp::FindContainers ( )

extern

Get an array of all Parm Container IDs

array<string> @ctr_arr = FindContainers();
if ( ctr_arr.length() == 0 )
{
    Print( "ERROR: FindContainers found nothing" );
    __failure++;
}
 
Print( "---> API Parm Container IDs: " );
 
for ( int i = 0; i < int( ctr_arr.size() ); i++ )
{
    string message = "\t" + ctr_arr[i] + "\n";
 
    Print( message );
}

Returns

vector<string> Array of Parm Container IDs

FindContainersWithName()

std::vector< std::string > vsp::FindContainersWithName ( const std::string & name )

extern

Get an array of Parm Container IDs for Containers with the specified name

array<string> @ctr_arr = FindContainersWithName( "UserParms" );
if ( ctr_arr.length() == 0 )
{
    Print( "ERROR: FindContainersWithName found nothing" );
    __failure++;
}
 
if ( ctr_arr.size() > 0 )            { Print( ( "UserParms Parm Container ID: " + ctr_arr[0] ) ); }

Parameters

[in]

name

string Parm Container name

Returns

vector<string> Array of Parm Container IDs

GetAllUserParms()

std::vector< std::string > vsp::GetAllUserParms ( )

extern

Get the vector of id's for all user parameters

array<string> @id_arr = GetAllUserParms();
if ( id_arr.length() == 0 )
{
    Print( "ERROR: GetAllUserParms returned nothing" );
    __failure++;
}
 
Print( "---> User Parm IDs: " );
 
for ( int i = 0; i < int( id_arr.size() ); i++ )
{
    string message = "\t" + id_arr[i] + "\n";
 
    Print( message );
}

Returns

vector <string> Array of user parameter ids

GetNumPredefinedUserParms()

int vsp::GetNumPredefinedUserParms ( )

extern

Get the number of pre-defined user parameters

int n = GetNumPredefinedUserParms();
 
if ( n <= 0 )
{
    Print( "ERROR: GetNumPredefinedUserParms" );
    __failure++;
}

Returns

int Number of pre-defined user Parms

GetNumUserParms()

int vsp::GetNumUserParms ( )

extern

Get the number of user parameters

int n = GetNumUserParms();
 
// A fresh model already carries the predefined user Parms, and the count has
// to match the list.
if ( n != GetNumPredefinedUserParms() || n != int( GetAllUserParms().size() ) )
{
    Print( "ERROR: GetNumUserParms disagrees with the user Parm list" );
    __failure++;
}
 
// Adding one has to move the count.
AddUserParm( PARM_DOUBLE_TYPE, "ExampleParm", "ExampleGroup" );
 
if ( GetNumUserParms() != n + 1 )
{
    Print( "ERROR: GetNumUserParms did not follow AddUserParm" );
    __failure++;
}

Returns

int Number of user Parms

GetUserParmContainer()

std::string vsp::GetUserParmContainer ( )

extern

Get the user parm container ID

string up_id = GetUserParmContainer();
if ( up_id.length() == 0 )
{
    Print( "ERROR: GetUserParmContainer returned nothing" );
    __failure++;
}

Returns

string User parm container ID

GetVehicleID()

std::string vsp::GetVehicleID ( )

extern

Get the ID of the Vehicle Parm Container

//===== Get Vehicle Parm Container ID ====//
string veh_id = GetVehicleID();
if ( veh_id.length() == 0 )
{
    Print( "ERROR: GetVehicleID returned nothing" );
    __failure++;
}

Returns

string Vehicle ID

SetContainerName()

void vsp::SetContainerName ( const std::string & parm_container_id, const std::string & name )

extern

Get the name of the specified Parm Container

string veh_id = FindContainer( "Vehicle", 0 );
 
if ( GetContainerName( veh_id ) != "Vehicle" )         { Print( "---> Error: API GetContainerName" ); __failure++; }

Parameters

[in]

parm_container_id

string Parm Container ID

Returns

string Parm Container name

Set the name of the specified Parm Container. This is the general counterpart to GetContainerName and works on any container reached by ID. Containers that derive their name from what they hold, such as an unsteady group, will overwrite it on their next update.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
 
SetContainerName( pid, "ExampleContainerName" );
 
if ( GetContainerName( pid ) != "ExampleContainerName" )
{
    Print( "ERROR: SetContainerName did not take" );
    __failure++;
}
 
// A Geom's container name is its Geom name, so the two agree.
if ( GetGeomName( pid ) != "ExampleContainerName" )
{
    Print( "ERROR: SetContainerName disagrees with GetGeomName" );
    __failure++;
}
 
// A container that does not exist has to be rejected.
SetContainerName( "NOSUCHCONTAINER", "ExampleContainerName" );
 
if ( GetNumTotalErrors() == 0 )
{
    Print( "ERROR: SetContainerName accepted a bad container ID" );
    __failure++;
}
 
// That error was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

GetContainerName, FindContainer

Parameters

[in]	parm_container_id	string Parm Container ID
[in]	name	string Parm Container name