Vehicle Functions

The Vehicle group of functions are high-level commands that pertain to the entire OpenVSP model. Click here to return to the main page. More...

Functions
void	vsp::Update (bool update_managers=true)
void	vsp::VSPExit (int error_code)
void	vsp::VSPCrash (int crash_type)
int	vsp::GetAndResetUpdateCount ()
std::string	vsp::GetVSPFileName ()
void	vsp::ClearVSPModel ()

Detailed Description

Function Documentation

ClearVSPModel()

void vsp::ClearVSPModel ( )

extern

Clear the current OpenVSP model

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
//==== Reset Geometry ====//
Print( string( "--->Resetting VSP model to blank slate\n" ) );
ClearVSPModel();
 
if ( FindGeoms().size() != 0 )
{
    Print( "ERROR: ClearVSPModel left Geoms behind" );
    __failure++;
}

GetAndResetUpdateCount()

int vsp::GetAndResetUpdateCount ( )

extern

Return the OpenVSP update count and also reset it to zero.

The OpenVSP update count tracks how many times the GUI has been told to update screens (set to dirty). It provides a simple means of testing whether the OpenVSP state has possibly changed (non-zero returned). Nothing marks a screen dirty when no GUI is running, so the count stays at zero in a plain script.

//==== Add Pod Geometry ====//
string pid = AddGeom( "POD" );
 
Update();
 
// Reading the count clears it, so a second read with nothing in between
// reports no change.
GetAndResetUpdateCount();
 
if ( GetAndResetUpdateCount() != 0 )
{
    Print( "ERROR: the update count did not reset" );
    __failure++;
}
 
// The count is a GUI notion.  A script with no GUI running never marks a
// screen dirty, so the count stays where the read left it.
SetParmValUpdate( pid, "Length", "Design", 10.0 );
 
Update();
 
if ( GetAndResetUpdateCount() < 0 )
{
    Print( "ERROR: the update count went negative" );
    __failure++;
}

Returns

int OpenVSP update count

GetVSPFileName()

std::string vsp::GetVSPFileName ( )

extern

Get the file name of the current OpenVSP project

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
string fname = "example_fuse.vsp3";
 
SetVSP3FileName( fname );
 
// A relative name is resolved against the working directory, so ask for the
// resolved name rather than assuming it comes back verbatim.
string full_name = GetVSPFileName();
 
Update();
 
//==== Save Vehicle to File ====//
Print( "\tSaving vehicle file to: ", false );
 
Print( fname );
 
WriteVSPFile( GetVSPFileName(), SET_ALL );
 
if ( GetVSPFileName() != full_name || full_name.findLast( fname ) < 0 )
{
    Print( "ERROR: GetVSPFileName did not report the name that was set" );
    __failure++;
}

Returns

string File name for the current OpenVSP project

Update()

void vsp::Update ( bool update_managers = true )

extern

Update the entire vehicle and all lower level children. An input, which is true by default, is available to specify if managers should be updated as well. The managers are typically updated by their respective GUI, so must be updated through the API as well to avoid unexpected behavior.

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
string xsec_surf = GetXSecSurf( fid, 0 );           // Get First (and Only) XSec Surf
 
int num_xsecs = GetNumXSec( xsec_surf );
 
Update();
 
vec3d before_max = GetGeomBBoxMax( fid, 0, false );
 
//==== Set Tan Angles At Nose/Tail
SetXSecTanAngles( GetXSec( xsec_surf, 0 ), XSEC_BOTH_SIDES, 90 );
SetXSecTanAngles( GetXSec( xsec_surf, num_xsecs - 1 ), XSEC_BOTH_SIDES, -90 );
 
Update();       // Force Surface Update
 
vec3d after_max = GetGeomBBoxMax( fid, 0, false );
 
// Blunting the nose and tail pushes the surface out, which only shows up in
// the bounding box once Update() has rebuilt it.
if ( dist( before_max, after_max ) < 1e-9 )
{
    Print( "ERROR: Update did not rebuild the surface" );
    __failure++;
}

Parameters

update_managers

bool Flag to indicate if managers should be updated

VSPCrash()

void vsp::VSPCrash ( int crash_type )

extern

Cause OpenVSP to crash in a variety of ways.

Parameters

[in]

crash_type

int Type of crash to attempt.

VSPExit()

void vsp::VSPExit ( int error_code )

extern

Exit the program with a specific error code

Parameters

[in]

error_code

int Error code