Results Manager Functions

This group is for functions included in the Results Manager. The Results Manager stores analysis results and provides methods to get, print, and export them. Click here to return to the main page. More...

Functions
std::vector< std::string >	vsp::GetAllResultsNames ()
std::vector< std::string >	vsp::GetAllDataNames (const std::string &results_id)
int	vsp::GetNumResults (const std::string &name)
std::string	vsp::GetResultsName (const std::string &results_id)
std::string	vsp::GetResultsSetDoc (const std::string &results_id)
std::string	vsp::GetResultsEntryDoc (const std::string &results_id, const std::string &data_name)
std::string	vsp::FindResultsID (const std::string &name, int index=0)
std::string	vsp::FindLatestResultsID (const std::string &name)
int	vsp::GetNumData (const std::string &results_id, const std::string &data_name)
int	vsp::GetResultsType (const std::string &results_id, const std::string &data_name)
const std::vector< int > &	vsp::GetIntResults (const std::string &id, const std::string &name, int index=0)
const std::vector< double > &	vsp::GetDoubleResults (const std::string &id, const std::string &name, int index=0)
const std::vector< std::vector< double > > &	vsp::GetDoubleMatResults (const std::string &id, const std::string &name, int index=0)
const std::vector< std::string > &	vsp::GetStringResults (const std::string &id, const std::string &name, int index=0)
const std::vector< vec3d > &	vsp::GetVec3dResults (const std::string &id, const std::string &name, int index=0)
std::string	vsp::CreateGeomResults (const std::string &geom_id, const std::string &name)
void	vsp::DeleteAllResults ()
void	vsp::DeleteResult (const std::string &id)
void	vsp::WriteResultsCSVFile (const std::string &id, const std::string &file_name)
void	vsp::PrintResults (const std::string &results_id)
void	vsp::PrintResultsDocs (const std::string &results_id)
void	vsp::WriteTestResults ()

Detailed Description

Function Documentation

CreateGeomResults()

std::string vsp::CreateGeomResults ( const std::string & geom_id, const std::string & name )

extern

Create a new result for a Geom

//==== Test Comp Geom ====//
string gid1 = AddGeom( "POD", "" );
 
string mesh_id = ComputeCompGeom( 0, false, 0 );
 
//==== Test Comp Geom Mesh Results ====//
string mesh_geom_res_id = CreateGeomResults( mesh_id, "Comp_Mesh" );
 
array<int> @int_arr = GetIntResults( mesh_geom_res_id, "Num_Tris" );
 
if ( int_arr[0] < 4 )                                            { Print( "---> Error: API CreateGeomResults" ); __failure++; }

Parameters

[in]	geom_id	string Geom ID
[in]	name	string Result name

Returns

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteAllResults()

void vsp::DeleteAllResults ( )

extern

Delete all results

//==== Test Comp Geom ====//
string gid1 = AddGeom( "POD", "" );
 
string mesh_id = ComputeCompGeom( 0, false, 0 );
 
//==== Test Comp Geom Mesh Results ====//
string mesh_geom_res_id = CreateGeomResults( mesh_id, "Comp_Mesh" );
 
DeleteAllResults();
 
if ( GetNumResults( "Comp_Mesh" ) != 0 )                { Print( "---> Error: API DeleteAllResults" ); __failure++; }

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteResult()

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

extern

Delete a particular result

//==== Test Comp Geom ====//
string gid1 = AddGeom( "POD", "" );
 
string mesh_id = ComputeCompGeom( 0, false, 0 );
 
//==== Test Comp Geom Mesh Results ====//
string mesh_geom_res_id = CreateGeomResults( mesh_id, "Comp_Mesh" );
 
DeleteResult( mesh_geom_res_id );
 
if ( GetNumResults( "Comp_Mesh" ) != 0 )                { Print( "---> Error: API DeleteResult" ); __failure++; }

Parameters

[in]

id

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

FindLatestResultsID()

std::string vsp::FindLatestResultsID ( const std::string & name )

extern

Find the latest results ID for particular result name

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
array< string > @results_array = GetAllResultsNames();
 
for ( int i = 0; i < int( results_array.size() ); i++ )
{
    string resid = FindLatestResultsID( results_array[i] );
    if ( resid.length() == 0 )
    {
        Print( "ERROR: FindLatestResultsID found nothing" );
        __failure++;
    }
    PrintResults( resid );
}

Parameters

[in]

name

string Result name

Returns

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

FindResultsID()

std::string vsp::FindResultsID ( const std::string & name, int index = 0 )

extern

Find a results ID given its name and index

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
if ( res_id.size() == 0 )                                { Print( "---> Error: API FindResultsID" ); __failure++; }

Parameters

[in]	name	string Result name
[in]	index	int Result index

Returns

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

GetAllDataNames()

std::vector< std::string > vsp::GetAllDataNames ( const std::string & results_id )

extern

Get all data names for a particular result

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
array< string > @data_names = GetAllDataNames( res_id );
 
if ( data_names.size() != 5 )                            { Print( "---> Error: API GetAllDataNames" ); __failure++; }

Parameters

[in]

results_id

string Result ID

Returns

vector<string> Array of result names

Here is the call graph for this function:

Here is the caller graph for this function:

GetAllResultsNames()

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

extern

Get the name of all results in the Results Manager

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
array< string > @results_array = GetAllResultsNames();
if ( results_array.length() == 0 )
{
    Print( "ERROR: GetAllResultsNames returned nothing" );
    __failure++;
}
 
for ( int i = 0; i < int( results_array.size() ); i++ )
{
    string resid = FindLatestResultsID( results_array[i] );
    PrintResults( resid );
}

Returns

vector<string> Array of result names

Here is the call graph for this function:

Here is the caller graph for this function:

GetDoubleMatResults()

const std::vector< std::vector< double > > & vsp::GetDoubleMatResults ( const std::string & id, const std::string & name, int index = 0 )

extern

Get all matrix (vector<vector<double>>) values for a particular result, name, and index

string pid = AddGeom( "POD" );
 
Update();
 
string rid = ExecAnalysis( "CompGeom" );
 
array < string > @name_array = GetAllDataNames( rid );
 
for ( int i = 0 ; i < int( name_array.size() ) ; i++ )
{
    if ( GetResultsType( rid, name_array[i] ) == DOUBLE_MATRIX_DATA )
    {
        array < array < double > @ > @mat = GetDoubleMatResults( rid, name_array[i] );
        if ( mat.size() == 0 )                       { Print( "ERROR: GetDoubleMatResults" ); __failure++; }
    }
}

Parameters

[in]	id	string Result ID
[in]	name	string Data name
[in]	index	int Data index

Returns

vector<vector<double>> 2D array of data values

Here is the call graph for this function:

Here is the caller graph for this function:

GetDoubleResults()

const std::vector< double > & vsp::GetDoubleResults ( const std::string & id, const std::string & name, int index = 0 )

extern

Get all double values for a particular result, name, and index

//==== Add Pod Geom ====//
string pid = AddGeom( "POD", "" );
 
//==== Run CompGeom And View Results ====//
string mesh_id = ComputeCompGeom( SET_ALL, false, 0 );                      // Half Mesh false and no file export
 
string comp_res_id = FindLatestResultsID( "Comp_Geom" );                    // Find Results ID
 
array<double> @double_arr = GetDoubleResults( comp_res_id, "Wet_Area" );    // Extract Results
if ( double_arr.length() == 0 )
{
    Print( "ERROR: GetDoubleResults returned nothing" );
    __failure++;
}

Parameters

[in]	id	string Result ID
[in]	name	string Data name
[in]	index	int Data index

Returns

vector<double> Array of data values

Here is the call graph for this function:

Here is the caller graph for this function:

GetIntResults()

const std::vector< int > & vsp::GetIntResults ( const std::string & id, const std::string & name, int index = 0 )

extern

Get all integer values for a particular result, name, and index

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
if ( GetNumData( res_id, "Test_Int" ) != 2 )            { Print( "---> Error: API GetNumData " ); __failure++; }
 
array<int> @int_arr = GetIntResults( res_id, "Test_Int", 0 );
 
if ( int_arr[0] != 1 )                                    { Print( "---> Error: API GetIntResults" ); __failure++; }
 
int_arr = GetIntResults( res_id, "Test_Int", 1 );
 
if ( int_arr[0] != 2 )                                    { Print( "---> Error: API GetIntResults" ); __failure++; }

Parameters

[in]	id	string Result ID
[in]	name	string Data name
[in]	index	int Data index

Returns

vector<int> Array of data values

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumData()

int vsp::GetNumData ( const std::string & results_id, const std::string & data_name )

extern

Get the number of data values for a given result ID and data name

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
if ( GetNumData( res_id, "Test_Int" ) != 2 )            { Print( "---> Error: API GetNumData " ); __failure++; }
 
array<int> @int_arr = GetIntResults( res_id, "Test_Int", 0 );
 
if ( int_arr[0] != 1 )                                    { Print( "---> Error: API GetIntResults" ); __failure++; }
 
int_arr = GetIntResults( res_id, "Test_Int", 1 );
 
if ( int_arr[0] != 2 )                                    { Print( "---> Error: API GetIntResults" ); __failure++; }

Parameters

[in]	results_id	string Result ID
[in]	data_name	string Data name

Returns

int Number of data values

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumResults()

int vsp::GetNumResults ( const std::string & name )

extern

Get the number of results for a particular result name

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
if ( GetNumResults( "Test_Results" ) != 2 )                { Print( "---> Error: API GetNumResults" ); __failure++; }

Parameters

[in]

name

string Input name

Returns

int Number of results

Here is the call graph for this function:

Here is the caller graph for this function:

GetResultsEntryDoc()

std::string vsp::GetResultsEntryDoc ( const std::string & results_id, const std::string & data_name )

extern

Get the documentation string for one entry of a results object.

string pid = AddGeom( "POD" );
 
Update();
 
string rid = ExecAnalysis( "CompGeom" );
 
array < string > @name_array = GetAllDataNames( rid );
 
if ( name_array.size() > 0 )
{
    string doc = GetResultsEntryDoc( rid, name_array[0] );
 
    if ( doc.length() == 0 )                         { Print( "ERROR: GetResultsEntryDoc" ); __failure++; }
}

See also

GetResultsDoc, GetAllDataNames

Parameters

[in]	results_id	string Results ID
[in]	data_name	string Name of the entry in that results object

Returns

string Documentation for that entry

Here is the call graph for this function:

Here is the caller graph for this function:

GetResultsName()

std::string vsp::GetResultsName ( const std::string & results_id )

extern

Get the name of a result given its ID

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
 
// Set defaults
SetAnalysisInputDefaults( analysis_name );
 
string res_id = ( ExecAnalysis( analysis_name ) );
 
Print( "Results Name: ", false );
 
Print( GetResultsName( res_id ) );
 
// The name is the Results Manager's handle for this result, so looking the
// name back up has to lead to the same result.
if ( GetResultsName( res_id ).length() == 0 )
{
    Print( "ERROR: GetResultsName returned nothing" );
    __failure++;
}
 
if ( FindLatestResultsID( GetResultsName( res_id ) ) != res_id )
{
    Print( "ERROR: GetResultsName does not round trip through FindLatestResultsID" );
    __failure++;
}

Parameters

[in]

results_id

string Result ID

Returns

string Result name

Here is the call graph for this function:

Here is the caller graph for this function:

GetResultsSetDoc()

std::string vsp::GetResultsSetDoc ( const std::string & results_id )

extern

Get the documentation string for a result given its ID

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
 
// Set defaults
SetAnalysisInputDefaults( analysis_name );
 
string res_id = ( ExecAnalysis( analysis_name ) );
 
Print( "Results doc: ", false );
 
Print( GetResultsSetDoc( res_id ) );
 
if ( GetResultsSetDoc( res_id ).length() == 0 )
{
    Print( "ERROR: the result carries no documentation" );
    __failure++;
}
 
// Every entry in the result has to be documented too.
array< string > @data_names = GetAllDataNames( res_id );
 
for ( int i = 0; i < int( data_names.size() ); i++ )
{
    if ( GetResultsEntryDoc( res_id, data_names[i] ).length() == 0 )
    {
        Print( "ERROR: " + data_names[i] + " carries no documentation" );
        __failure++;
    }
}

Parameters

[in]

results_id

string Result ID

Returns

string Result documentation string

Here is the call graph for this function:

Here is the caller graph for this function:

GetResultsType()

int vsp::GetResultsType ( const std::string & results_id, const std::string & data_name )

extern

Get the data type for a given result ID and data name

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
array < string > @ res_array = GetAllDataNames( res_id );
 
if ( res_array.size() == 0 )
{
    Print( "ERROR: GetAllDataNames returned nothing" );
    __failure++;
}
 
for ( int j = 0; j < int( res_array.size() ); j++ )
{
    int typ = GetResultsType( res_id, res_array[j] );
 
    // Every entry the result lists has to report a real data type.
    if ( typ == INVALID_TYPE )
    {
        Print( "ERROR: GetResultsType returned INVALID_TYPE for " + res_array[j] );
        __failure++;
    }
}
 
// The fake results are written with known types.
if ( GetResultsType( res_id, "Test_Int" ) != INT_DATA ||
     GetResultsType( res_id, "Test_Double" ) != DOUBLE_DATA ||
     GetResultsType( res_id, "Test_String" ) != STRING_DATA )
{
    Print( "ERROR: GetResultsType reported the wrong type" );
    __failure++;
}
 
// An entry that does not exist has to report INVALID_TYPE.
if ( GetResultsType( res_id, "NoSuchEntry" ) != INVALID_TYPE )
{
    Print( "ERROR: GetResultsType accepted an unknown entry" );
    __failure++;
}
 
// That lookup failure was raised deliberately, so take it back off the queue.
while ( GetNumTotalErrors() > 0 )
{
    ErrorObj err = PopLastError();
}

See also

RES_DATA_TYPE

Parameters

[in]	results_id	string Result ID
[in]	data_name	string Data name

Returns

int Data type enum (i.e. DOUBLE_DATA)

Here is the call graph for this function:

Here is the caller graph for this function:

GetStringResults()

const std::vector< std::string > & vsp::GetStringResults ( const std::string & id, const std::string & name, int index = 0 )

extern

Get all string values for a particular result, name, and index

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
string res_id = FindResultsID( "Test_Results" );
 
array<string> @str_arr = GetStringResults( res_id, "Test_String" );
 
if ( str_arr[0] != "This Is A Test" )                    { Print( "---> Error: API GetStringResults" ); __failure++; }

Parameters

[in]	id	string Result ID
[in]	name	string Data name
[in]	index	int Data index

Returns

vector<string> Array of data values

Here is the call graph for this function:

Here is the caller graph for this function:

GetVec3dResults()

const std::vector< vec3d > & vsp::GetVec3dResults ( const std::string & id, const std::string & name, int index = 0 )

extern

Get all vec3d values for a particular result, name, and index

//==== Write Some Fake Test Results =====//
 
double tol = 0.00001;
 
WriteTestResults();
 
string res_id = FindLatestResultsID( "Test_Results" );
 
array<vec3d> @vec3d_vec = GetVec3dResults( res_id, "Test_Vec3d" );
if ( vec3d_vec.length() == 0 )
{
    Print( "ERROR: GetVec3dResults returned nothing" );
    __failure++;
}
 
Print( "X: ", false );
Print( vec3d_vec[0].x(), false );
 
Print( "\tY: ", false );
Print( vec3d_vec[0].y(), false );
 
Print( "\tZ: ", false );
Print( vec3d_vec[0].z() );

Parameters

[in]	id	string Result ID
[in]	name	string Data name
[in]	index	int Data index

Returns

vector<vec3d> Array of data values

Here is the call graph for this function:

Here is the caller graph for this function:

PrintResults()

void vsp::PrintResults ( const std::string & results_id )

extern

Print a result's name value pairs to stdout

// Add Pod Geom
string pid = AddGeom( "POD" );
 
string analysis_name = "VSPAEROComputeGeometry";
 
string rid = ExecAnalysis( analysis_name );
 
// Get & Display Results
PrintResults( rid );
 
// There has to be something to display.
if ( GetAllDataNames( rid ).size() == 0 )
{
    Print( "ERROR: the result carries no data to print" );
    __failure++;
}
 
// Every entry that gets printed has to have a value behind it.
array< string > @data_names = GetAllDataNames( rid );
 
for ( int i = 0; i < int( data_names.size() ); i++ )
{
    if ( GetNumData( rid, data_names[i] ) < 1 )
    {
        Print( "ERROR: " + data_names[i] + " has no data to print" );
        __failure++;
    }
}

Parameters

[in]

results_id

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

PrintResultsDocs()

void vsp::PrintResultsDocs ( const std::string & results_id )

extern

Print a result's names and documentation to stdout

// Add Pod Geom
string pid = AddGeom( "POD" );
 
string analysis_name = "VSPAEROComputeGeometry";
 
string rid = ExecAnalysis( analysis_name );
 
// Get & Display Results Docs
PrintResultsDocs( rid );
 
// There has to be documentation to display.
if ( GetResultsSetDoc( rid ).length() == 0 )
{
    Print( "ERROR: the result carries no documentation to print" );
    __failure++;
}
 
// Every entry that gets printed has to carry documentation of its own.
array< string > @data_names = GetAllDataNames( rid );
 
for ( int i = 0; i < int( data_names.size() ); i++ )
{
    if ( GetResultsEntryDoc( rid, data_names[i] ).length() == 0 )
    {
        Print( "ERROR: " + data_names[i] + " carries no documentation" );
        __failure++;
    }
}

Parameters

[in]

results_id

string Result ID

Here is the call graph for this function:

Here is the caller graph for this function:

WriteResultsCSVFile()

void vsp::WriteResultsCSVFile ( const std::string & id, const std::string & file_name )

extern

Export a result to CSV

// Add Pod Geom
string pid = AddGeom( "POD" );
 
string analysis_name = "VSPAEROComputeGeometry";
 
string rid = ExecAnalysis( analysis_name );
 
WriteResultsCSVFile( rid, "CompGeomRes.csv" );
// The call above should have produced a file with content in it.
file __f;
if ( __f.open( "CompGeomRes.csv", "r" ) < 0 )
{
    Print( "ERROR: WriteResultsCSVFile wrote no file" );
    __failure++;
}
else
{
    if ( __f.getSize() <= 0 )
    {
        Print( "ERROR: WriteResultsCSVFile wrote an empty file" );
        __failure++;
    }
    __f.close();
}

Parameters

[in]	id	string Rsult ID
[in]	file_name	string CSV output file name

Here is the call graph for this function:

Here is the caller graph for this function:

WriteTestResults()

void vsp::WriteTestResults ( )

extern

Generate some example results for testing.

//==== Write Some Fake Test Results =====//
WriteTestResults();
 
array< string > @results_array = GetAllResultsNames();
 
for ( int i = 0; i < int( results_array.size() ); i++ )
{
    string resid = FindLatestResultsID( results_array[i] );
    PrintResults( resid );
}
 
// Two copies of Test_Results are written, carrying five named entries with
// known values.
if ( GetNumResults( "Test_Results" ) != 2 )
{
    Print( "ERROR: WriteTestResults did not write two results" );
    __failure++;
}
 
string res_id = FindResultsID( "Test_Results" );
 
if ( GetAllDataNames( res_id ).size() != 5 )
{
    Print( "ERROR: WriteTestResults wrote the wrong number of entries" );
    __failure++;
}
 
array< int > @int_arr = GetIntResults( res_id, "Test_Int", 0 );
array< double > @dbl_arr = GetDoubleResults( res_id, "Test_Double", 0 );
array< string > @str_arr = GetStringResults( res_id, "Test_String", 0 );
 
if ( int_arr[0] != 1 || !closeTo( dbl_arr[0], 0.1, 1e-12 ) || str_arr[0] != "This Is A Test" )
{
    Print( "ERROR: WriteTestResults wrote the wrong values" );
    __failure++;
}
 
// The second copy carries the next set of values.
string res_id_1 = FindResultsID( "Test_Results", 1 );
 
int_arr = GetIntResults( res_id_1, "Test_Int", 0 );
 
if ( int_arr[0] != 2 )
{
    Print( "ERROR: WriteTestResults did not vary the second result" );
    __failure++;
}

Here is the call graph for this function:

Here is the caller graph for this function: