Design File Functions

This group of functions is available for managing Design Variables through the API.

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

Functions
void	ReadApplyDESFile (const string &in file_name)
void	WriteDESFile (const string &in file_name)
void	ReadApplyXDDMFile (const string &in file_name)
void	WriteXDDMFile (const string &in file_name)
int	GetNumDesignVars ()
void	AddDesignVar (const string &in parm_id, int type)
void	DeleteAllDesignVars ()
string	GetDesignVar (int index)
int	GetDesignVarType (int index)

Detailed Description

Function Documentation

AddDesignVar()

void AddDesignVar	(	const string &in	parm_id,
		int	type
	)

Add a design variable

See also

XDDM_QUANTITY_TYPE

Parameters

[in]	parm_id	Parm ID
[in]	type	XDDM type enum (XDDM_VAR or XDDM_CONST)

DeleteAllDesignVars()

void DeleteAllDesignVars

(

)

Delete all design variables

GetDesignVar()

string GetDesignVar

(

int

index

)

Get the Parm ID of the specified design variable

Parameters

[in]

index

Index of design variable

Returns

Parm ID

GetDesignVarType()

int GetDesignVarType

(

int

index

)

Get the XDDM type of the specified design variable

See also

XDDM_QUANTITY_TYPE

Parameters

[in]

index

Index of design variable

Returns

XDDM type enum (XDDM_VAR or XDDM_CONST)

GetNumDesignVars()

int GetNumDesignVars

(

)

Get the number of design variables

Returns

int Number of design variables

ReadApplyDESFile()

void ReadApplyDESFile

(

const string &in

file_name

)

Read in and apply a design file (*.des) to the current OpenVSP project

Parameters

[in]

file_name

*.des input file

ReadApplyXDDMFile()

void ReadApplyXDDMFile

(

const string &in

file_name

)

Read in and apply a Cart3D XDDM file (*.xddm) to the current OpenVSP project

Parameters

[in]

file_name

*.xddm input file

WriteDESFile()

void WriteDESFile

(

const string &in

file_name

)

Write all design variables to a design file (*.des)

Parameters

[in]

file_name

*.des output file

WriteXDDMFile()

void WriteXDDMFile

(

const string &in

file_name

)

Write all design variables to a Cart3D XDDM file (*.xddm)

Parameters

[in]

file_name

*.xddm output file