AnalysisGroup class is used to obtain or handle the information of the analysis group.
The class can be called from Application class.
. More...

Public Member Functions
ScriptObject *	AddPostCalculationScript (String &title)
	Adds an empty post-calculation script to the analysis group. More...

ScriptObject *	AddPostCalculationScriptFromFile (String &filename)
	Adds a post-calculation script to the analysis group using the contents of the specified file. More...

void	AddRemoteCases (String array &indices)
	Add cases from remote calculations. More...

void	AddStudy (Variant &var)
	Adds a study by specifying a name or index of a project. More...

void	AddStudyById (int studyId)
	Adds a study by specifying study ID. More...

void	CheckFolderResults (String &folder)
	Imports result files (*.jplot) of the specified folder. More...

void	CheckForNewCases ()
	Checkes if there is a newly added case and adds the case to the analysis group.

void	CheckForNewResults ()
	Loads results of all cases in the analysis group study that have not yet been imported.

String	CouplingType ()
	Returns the coupling type in an analysis group. More...

void	CreateAnalysisTemplate (String &title, String &tooltip, String &folder=String(), double version=1.0 *kProjectFileVersion)
	Creates an analysis template. More...

FilterDefinition *	CreateFilterDefinition (String &name)
	Creates a FilterDefinition object by specifying a name. More...

Job *	CreateJob ()
	Creates a Job object to perform batch execution of the current case (or batch execution of all cases). A “Job” is a command to run an analysis that is exchanged between machines. More...

ParametricGraphDefinition *	CreateParametricGraphDefinition ()
	Creates a response graph. More...

void	DeleteFilterResultDefinition (Variant &val)
	Deletes a filter by specifying a name or index. More...

void	DeletePostCalculationScript (Variant &nameOrIndex)
	Deletes a post-calculation script from the analysis group. More...

void	DeleteStudy (Variant &var)
	Deletes a study by specifying a name or index of a project. More...

void	ExportAnalysisParameters (String &filename, bool openCadLink)
	Exports Analysis Parameter items to designated file. More...

void	ExportAnalysisTemplate (String &filepath, double version=1.0 *kProjectFileVersion)
	Exports a template file (*.jtmpl). More...

void	ExportCaseValueData (String &filename)
	Exports the response value table to a file (.htm, .txt, *.csv). More...

ResultViewItemList *	GetAllCasesResultViewItemList ()
	Returns result view list for all cases. More...

Condition *	GetCouplingData (Variant &val)
	Returns the coupling option. More...

int	GetCurrentCase ()
	Returns the case number of an active case. More...

String	GetDescription ()
	Returns description. More...

DesignTable *	GetDesignTable ()
	Returns the interface for setting parameters. More...

FilterDefinition *	GetFilterResultDefinition (Variant &val)
	Returns a FilterDefinition object by specifying a name or index. More...

String	GetName ()
	Returns analysis group name in character string. More...

OptimizationTable *	GetOptimizationTable ()
	Returns the optimization option. More...

ParameterSettingStatus *	GetParameterSettingStatus ()
	Returns a ParameterSettingStatus object to specify the display status of the analysis parameter list. More...

ScriptObject *	GetPostCalculationScript (Variant &nameOrIndex)
	Returns the specified post-calculation script object from the analysis group. More...

Variant	GetResponseData (String &name, int caseIndex)
	Returns all variable values for a single case response value calculation. More...

double	GetResponseVariable (String &name, int caseIndex)
	Returns the value of the specified response variable. More...

ResultViewItemList *	GetResultViewItemList ()
	Returns result view list. More...

Study *	GetStudy (Variant &var)
	Returns a Study object in an analysis group by specifying a name or index. More...

int	GetStudyId (Variant &var)
	Returns ID of a study in an analysis group. More...

String	GetUuid ()
	Returns a unique ID for the current analysis group.

bool	HasMultipleModels ()

bool	IsValid ()
	Returns True if an object is valid. More...

void	LoadFromWeightCsv (String &csvFile, String array &cases, bool isDuplicate)
	Specifies a weight file to add the case to the analysis group. More...

void	LoadRemoteResults (String array &cases)
	Imports result files (*.jplot) from remote calculation. More...

void	LoadTopologyResults (String &typeName, int cases=0)
	Loads the analysis results of topology optimization. More...

int	NumPostCalculationScripts ()
	Returns the number of post-calculation scripts registered in the analysis group.

int	NumStudies ()
	Returns the number of studies in an analysis group as an integer. More...

void	Run ()
	Runs the current case in the foreground. Other operations cannot be run in JMAG-Designer while it is running an analysis in the foreground.

void	RunAllCases ()
	Runs the all cases in the foreground. Other operations cannot be run in JMAG-Designer while it is running an analysis in the foreground.

void	RunAllPostCalculationScripts ()
	Runs all of the post-calculation scripts. More...

void	RunCoupled ()
	Corresponds to the function AnalysisGroup::Run . More...

void	RunCoupledAllCases ()
	Corresponds to the function AnalysisGroup::RunAllCases . More...

void	RunOptimization ()
	Runs the optimization.

void	RunRangeFinder ()
	Runs the range finder.

void	RunSelectStudies (String array &studylist)

void	RunSequential ()
	Corresponds to the function AnalysisGroup::Run . More...

void	RunSequentialAllCases ()
	Corresponds to the function AnalysisGroup::RunAllCases . More...

void	RunTopologyOptimization ()
	Runs the topology optimization.

void	SetCurrentCase (int caseIndex)
	Specifies the current case number. More...

void	SetDescription (String &description)
	Specifies a description. More...

void	SetName (String &name)
	Specifies the name for an analysis group. More...

void	SetSimultaneousCalculationStudy (String array &list)
	Specifies the studies in which simultaneous calculation is run in an analysis group. More...

void	SetStudyOrder (String array &list)
	Specifies the order of studies in an analysis group. More...

void	WriteTopologyConfigurationFile (String &filename, int independentJobs)
	Exports a configuration file for topology optimization. More...

Detailed Description

AnalysisGroup class is used to obtain or handle the information of the analysis group.
The class can be called from Application class.
.

Example of calling the class object:

app.GetAnalysisGroup(0)

Member Function Documentation

ScriptObject * AnalysisGroup::AddPostCalculationScript ( String & title )

Adds an empty post-calculation script to the analysis group.

Parameters

title Title for the post-calculation script object

Returns: ScriptObject object

ScriptObject * AnalysisGroup::AddPostCalculationScriptFromFile ( String & filename )

Adds a post-calculation script to the analysis group using the contents of the specified file.

Parameters

filename The file to be read

Returns: ScriptObject object

void AnalysisGroup::AddRemoteCases ( String array & indices )

Add cases from remote calculations.

Parameters

indices Indexes to add

void AnalysisGroup::AddStudy ( Variant & var )

Adds a study by specifying a name or index of a project.

Parameters

var	Name or an index of a project

void AnalysisGroup::AddStudyById ( int studyId )

Adds a study by specifying study ID.

Parameters

studyId Study ID

void AnalysisGroup::CheckFolderResults ( String & folder )

Imports result files (*.jplot) of the specified folder.

Parameters

folder Folder path

String AnalysisGroup::CouplingType ( )

Returns the coupling type in an analysis group.

Returns: Coupling type name

void AnalysisGroup::CreateAnalysisTemplate	(	String &	title,
		String &	tooltip,
		String &	folder = `String()`,
		double	version = `1.0 * kProjectFileVersion`
	)

Creates an analysis template.

Parameters

title	Name of the analysis template
tooltip	Description of analysis template
folder	Folder of analysis template
version	Save version

FilterDefinition * AnalysisGroup::CreateFilterDefinition ( String & name )

Creates a FilterDefinition object by specifying a name.

Parameters

name	Filter name

Returns: FilterDefinition object

Job * AnalysisGroup::CreateJob ( )

Creates a Job object to perform batch execution of the current case (or batch execution of all cases). A “Job” is a command to run an analysis that is exchanged between machines.

Returns: Job object

ParametricGraphDefinition * AnalysisGroup::CreateParametricGraphDefinition ( )

Creates a response graph.

Returns: ParametricGraphDefinition object

void AnalysisGroup::DeleteFilterResultDefinition ( Variant & val )

Deletes a filter by specifying a name or index.

Parameters

val	Name or index of the filter

void AnalysisGroup::DeletePostCalculationScript ( Variant & nameOrIndex )

Deletes a post-calculation script from the analysis group.

Parameters

nameOrIndex Name or index of the script

void AnalysisGroup::DeleteStudy ( Variant & var )

Deletes a study by specifying a name or index of a project.

Parameters

var	Name or an index of a project

void AnalysisGroup::ExportAnalysisParameters	(	String &	filename,
		bool	exportCADParameter
	)

Exports Analysis Parameter items to designated file.

Parameters

filename	Export file name
exportCADParameter	Whether to output CAD parameters

void AnalysisGroup::ExportAnalysisTemplate	(	String &	filepath,
		double	version = `1.0 * kProjectFileVersion`
	)

Exports a template file (*.jtmpl).

Parameters

filepath	Full path name of the JTMPL file to export
version	Save version

void AnalysisGroup::ExportCaseValueData ( String & filename )

Exports the response value table to a file (*.htm, *.txt, *.csv).

Parameters

filename File path of destination

ResultViewItemList * AnalysisGroup::GetAllCasesResultViewItemList ( )

Returns result view list for all cases.

Returns: ResultViewItemList object

Condition * AnalysisGroup::GetCouplingData ( Variant & val )

Returns the coupling option.

Parameters

var	Study name or index in an analysis group

Returns: Condition object

int AnalysisGroup::GetCurrentCase ( )

Returns the case number of an active case.

Returns: Case number

The returned Case ID is numbered from zero.

String AnalysisGroup::GetDescription ( )

Returns description.

Returns: Description

DesignTable * AnalysisGroup::GetDesignTable ( )

Returns the interface for setting parameters.

Returns: DesignTable object

FilterDefinition * AnalysisGroup::GetFilterResultDefinition ( Variant & val )

Returns a FilterDefinition object by specifying a name or index.

Parameters

val	Filter Name or index of the filter

Returns: FilterDefinition object

String AnalysisGroup::GetName ( )

Returns analysis group name in character string.

Returns: Name of the analysis group

OptimizationTable * AnalysisGroup::GetOptimizationTable ( )

Returns the optimization option.

Returns: OptimizationTable object

ParameterSettingStatus * AnalysisGroup::GetParameterSettingStatus ( )

Returns a ParameterSettingStatus object to specify the display status of the analysis parameter list.

Returns: ParameterSettingStatus object

ScriptObject * AnalysisGroup::GetPostCalculationScript ( Variant & nameOrIndex )

Returns the specified post-calculation script object from the analysis group.

Parameters

nameOrIndex Name or index of the script

Returns: ScriptObject object

Variant AnalysisGroup::GetResponseData	(	String &	name,
		int	caseIndex
	)

Returns all variable values for a single case response value calculation.

Parameters

name	Name of the response variable
caseIndex	Case ID

Returns: List of values

The caseIndex is numbered from 0.

double AnalysisGroup::GetResponseVariable	(	String &	name,
		int	caseIndex
	)

Returns the value of the specified response variable.

Parameters

name	Name of the response variable
caseIndex	Case ID

Returns: Variable value

The caseIndex is numbered from 0.

ResultViewItemList * AnalysisGroup::GetResultViewItemList ( )

Returns result view list.

Returns: ResultViewItemList object

Study * AnalysisGroup::GetStudy ( Variant & var )

Returns a Study object in an analysis group by specifying a name or index.

Parameters

var	Study name or index in an analysis group

Returns: Study object

int AnalysisGroup::GetStudyId ( Variant & var )

Returns ID of a study in an analysis group.

Parameters

var	Study name or index in an analysis group

Returns: Study ID

bool AnalysisGroup::HasMultipleModels ( )

Deprecated:: Since this is an internal function, it is not officially supported.

bool AnalysisGroup::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the AnalysisGroup objects in the list are valid

void AnalysisGroup::LoadFromWeightCsv	(	String &	csvFile,
		String array &	cases,
		bool	isDuplicate
	)

Specifies a weight file to add the case to the analysis group.

Parameters

csvFile	Weight file
cases	Cases to load
isDuplicate	Flag for duplicating the study

void AnalysisGroup::LoadRemoteResults ( String array & cases )

Imports result files (*.jplot) from remote calculation.

Parameters

cases Case indices to load

void AnalysisGroup::LoadTopologyResults	(	String &	typeName,
		int	numCases = `0`
	)

Loads the analysis results of topology optimization.

Parameters

typeName	Load type
numCases	Number of cases

int AnalysisGroup::NumStudies ( )

Returns the number of studies in an analysis group as an integer.

Returns: Number of studies in an analysis group

void AnalysisGroup::RunAllPostCalculationScripts ( )

Runs all of the post-calculation scripts.

Attention: Disabled scripts are not run.

void AnalysisGroup::RunCoupled ( )

Corresponds to the function AnalysisGroup::Run .

Deprecated:: Runs coupled analysis calculation for the current case.

void AnalysisGroup::RunCoupledAllCases ( )

Corresponds to the function AnalysisGroup::RunAllCases .

Deprecated:: Runs coupled analysis calculation for all cases included in an analysis group.

void AnalysisGroup::RunSelectStudies ( String array & studylist )

Deprecated:

Runs sequential calculation of the selected studies.

Parameters

studylist Study index to perform analysis

void AnalysisGroup::RunSequential ( )

Corresponds to the function AnalysisGroup::Run .

Deprecated:: Runs sequential calculation for the current case.

void AnalysisGroup::RunSequentialAllCases ( )

Corresponds to the function AnalysisGroup::RunAllCases .

Deprecated:: Runs sequential calculation for all cases.

void AnalysisGroup::SetCurrentCase ( int caseIndex )

Specifies the current case number.

Parameters

caseIndex Case number

The caseIndex is numbered from 0.

void AnalysisGroup::SetDescription ( String & description )

Specifies a description.

Parameters

description Description of analysis group

void AnalysisGroup::SetName ( String & name )

Specifies the name for an analysis group.

Parameters

name	Name for an analysis group

void AnalysisGroup::SetSimultaneousCalculationStudy ( String array & list )

Specifies the studies in which simultaneous calculation is run in an analysis group.

Parameters

list	List of studies to be performed simultaneously

void AnalysisGroup::SetStudyOrder ( String array & list )

Specifies the order of studies in an analysis group.

Parameters

list	Index list in an analysis group

void AnalysisGroup::WriteTopologyConfigurationFile	(	String &	filename,
		int	independentJobs
	)

Exports a configuration file for topology optimization.

Parameters

filename	File name to output
independentJobs	Number of simultaneous calculation executions

Public Member Functions

Detailed Description

Member Function Documentation