This group of funtions provides file input and output interfacing through the API.
Click here to return to the main page.
More...
◆ ExportFile()
string ExportFile |
( |
const string &in |
file_name, |
|
|
int |
write_set_index, |
|
|
int |
file_type |
|
) |
| |
Export a file from OpenVSP. Many formats are available, such as STL, IGES, and SVG. If a mesh is generated for a particular export, the ID of the MeshGeom will be returned. If no mesh is generated an empty string will be returned.
- See also
- EXPORT_TYPE
- Parameters
-
[in] | file_name | Export file name |
[in] | write_set_index | Set index to export (i.e. SET_ALL) |
[in] | file_type | File type enum (i.e. EXPORT_IGES) |
- Returns
- Mesh Geom ID if the export generates a mesh
◆ ImportFile()
Import a file into OpenVSP. Many formats are available, such as NASCART, V2, and BEM). The imported Geom, mesh, or other object is inserted as a child of the specified parent. If no parent or an invalid parent is given, the import will be done at the top level.
- See also
- IMPORT_TYPE
- Parameters
-
[in] | file_name | Import file name |
[in] | file_type | File type enum (i.e. IMPORT_PTS) |
[in] | parent | Parent Geom ID (ignored with empty string) |
◆ InsertVSPFile()
void InsertVSPFile |
( |
const string &in |
file_name, |
|
|
const string &in |
parent |
|
) |
| |
Insert an external OpenVSP project into the current project. All Geoms in the external project are placed as children of the specified parent. If no parent or an invalid parent is given, the Geoms are inserted at the top level.
- Parameters
-
[in] | file_name | *.vsp3 filename |
[in] | parent | Parent geom ID (ignored with empty string) |
◆ ReadVSPFile()
void ReadVSPFile |
( |
const string &in |
file_name | ) |
|
Load an OpenVSP project from a VSP3 file
string fid =
AddGeom(
"FUSELAGE",
"" );
string fname = "example_fuse.vsp3";
Print(
"\tSaving vehicle file to: ",
false );
Print(
string(
"--->Resetting VSP model to blank slate\n" ) );
- Parameters
-
[in] | file_name | *.vsp3 file name |
◆ SetBEMPropID()
void SetBEMPropID |
( |
const string &in |
prop_id | ) |
|
Set the ID of the propeller to be exported to a BEM file. Call this function before ExportFile.
string prop_id =
AddGeom(
"PROP" );
- See also
- EXPORT_TYPE, ExportFile
- Parameters
-
[in] | prop_id | Propeller Geom ID |
◆ SetVSP3FileName()
void SetVSP3FileName |
( |
const string &in |
file_name | ) |
|
Set the file name of a OpenVSP project
string fid =
AddGeom(
"FUSELAGE",
"" );
string fname = "example_fuse.vsp3";
Print(
"\tSaving vehicle file to: ",
false );
Print(
string(
"--->Resetting VSP model to blank slate\n" ) );
- Parameters
-
◆ WriteVSPFile()
void WriteVSPFile |
( |
const string &in |
file_name, |
|
|
int |
set |
|
) |
| |
Save the current OpenVSP project to a VSP3 file
string fid =
AddGeom(
"FUSELAGE",
"" );
string fname = "example_fuse.vsp3";
Print(
"\tSaving vehicle file to: ",
false );
Print(
string(
"--->Resetting VSP model to blank slate\n" ) );
- Parameters
-
[in] | file_name | *.vsp3 file name |
[in] | set | Set index to write (i.e. SET_ALL) |