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

Functions
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)

Detailed Description

Function Documentation

◆ FindParm()

string FindParm	(	const string &in	parm_container_id,
		const string &in	parm_name,
		const string &in	group_name
	)

Find a Parm ID given the Parm Container ID, Parm name, and Parm group

//==== Add Wing Geometry ====//
string wing_id = AddGeom( "WING" );
//==== Turn Symmetry OFF ====//
string sym_id = FindParm( wing_id, "Sym_Planar_Flag", "Sym");
SetParmVal( sym_id, 0.0 ); // Note: bool input not supported in SetParmVal

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

//==== Add Prop Geometry ====//
string prop_id = AddGeom( "PROP" );
string rev_flag_id = GetParm( prop_id, "ReverseFlag", "Design" );
bool reverse_flag = GetBoolParmVal( rev_flag_id );

Parameters

[in] parm_id Parm ID

Returns: Parm value

◆ GetIntParmVal()

int GetIntParmVal ( const string &in parm_id )

Get the value of the specified int type Parm

//==== Add Prop Geometry ====//
string prop_id = AddGeom( "PROP" );
string num_blade_id = GetParm( prop_id, "NumBlade", "Design" );
int num_blade = GetIntParmVal( num_blade_id );

Parameters

[in] parm_id Parm ID

Returns: Parm value

◆ GetParm()

string GetParm	(	const string &in	geom_id,
		const string &in	name,
		const string &in	group
	)

Get Parm ID

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
string lenid = GetParm( pid, "Length", "Design" );
if ( !ValidParm( lenid ) )                { Print( "---> Error: API GetParm  " ); }

Parameters

[in]	geom_id	Geom ID
[in]	name	Parm name
[in]	group	Parm group name

Returns: Array of Parm ID

◆ GetParmContainer()

string GetParmContainer ( const string &in parm_id )

Get Parm Container ID for the specified Parm

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
string cid = GetParmContainer( wid );
if ( cid.size() == 0 )                                { Print( "---> Error: API GetParmContainer " ); }

Parameters

[in] parm_id Parm ID

Returns: Parm Container ID

◆ GetParmDisplayGroupName()

string GetParmDisplayGroupName ( const string &in parm_id )

Get the display group name for the specified Parm

string veh_id = FindContainer( "Vehicle", 0 );
//==== Get and List All Parms in the Container ====// 
array<string> parm_ids = FindContainerParmIDs( veh_id );
Print( "Parm Group Display Names and IDs in Vehicle Parm Container: " );
for ( uint i = 0; i < uint(parm_ids.length()); i++ )
{
    string group_str = GetParmDisplayGroupName( parm_ids[i] ) + string(": ") + parm_ids[i] + string("\n");
    Print( name_id );
}

Parameters

[in] parm_id Parm ID

Returns: Parm display group name

◆ GetParmGroupName()

string GetParmGroupName ( const string &in parm_id )

Get the group name for the specified Parm

string veh_id = FindContainer( "Vehicle", 0 );
//==== Get and List All Parms in the Container ====// 
array<string> parm_ids = FindContainerParmIDs( veh_id );
Print( "Parm Groups and IDs in Vehicle Parm Container: " );
for ( uint i = 0; i < uint(parm_ids.length()); i++ )
{
    string group_str = GetParmGroupName( parm_ids[i] ) + string(": ") + parm_ids[i] + string("\n");
    Print( name_id );
}

Parameters

[in] parm_id Parm ID

Returns: Parm group name

◆ GetParmLowerLimit()

double GetParmLowerLimit ( const string &in parm_id )

Get the lower limit value for the specified Parm

//==== Add Prop Geometry ====//
string prop_id = AddGeom( "PROP" );
string num_blade_id = GetParm( prop_id, "NumBlade", "Design" );
double min_blade = GetParmLowerLimit( num_blade_id );

Parameters

[in] parm_id Parm ID

Returns: Parm lower limit

◆ GetParmName()

string GetParmName ( const string &in parm_id )

Get the name for the specified Parm

//==== 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 );
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_id Parm ID

Returns: Parm name

◆ GetParmType()

int GetParmType ( const string &in parm_id )

Get the data type for the specified Parm

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
if ( GetParmType( wid ) != PARM_DOUBLE_TYPE )        { Print( "---> Error: API GetParmType " ); }

See also: PARM_TYPE

Parameters

[in] parm_id Parm ID

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

//==== Add Prop Geometry ====//
string prop_id = AddGeom( "PROP" );
string num_blade_id = GetParm( prop_id, "NumBlade", "Design" );
double max_blade = GetParmUpperLimit( num_blade_id );

Parameters

[in] parm_id Parm ID

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

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
SetParmVal( wid, 23.0 );
if ( abs( GetParmVal( wid ) - 23 ) > 1e-6 )                { Print( "---> Error: API Parm Val Set/Get " ); }

Parameters

[in] parm_id Parm ID

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.

//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
double length = GetParmVal( pod_id, "Length", "Design" );

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

string length = AddParm( PARM_DOUBLE_TYPE, "Length", "Design" );
SetParmValLimits( length, 10.0, 0.001, 1.0e12 );
SetParmDescript( length, "Total Length of Custom Geom" );

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

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
SetParmVal( wid, 13.0 );
SetParmLowerLimit( wid, 15.0 );
if ( abs( GetParmVal( wid ) - 15 ) > 1e-6 )                { Print( "---> Error: API SetParmLowerLimit " ); }

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

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
SetParmVal( wid, 23.0 );
SetParmUpperLimit( wid, 13.0 );
if ( abs( GetParmVal( wid ) - 13 ) > 1e-6 )                { Print( "---> Error: API SetParmUpperLimit " ); }

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.

// Add Fuselage Geom
string fuseid = AddGeom( "FUSELAGE", "" );
string xsec_surf = GetXSecSurf( fuseid, 0 );
ChangeXSecShape( xsec_surf, GetNumXSec( xsec_surf ) - 1, XS_ROUNDED_RECTANGLE );
string wid = GetXSecParm( xsec, "RoundedRect_Width" );
SetParmVal( wid, 23.0 );
if ( abs( GetParmVal( wid ) - 23 ) > 1e-6 )                { Print( "---> Error: API Parm Val Set/Get " ); }

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.

string wing_id = AddGeom( "WING" );
SetParmVal( wing_id, "ThickChord", "XSecCurve_0", 0.2 );

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

string length = AddParm( PARM_DOUBLE_TYPE, "Length", "Design" );
SetParmValLimits( length, 10.0, 0.001, 1.0e12 );
SetParmDescript( length, "Total Length of Custom Geom" );

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.

//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
string parm_id = GetParm( pod_id, "X_Rel_Location", "XForm" );
SetParmValUpdate( parm_id, 5.0 );

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.

//==== Add Pod Geometry ====//
string pod_id = AddGeom( "POD" );
SetParmValUpdate( pod_id, "X_Rel_Location", "XForm", 5.0 );

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

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
string lenid = GetParm( pid, "Length", "Design" );
if ( !ValidParm( lenid ) )                { Print( "---> Error: API GetParm  " ); }

Parameters

[in] id Parm ID

Returns: True if Parm ID is valid, false otherwise

Functions

Detailed Description

Function Documentation

◆ FindParm()

◆ GetBoolParmVal()

◆ GetIntParmVal()

◆ GetParm()

◆ GetParmContainer()

◆ GetParmDisplayGroupName()

◆ GetParmGroupName()

◆ GetParmLowerLimit()

◆ GetParmName()

◆ GetParmType()

◆ GetParmUpperLimit()

◆ GetParmVal() [1/2]

◆ GetParmVal() [2/2]

◆ SetParmDescript()

◆ SetParmLowerLimit()

◆ SetParmUpperLimit()

◆ SetParmVal() [1/2]

◆ SetParmVal() [2/2]

◆ SetParmValLimits()

◆ SetParmValUpdate() [1/2]

◆ SetParmValUpdate() [2/2]

◆ ValidParm()