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)

int	vsp::GetAndResetUpdateCount ()

std::string	vsp::GetVSPFileName ()

void	vsp::ClearVSPModel ()

Detailed Description

Function Documentation

◆ ClearVSPModel()

void vsp::ClearVSPModel ( )

Clear the current OpenVSP model

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
//==== Reset Geometry ====//
Print( string( "--->Resetting VSP model to blank slate\n" ) );
ClearVSPModel();

◆ GetAndResetUpdateCount()

int vsp::GetAndResetUpdateCount ( )

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

Returns: int OpenVSP update count

◆ GetVSPFileName()

std::string vsp::GetVSPFileName ( )

Get the file name of the current OpenVSP project

string fid = AddGeom( "FUSELAGE", "" );             // Add Fuselage
 
string fname = "example_fuse.vsp3";
 
SetVSP3FileName( fname );
 
Update();
 
//==== Save Vehicle to File ====//
Print( "\tSaving vehicle file to: ", false );
 
Print( fname );
 
WriteVSPFile( GetVSPFileName(), SET_ALL );

Returns: File name for the current OpenVSP project

◆ Update()

void vsp::Update ( bool update_managers = true )

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

Parameters

update_managers Flag to indicate if managers should be updated

◆ VSPExit()

void vsp::VSPExit ( int error_code )

Exit the program with a specific error code