ProjectExportParameter Class Reference

ProjectExportParameter class is used to specify targets such as models and studies to export a project file.
The class can be created from Application class.
. More...

Public Member Functions
void	AddAnalysisGroup (Variant &val)
	Adds an analysis group. More...
void	AddModel (Variant &val)
	Adds a model. More...
void	AddStudy (Variant &val1, Variant &val2)
	Adds a study. More...
bool	IsValid ()
	Returns True if an object is valid. More...
void	SetSaveResults (bool save)
	Specifies whether or not to save results. More...
void	SetSaveVersion (double version)
	Specifies save version. More...

Detailed Description

ProjectExportParameter class is used to specify targets such as models and studies to export a project file.
The class can be created from Application class.
.

Example of creating the class object:

app.CreateProjectExportParameter()

Member Function Documentation

void ProjectExportParameter::AddAnalysisGroup

(

Variant &

val

)

Adds an analysis group.

Parameters

val	Analysis group name or analysis group ID

void ProjectExportParameter::AddModel

(

Variant &

val

)

Adds a model.

Parameters

val	Model name or model ID

void ProjectExportParameter::AddStudy	(	Variant &	val1,
		Variant &	val2
	)

Adds a study.

Parameters

val1	Model name or model ID
val2	Study name or study ID

bool ProjectExportParameter::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the ProjectExportParameter objects in the list are valid

void ProjectExportParameter::SetSaveResults

(

bool

save

)

Specifies whether or not to save results.

Parameters

save	True=1 : Saves results False=0 : Does not save results

void ProjectExportParameter::SetSaveVersion

(

double

version

)

Specifies save version.

Parameters

version

Save version