Analysis Manager Functions

This group is for functions included in the Analysis Manager. The Analysis Manager allows for OpenVSP analyses to be setup and run through the API without having to modify Parms directly. Examples are available for every available analysis type. The results of running an analysis can be accessed through the functions defined in the Results group.

Click here to return to the main page. More...

Functions
int	GetNumAnalysis ()
string []	ListAnalysis ()
string []	GetAnalysisInputNames (const string &in analysis)
string	ExecAnalysis (const string &in analysis)
int	GetNumAnalysisInputData (const string &in analysis, const string &in name)
int	GetAnalysisInputType (const string &in analysis, const string &in name)
int []	GetIntAnalysisInput (const string &in analysis, const string &in name, int index=0)
double []	GetDoubleAnalysisInput (const string &in analysis, const string &in name, int index=0)
string []	GetStringAnalysisInput (const string &in analysis, const string &in name, int index=0)
vec3d []	GetVec3dAnalysisInput (const string &in analysis, const string &in name, int index=0)
void	PrintAnalysisInputs (const string &in analysis)
void	SetAnalysisInputDefaults (const string &in analysis)
void	SetIntAnalysisInput (const string &in analysis, const string &in name, int[]@ indata_arr, int index=0)
void	SetDoubleAnalysisInput (const string &in analysis, const string &in name, double[]@ indata_arr, int index=0)
void	SetStringAnalysisInput (const string &in analysis, const string &in name, string[]@ indata_arr, int index=0)
void	SetVec3dAnalysisInput (const string &in analysis, const string &in name, vec3d[]@ indata_arr, int index=0)

Detailed Description

Function Documentation

ExecAnalysis()

string ExecAnalysis

(

const string &in

analysis

)

Execute an analysis through the Analysis Manager

Parameters

[in]

analysis

Snalysis name

Returns

Result ID

GetAnalysisInputNames()

string [] GetAnalysisInputNames

(

const string &in

analysis

)

Get the name of every available input for a particular analysis

Parameters

[in]

analysis

Snalysis name

Returns

Array of input names

GetAnalysisInputType()

int GetAnalysisInputType	(	const string &in	analysis,
		const string &in	name
	)

Get the data type for a particulat analysis type and input

See also

RES_DATA_TYPE

Parameters

[in]	analysis	Analysis name
[in]	name	Input name

Returns

int Data type enum (i.e. DOUBLE_DATA)

GetDoubleAnalysisInput()

double [] GetDoubleAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		int	index = 0
	)

Get the current double values for the particular analysis, input, and data index

See also

RES_DATA_TYPE

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	index	Data index

Returns

Array of analysis input values

GetIntAnalysisInput()

int [] GetIntAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		int	index = 0
	)

Get the current integer values for the particular analysis, input, and data index

See also

RES_DATA_TYPE

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	index	Data index

Returns

Array of analysis input values

GetNumAnalysis()

int GetNumAnalysis

(

)

Get the number of analysis types available in the Analysis Manager

Returns

Number of analyses

GetNumAnalysisInputData()

int GetNumAnalysisInputData	(	const string &in	analysis,
		const string &in	name
	)

Get the number of input data for the particular analysis type and input

Parameters

[in]	analysis	Analysis name
[in]	name	Input name

Returns

Number of input data

GetStringAnalysisInput()

string [] GetStringAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		int	index = 0
	)

Get the current string values for the particular analysis, input, and data index

See also

RES_DATA_TYPE

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	index	Data index

Returns

Array of analysis input values

GetVec3dAnalysisInput()

vec3d [] GetVec3dAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		int	index = 0
	)

Get the current vec3d values for the particular analysis, input, and data index

See also

RES_DATA_TYPE

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	index	Data index

Returns

Array of analysis input values

ListAnalysis()

string [] ListAnalysis

(

)

Get the name of every available analysis in the Analysis Manager

Returns

Array of analysis names

PrintAnalysisInputs()

void PrintAnalysisInputs

(

const string &in

analysis

)

Print to stdout all current input values for a specific analysis

Parameters

[in]

analysis

Analysis name

SetAnalysisInputDefaults()

void SetAnalysisInputDefaults

(

const string &in

analysis

)

Set all input values to their defaults for a specific analysis

Parameters

[in]

analysis

Analysis name

SetDoubleAnalysisInput()

void SetDoubleAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		double@ []	indata_arr,
		int	index = 0
	)

Set the value of a particular analysis input of double type

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	indata_arr	Array of double values to set the input to
[in]	index	Data index

SetIntAnalysisInput()

void SetIntAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		int@ []	indata_arr,
		int	index = 0
	)

Set the value of a particular analysis input of integer type

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	indata_arr	Array of integer values to set the input to
[in]	index	Data index

SetStringAnalysisInput()

void SetStringAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		string@ []	indata_arr,
		int	index = 0
	)

Set the value of a particular analysis input of string type

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	indata_arr	Array of string values to set the input to
[in]	index	Data index

SetVec3dAnalysisInput()

void SetVec3dAnalysisInput	(	const string &in	analysis,
		const string &in	name,
		vec3d@ []	indata_arr,
		int	index = 0
	)

Set the value of a particular analysis input of vec3d type

Parameters

[in]	analysis	Analysis name
[in]	name	Input name
[in]	indata_arr	Array of vec3d values to set the input to
[in]	index	int Data index