Study class is used to specify a study.
The class can be called from the Model or Application class.
. More...

Public Member Functions
void	AddCadParameter (String &name)
	Adds a CAD parameter of a model to the target. More...

void	AddCadParameters (StringList &names)
	Adds CAD parameters of a model to the target. More...

void	AddMaterialByName (String &matname)
	Adds a new material. More...

ScriptObject *	AddPostCalculationScript (String &title)
	Adds an empty post-calculation script to the study. More...

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

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

void	AddSubroutineParameter (String &name, Variant &value)
	Adds user subroutine parameters. More...

void	AddThermalModel ()
	Add a thermal model.

void	AddWarningAsError (int code)
	Adds a warning to the error list by specifying a code. More...

bool	AnyCaseHasResult ()
	Returns True as a return value if any cases of the study have analysis results. More...

void	ApplyAllCasesCadParameters ()
	Updates each value of CAD parameters for all models.

void	ApplyCadParameters ()
	Updates each value of CAD parameters for a model.

String	CalculationFolder (int caseno=-1)
	Returns calculation folder name. More...

bool	CaseHasMesh (int caseIndex)
	Returns True as a return value if mesh is generated in the specified case of the study. More...

bool	CaseHasMeshAnyPart (int caseIndex)
	Returns True as a return value if any part has a mesh in the specified case of the study. More...

bool	CaseHasResult (int caseIndex)
	Returns True as a return value if the specified case of the study has analysis results. More...

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

void	CheckForCaseResults ()
	Loads results of active cases that have not yet been imported.

void	CheckForNewCases ()
	Checks for newly cases and adds the cases to the study.

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

void	ClearAllCasesMeasurementCache ()
	Clears measurement cache all models without results.

void	ClearProbeIdSettings ()
	Deletes settings of a probe measuring position by specifying with element and node ID.

Model *	ConvertMeshToModel ()
	Creates a model from the mesh. More...

ResultCalculation *	CopyCalculation (ResultCalculation *cal)
	Returns a new ResultCalculation object by copying the specified ResultCalculation object. More...

CalculationDefinition *	CopyCalculationDefinition (CalculationDefinition *copy)
	Creates a new CalculationDefinition object by copying the specified CalculationDefinition object. More...

CalculationTarget *	CopyCalculationTarget (CalculationTarget *copy)
	Creates a new CalculationTarget object by copying the specified CalculationTarget object. More...

ContourDefinition *	CopyContour (ContourDefinition *contour)
	Creates a ContourDefinition object by copying the specified ContourDefinition object. More...

FluxLineDefinition *	CopyFluxLine (FluxLineDefinition *contour)
	Creates a FluxLineDefinition object by copying the specified FluxLineDefinition object. More...

ProbeDefinition *	CopyProbe (ProbeDefinition *copy)
	Copies a probe. More...

ScalingFactor *	CopyScaling (ScalingFactor *scaling)
	Creates a ScalingFactor object by copying the specified ScalingFactor object. More...

VectorDefinition *	CopyVector (VectorDefinition *vector)
	Creates a VectorDefinition object by copying the specified VectorDefinition object. More...

VibrationDefinition *	CopyVibrationDefinition (VibrationDefinition *vibration)
	Creates a new VibrationDefinition object by copying the specified VibrationDefinition object. More...

WindingDefinition *	CopyWinding (WindingDefinition *defn)
	Creates a new winding definition by copying an existing winding definition. More...

WindingRegion *	CopyWindingRegion (WindingRegion *copy)
	Creates a new winding region by copying an existing winding region. More...

Study *	Create2DStudy (String &name)
	Creates a 2D (or axisymmetric) Study object from the section analysis study by specifying a name. More...

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

Study *	CreateAxisymmetricCutPlaneStudy (String &study_name, String &condition_name)
	Creates a Study object of section analysis (axisymmetric) by specifying a study name or Section condition title. More...

ResultCalculation *	CreateCalculation (String &typeName, String &name)
	Creates a ResultCalculation object by specifying a name and condition type. More...

CalculationDefinition *	CreateCalculationDefinition (String &name)
	Creates a CalculationDefinition object by specifying a name (calculation of a part). More...

Circuit *	CreateCircuit ()
	Adds a new circuit. More...

CompositeResultDefinition *	CreateCompositeResult (String &name)
	Creates a CompositeResultDefinition object by specifying the name. More...

Condition *	CreateCondition (String &typeName, String &name)
	Creates a Condition object by specifying the condition type and name. More...

ContourDefinition *	CreateContour (String &name)
	Creates a ContourDefinition object by specifying the name. More...

Study *	CreateCutPlaneStudy (String &study_name, String &condition_name)
	Creates a Study object of section analysis (2D) by specifying a study name and a Section condition title. More...

DifferenceEfficiencyMapDefinition *	CreateDifferenceEfficiencyMapDefinition (String &name)
	Creates an new DifferenceEfficiencyMapDefinition onject. More...

void	CreateDriveCycleResponseParametricData (DriveCycleResponseDataParameter *parameter)
	Creates an drive cycle response value from parameter object. More...

CalculationDefinition *	CreateEdgeCalculationDefinition (String &name)
	Creates a CalculationDefinition object by specifying a name (calculation of an edge). More...

CalculationTarget *	CreateEdgeCalculationTarget (String &name)
	Creates a CalculationTarget object by specifying a name (edge). More...

EfficiencyMapDefinition *	CreateEfficiencyMapDefinition (String &name)
	Creates an new EfficiencyMapDefinition onject. More...

void	CreateEfficiencyMapParametricData (Variant &val, EfficiencyMapResponseDataParameter *parameter)
	Creates an efficiency map response value by specifying the efficiency map name or index. More...

ExternalEfficiencyMapDefinition *	CreateExternalEfficiencyMapDefinition (String &name)
	Creates an new ExternalEfficiencyMapDefinition onject. More...

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

FluxLineDefinition *	CreateFluxLine (String &name)
	Creates a FluxLineDefinition object by specifying the 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...

void	CreateKeepMeshSkinDepth ()
	Applies settings of mesh with skin depth that is not applied.

Study *	CreateLossStudy (String &name)
	Creates a Study object of iron loss analysis by specifying a name. More...

void	CreateMesh ()
	Generates mesh.

Part *	CreateMeshPart (String &name)
	Creates a new mesh part in the study. More...

void	CreateMorphing ()
	Generates morphing.

void	CreateParametricDataFromCalculation (Variant &val, ResponseDataParameter *parameter, int index=0)
	Creates a response data by specifying the calculation name or index. More...

void	CreateParametricDataFromProbe (Variant &val, ResponseDataParameter *parameter, int index=0)
	Creates a response data by specifying the probe name or index. More...

void	CreateParametricDataFromSection (Variant &val, ResponseDataParameter *parameter, int index=0)
	Creates a response data by specifying the section graph name or index. More...

void	CreateParametricDataFromTable (String &val, ResponseDataParameter *parameter)
	Creates a response data by specifying the table name. More...

void	CreateParametricDataFromVectorExpression (Variant &val, ResponseDataParameter *parameter)
	Creates response data by specifying the vector exprssion name. More...

void	CreateParametricDataFromVibration (Variant &val, ResponseDataParameter *parameter, int index=0)
	Creates a response data by specifying the vibration name or index. More...

DataSet *	CreateParametricGraph (String &xaxis, int xseries, String &yaxis, bool pareto=false)
	Creates a response graph. More...

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

DataSet *	CreateParametricGraphWithName (String &graphname, String &xaxis, int xseries, String &yaxis, bool pareto=false)
	Creates a response graph by specifying a name. More...

Condition *	CreatePostCondition (String &typeName, String &name)
	Specifies the magnetic flux calculation to magnetic field analysis study. More...

ProbeDefinition *	CreateProbe (String &name)
	Creates a probe by specifying a name. More...

ResponseTableDefinition *	CreateResponseTableDefinition (String &name)
	Creates a ResponseTableDefinition definition for an accuracy priority efficiency map study. More...

ResponseTableResultType *	CreateResponseTableResultType (String &name)
	Creates a new response table result type definition (accuracy priority efficiency map study) More...

ScalingFactor *	CreateScaling (String &name)
	Creates a ScalingFactor object by specifying the name. More...

void	CreateScriptParametricData (String &title, String &variable, String &script)
	Creates script response values. More...

SectionGraph *	CreateSectionGraph (String &name, Variant &index=-1)
	Creates a SectionGraph object by specifying a name. More...

CalculationDefinition *	CreateSurfaceCalculationDefinition (String &name)
	Creates a CalculationDefinition object by specifying a name (calculation of a face). More...

CalculationTarget *	CreateSurfaceCalculationTarget (String &name)
	Creates a CalculationTarget object by specifying a name (face). More...

ResponseTableCorrection *	CreateTableCorrection (String &name)
	Creates a new response table correction object for speed priority efficiency maps. More...

TableDefinition *	CreateTableDefinition ()
	Creates a TableDefinition object. More...

ThermalEfficiencyMapDefinition *	CreateThermalEfficiencyMapDefinition (String &name)
	Creates an new ThermalEfficiencyMapDefinition object for a thermal analysis. More...

ThermalModelDefinition *	CreateThermalModelDefinition (String &name)
	Creates a new thermal model definition. More...

ThermalModelRegion *	CreateThermalModelRegion (String &name)
	Creates a new thermal model region definition. More...

VectorDefinition *	CreateVector (String &name)
	Creates a VectorDefinition object by specifying the name. More...

VectorExpression *	CreateVectorExpression (String &name)
	Creates a VectorExpression object by specifying the name. More...

VibrationDefinition *	CreateVibrationDefinition (String &name)
	Creates a VibrationDefinition object by specifying a name. More...

WindingDefinition *	CreateWinding (String &type, String &name)
	Creates a winding definition. More...

WindingRegion *	CreateWindingRegion (String &name, Variant &type=0)
	Creates a new winding region definition. More...

int	CurrentIndexPostCalculationScripts ()
	Returns the index of the active post-calculation script list. More...

void	DeleteAirMesh ()
	Deletes the mesh in the air region.

void	DeleteCadParameter (String &name)
	Removes a CAD parameter of a model from the target. More...

void	DeleteCalculation (Variant &val)
	Deletes a calculation item by specifying a name or index. More...

void	DeleteCalculationDefinition (Variant &val)
	Deletes a CalculationDefinition object by specifying name or index. More...

void	DeleteCalculationTarget (Variant &val)
	Deletes a CalculationTarget object by specifying name or index. More...

void	DeleteCircuit ()
	Deletes a circuit.

void	DeleteCompositeResult (Variant &val)
	Deletes composite result by specifying a name or index. More...

void	DeleteCondition (Variant &val)
	Deletes a condition by specifying the name or index. More...

void	DeleteContour (Variant &val)
	Deletes a contour plot by specifying a name or index. More...

void	DeleteDifferenceEfficiencyMapDefinition (Variant &val)
	Deletes an DifferenceEfficiencyMapDefinition onject by specifying the name or index. More...

void	DeleteEfficiencyMapDefinition (Variant &val)
	Deletes an EfficiencyMapDefinition onject by specifying the name or index. More...

void	DeleteExternalEfficiencyMapDefinition (Variant &val)
	Deletes an ExternalEfficiencyMapDefinition onject by specifying the name or index. More...

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

void	DeleteFluxLine (Variant &val)
	Deletes a flux line plot by specifying a name or index. More...

void	DeleteMesh ()
	Deletes mesh in the active case.

void	DeleteMeshAllCases ()
	Deletes mesh of all cases.

void	DeleteMeshPart (Variant &var)
	Removes a mesh part from the study. More...

void	DeleteParametricData (Variant &val)
	Deletes a response data by specifying the name or index. More...

void	DeletePostCalculationScript (Variant &nameOrIndex)
	Deletes a post-calculation script from the study by specifying the name or index. More...

void	DeletePostCondition (Variant &val)
	Deletes the post condition by specifying the name or index. More...

void	DeleteProbe (Variant &val)
	Deletes a probe by specifying a name or index. More...

void	DeleteResponseTable (CircuitComponent *component)
	Deletes the response value table created from the RT component. More...

void	DeleteResponseTableDefinition (Variant &val)
	Deletes a response table definition object by specifying the name or index. More...

void	DeleteResponseTableResultType (Variant &val)
	Deletes a response table result type definition by specifying the name or index (accuracy priority efficiency map study) More...

void	DeleteResult ()
	Deletes results of all cases. This command also deletes result files.

void	DeleteResultCase (int caseno)
	Deletes the result of the specified case. This command also deletes result files. More...

void	DeleteResultCaseFromStudy (int caseno)
	Removes the result of the specified case from the study. More...

void	DeleteResultCurrentCase ()
	Deletes results of a current case. This command also deletes result files.

void	DeleteResultCurrentCaseFromStudy ()
	Removes the result of a current case from a study. More...

void	DeleteResultFromStudy ()
	Removes results of all cases from a study. More...

void	DeleteScaling (Variant &val)
	Deletes scaling by specifying a name or index. More...

void	DeleteSectionGraph (Variant &val)
	Deletes a section graph by specifying a name or index. More...

void	DeleteTableCorrection (Variant &val)
	Deletes a ResponseTableCorrection by specifying the name or index. More...

void	DeleteThermalEfficiencyMapDefinition (Variant &val)
	Deletes an ThermalEfficiencyMapDefinition onject by specifying the name or index. More...

void	DeleteThermalModel ()
	Delete a thermal model.

void	DeleteThermalModelDefinition ()
	Deletes a thermal model definition.

void	DeleteThermalModelRegion ()
	Deletes a thermal model region definition.

void	DeleteUseWinding ()
	Removes all windings from the study.

void	DeleteVector (Variant &val)
	Deletes a vector plot by specifying a name or index. More...

void	DeleteVectorExpression (Variant &val)
	Deletes a vector expression object by specifying a name or index. More...

void	DeleteVibrationDefinition (Variant &val)
	Deletes a VibrationDefinition object by specifying name or index. More...

void	DeleteWinding (Variant &val)
	Deletes an winding definition by specifying the name or index. More...

void	DeleteWindingRegion (Variant &val)
	Deletes an winding region definition by specifying the name or index. More...

SectionGraph *	DuplicateSectionGraph (Variant &val)
	Returns a duplicated SectionGraph by specifying a name or index. More...

void	ExpandThermalModel ()
	Expand a thermal model definition.

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

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

bool	ExportMinMaxTable (TableDefinition *def, String &filename)
	Exports a file (.htm, .txt, *.csv) to the min/max table. More...

bool	ExportPositionTable (TableDefinition *def, String &filename)
	Exports a file (.htm, .txt, *.csv) to the position table. More...

void	ExportResponseTable (String &filename, Variant &nameOrIndex, int caseIndex, double temp=0.0)
	Exports response table of efficiency map to file. More...

bool	ExportResultValuesTable (TableDefinition *def, String &filename)
	Exports a file (.htm, .txt, *.csv) to the result values table. More...

void	ExportRttFile (RttFileParameter *parameter)
	Exports an rtt file using the parameters set in RttFileParameter object. More...

void	ExportSubroutineParameter (String &filename)
	Exports user subroutine parameters to a file (.csv, .txt). More...

bool	ExportTable (TableDefinition *def, String &filename, Variant &filetype)
	Exports a file (.htm, .txt, *.csv) to the result table. More...

void	ExportTags (String &filename)
	Exports user defined tags to a file (.csv, .txt). More...

bool	ExportTranslationFile (String &filename)
	Since this is an internal function, it is not officially supported. More...

void	ForceRebuildCadParameters ()
	Rebuilds the current case model. This function rebuilds the model even if the current case has results.

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

ResultCalculation *	GetCalculation (Variant &val)
	Returns the ResultCalculation object by specifying a name or index. More...

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

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

bool	GetCheckForTopologyChanges ()
	Returns whether or not to check the increase or decrease in the number of parts, faces, edges, and vertices. More...

Circuit *	GetCircuit ()
	Returns a Circuit object. More...

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

Condition *	GetCondition (Variant &val)
	Returns a Condition object by specifying the name or index. More...

Variant	GetConditionTypes ()
	Returns the list of usable condition types. More...

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

bool	GetCopyOnUpdate ()
	Returns whether or not to copy a study on model update. More...

ResponseCreateAdditionalPointsInfo *	GetCreateResponseAdditionalPointsInfo ()
	Returns a ResponseCreateAdditionalPointsInfo object to specify additional calculation points for efficiency map speed priority. More...

ResponseCreateInfo *	GetCreateResponseInfo ()
	Returns a ResponseCreateInfo object to specify the efficiency map response table settings. More...

int	GetCurrentCase ()
	Returns the current active case ID. More...

DataSet *	GetDataSet (String &name, int caseno)
	Returns a DataSet object by specifying a name. More...

String	GetDescription ()
	Returns the description. More...

DesignTable *	GetDesignTable ()
	Returns interface for parametric settings. More...

DifferenceEfficiencyMapDefinition *	GetDifferenceEfficiencyMapDefinition (Variant &val)
	Returns an DifferenceEfficiencyMapDefinition onject by specifying the name or index. More...

EfficiencyMapPlot *	GetDifferenceEfficiencyMapPlot (Variant &val)
	Returns an EfficiencyMapPlot object by specifying the name or index. More...

EfficiencyMapDefinition *	GetEfficiencyMapDefinition (Variant &val)
	Returns an EfficiencyMapDefinition onject by specifying the name or index. More...

EfficiencyMapPlot *	GetEfficiencyMapPlot (Variant &val)
	Returns an EfficiencyMapPlot object by specifying the name or index. More...

ExternalEfficiencyMapDefinition *	GetExternalEfficiencyMapDefinition (Variant &val)
	Returns an ExternalEfficiencyMapDefinition onject by specifying the name or index. More...

EfficiencyMapPlot *	GetExternalEfficiencyMapPlot (Variant &val)
	Returns an EfficiencyMapPlot object by specifying the name or index. More...

double	GetFacesHeight (String array &faceIds, Point *vector)
	Returns the height of the face in the specified direction. More...

double	GetFacesMaximumDistanceFromAxis (String array &faceIds, Point origin, Point vector)
	Returns the maximum distance between the specified face and axis. More...

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

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

String	GetHiddenResults ()
	Returns the table result items to hide. More...

Study *	GetMasterStudy ()
	Returns a Master Study object. More...

Material *	GetMaterial (Variant &val)
	Returns the material specified for a part with the name or ID. More...

String	GetMaterialAttributeParameters ()
	Returns a list of material properties. More...

Material *	GetMaterialByIndex (int index)
	Returns the material by specifying the index. More...

MeasurementVariable *	GetMeasurementVariable (Variant &val)
	Returns a measurement variable by specifying name or index. More...

MeshControl *	GetMeshControl ()
	Returns a MeshControl object to specify mesh properties. More...

MeshGroupList *	GetMeshGroupList ()
	Returns mesh group list. More...

Part *	GetMeshPart (Variant &var)
	Returns a mesh part object from the study. More...

Part *	GetMeshPartByIndex (int index)
	Returns a mesh part object from the study by index. More...

MeshToModelParameter *	GetMeshToModelParameter ()
	Returns an MeshToModelParameter object. More...

Condition *	GetModelCopyControl ()
	Returns the object of the model copy that is created when the study has results. The model copy is created as a Condition object. More...

String	GetName ()
	Returns the name of a study as a string. More...

Variant	GetNodeIdsOnEdge (int edgeId)
	Returns a list of IDs of nodes on the specified edge. More...

Variant	GetNodeIdsOnFace (int faceId)
	Returns a list of IDs of nodes on the specified face. More...

OptimizationTable *	GetOptimizationTable ()
	Returns the optimization table object. 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 study. More...

Variant	GetPostCalculationScriptParameter (Variant &nameOrIndex, String &key)
	Returns a post-calculation script parameter from the study by specifying the name or index. More...

Condition *	GetPostCondition (Variant &val)
	Returns a magnetic flux calculation by specifying the name or index. More...

double	GetPostValue (String &name)
	Returns result value of a scalar type. More...

ProbeDefinition *	GetProbe (Variant &val)
	Returns a probe by specifying a name or index. More...

Report *	GetReport ()
	Returns a Report object. More...

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

ResponseTableDefinition *	GetResponseTableDefinition (Variant &val)
	Returns a response table definition object by specifying the name or index. (accuracy priority efficiency map study) More...

ResponseTableResultType *	GetResponseTableResultType (Variant &val)
	Returns a response table result type definition by specifying the name or index (accuracy priority efficiency map study) More...

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

String	GetResultFileName ()
	Returns the result file name (.jplot, .plot). More...

StringList	GetResultFileNameList ()
	Returns a list of result files in a study as a character string. More...

Variant	GetResultFileNames ()
	Returns the list of result files in a study. More...

ResultTable *	GetResultTable ()
	Returns a ResultTable object. More...

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

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

String	GetScriptTypeName ()
	Returns the study type as a character string. More...

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

Study *	GetSlaveStudy (Variant &val)
	Returns a slave study object by specifying the name or index. More...

Step *	GetStep ()
	Returns a Step object to specify the step control and frequency control of study properties. More...

int	GetStudyId ()
	Returns a unique study ID within the project. More...

StudyProperties *	GetStudyProperties ()
	Returns a StudyProperties object. More...

ResponseTableCorrection *	GetTableCorrection (Variant &val)
	Returns a ResponseTableCorrection object by specifying the name or index. More...

String	GetTagName (int index)
	Provides the tag name at the given index. More...

String	GetTagValue (Variant &indexOrName)
	Provides tag value at the given index. More...

ThermalEfficiencyMapDefinition *	GetThermalEfficiencyMapDefinition (Variant &val)
	Returns an ThermalEfficiencyMapDefinition onject by specifying the name or index. More...

ThermalModelDefinition *	GetThermalModelDefinition ()
	Returns a thermal model definition. More...

ThermalModelRegion *	GetThermalModelRegion ()
	Returns a thermal model region definition. More...

String	GetType ()
	Returns the analysis type of the study as a character string. More...

bool	GetUpdateCaseValuesWithGeometryAdjustedValues ()
	Returns whether to update the case value with the adjusted value. More...

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

ParametricEquation *	GetVariable (Variant &name)
	Returns an equation by specifying a variable. More...

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

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

Variant	GetVectorPostValue (String &name)
	Returns result value of vector type. More...

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

WindingDefinition *	GetWinding (Variant &val)
	Returns an winding definition by specifying the name or index. More...

WindingRegion *	GetWindingRegion (Variant &val)
	Returns an winding region definition by specifying the name or index. More...

bool	HasCircuit ()
	Returns True as a return value if a circuit exists in the study. More...

bool	HasIntersection ()
	Checks interference among parts in a current case. More...

bool	HasMasterStudy ()
	Returns True as a return value if a master study exists in the study. More...

bool	HasMesh ()
	Returns True as a return value if mesh is generated in the current case of the study. More...

bool	HasMeshAnyPart ()
	Returns True as a return value if any part has a mesh in the current case of the study. More...

bool	HasParametricData (String &name)
	Returns True as a return value if there is a response value with the name specified in the study. More...

bool	HasResult ()
	Returns True as a return value if the current case of the study has analysis results. More...

bool	HasUseWinding ()
	Returns True if the study uses windings. More...

void	ImportSubroutineParameter (String &filename)
	Imports user subroutine parameters from a file (.csv, .txt). More...

void	ImportTags (String &filename)
	Imports user defined tags from a file (.csv, .txt). More...

bool	ImportTranslationFile (String &filename)
	Since this is an internal function, it is not officially supported. More...

bool	IsAxisymmetricStudy ()
	Returns True as a return value if the study is an axisymmetric analysis. More...

bool	IsCutPlaneStudy ()
	Returns True as a return value if the study is a cross section analysis. More...

bool	IsModelError (int caseno=-1)
	Returns True as a return value if there is a model error. More...

bool	IsModelWarning (int caseno=-1)
	Returns True as a return value if there is a model warning. More...

bool	IsPartSuppressed (Variant &part)
	Returns suppressed state of a part. More...

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

Circuit *	LoadCircuit (String &filename)
	Adds a circuit by importing the specified file. More...

void	LoadFromWeightCsv (String &csvFile, String array &cases, bool isDuplicate)
	Adds a case to the study by specifying a weight file. More...

bool	LoadMesh ()
	Loads created mesh in current case. More...

void	LoadMeshAllCases ()
	Loads created mesh in all cases.

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...

String	MagnetizedMaterialName ()
	Returns the name of the user magnetization material created from an analysis in a study running a magnetization analysis. More...

double	MeasureDistance (String &fromType, Variant &fromID, String &toType, Variant &toID)
	Measures the distance between specified entities. More...

double	MeasureDistanceFrom (double x, double y, double z, String &toType, Variant &toID)
	Measures the distance between the specified coordinates (x, y, z) and specified entity. More...

double	MeasureDistanceFromPoint (Point *p, String &toType, Variant &toID)
	Measures the distance between the specified Point object and entity. More...

double	MeasureNodeAngle (Variant &fromID, Variant &centerID, Variant &toID)
	Measures the angle of three specified points. More...

double	MeasurePointNodeAngle (double x, double y, double z, Variant &fromID, Variant &toID)
	Measures the angle of the specified center point and two points. More...

double	MeasurePointVertexAngle (double x, double y, double z, Variant &fromID, Variant &toID)
	Measures the angle of the specified center point and two points. More...

double	MeasureVertexAngle (Variant &fromID, Variant &centerID, Variant &toID)
	Measures the angle of the three specified points. More...

void	MergeJcf (String &filename)
	Specifies the jcf file path and merges model data of the jcf file into the current study. More...

void	MergeJcfForPreview (String &filename)
	Since this is an internal function, it is not officially supported. More...

int	NumAirRegions ()
	Returns the number of air regions as an integer. More...

int	NumCalculationDefinitions ()
	Returns the number of calculation items (parts, faces, edges) defined in a study as an integer. More...

int	NumCalculations ()
	Returns number of calculation items as an integer. More...

int	NumCalculationTargets ()
	Returns the number of calculation targets defined in a study as an integer. More...

int	NumConditions ()
	Returns the number of conditions in the study as an integer. More...

int	NumContours ()
	Returns the number of contour plots as an integer. More...

int	NumDifferenceEfficiencyMapDefinitions ()
	Returns the number of difference efficiency map definitions. More...

int	NumEfficiencyMapDefinitions ()
	Returns the number of efficiency map definitions. More...

int	NumExternalEfficiencyMapDefinitions ()
	Returns the number of external efficiency map definitions. More...

int	NumFluxLines ()
	Returns the number of flux line plots as an integer. More...

int	NumMaterials ()
	Returns the number of materials. More...

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

int	NumPostConditions ()
	Returns the number of the magnetic flux calculation in a magnetic field analysis study as an integer. More...

int	NumPostParameters ()
	Returns the number of post parameters as an integer. More...

int	NumProbes ()
	Returns the number of probes. More...

int	NumResponseTableDefinitions ()
	Returns the number of response table definitions (accuracy priority efficiency map study). More...

int	NumResponseTableResultTypes ()
	Returns the number of response table result type definitions (accuracy priority efficiency map study) More...

int	NumScalings ()
	Returns the number of scalings as an integer. More...

int	NumSectionGraphs ()
	Returns the number of section graphs as an integer. More...

int	NumSlaveStudies ()
	Returns the number of slave studies in the study as an integer. More...

int	NumTableCorrections ()
	Returns the number of response table correction definitions. More...

int	NumTags ()
	Provides the number of tags in the study.

int	NumThermalEfficiencyMapDefinitions ()
	Returnsthe number of efficiency map definitions for a thermal analysis. More...

int	NumVectors ()
	Returns the number of vector plots as an integer. More...

int	NumVibrationDefinitions ()
	Returns the number of vibration items defined in a study as an integer. More...

int	NumWindingRegions ()
	Returns the number of winding region definitions. More...

int	NumWindings ()
	Returns the number of winding definitions. More...

Variant	ParametricDataNames ()
	Returns the name list of parameters. More...

String	PostParameterName (int index)
	Returns a post parameter name by specifying an index. More...

int	PostParameterType (String &name)
	Returns post parameter type by specifying a name. More...

void	RebuildAllCasesCadParameters ()
	Rebuilds all models without results.

bool	RemoveAllResults ()
	Deletes the all results from the result file of the current case. Mesh is also removed. More...

bool	RemoveAllResultsAllCases ()
	Deletes the all results from the result file of the all cases. Mesh is also removed. More...

void	RemoveMaterialByName (String &matname)
	Deletes a material by specifying a name. More...

void	RemoveMeasurementVariable (Variant &val)
	Deletes the measurement variable by specifying name or index. More...

bool	RemoveSelectedResults (StringList &results)
	Deletes the specified results from the result file of the current case. More...

bool	RemoveSelectedResultsAllCases (StringList &results)
	Deletes the specified results from the result file of the all cases. More...

bool	RemoveSelectedResultsStepList (StringList &results, String &steps)
	Deletes the specified result from the result file of the current case by specifying multiple retained steps to the result file with a character string. More...

bool	RemoveSelectedResultsStepListAllCases (StringList &results, String &steps)
	Deletes the specified result from the result file of the current case by specifying multiple retained steps to the result file with a character string. More...

bool	RemoveSelectedResultsSteps (StringList &results, int start, int end, int inter)
	Deletes the specified result from the result file of the current case by specifying the range and interval of the retained step to the result file. More...

bool	RemoveSelectedResultsStepsAllCases (StringList &results, int start, int end, int inter)
	Deletes the specified result from the result file of all cases by specifying the range and interval of the retained step to the result file. More...

void	RemoveSubroutineParameter (String &name)
	Deletes user subroutine parameters. More...

void	RemoveTag (String &name)
	Removes the designated user defined tag More...

void	RemoveVariable (Variant &name)
	Deletes the equation by specifying a variable. More...

void	RemoveWarningAsError (int code)
	Deletes the warning from the error list by specifying a code. More...

void	Restart (int steps, int outputStep)
	Resumes calculation of selected study. More...

void	RestartAdaptive (int stages)
	Specifies the maximum stage of the adaptive mesh control and resumes the calculation of the selected study. More...

void	RevertMesh ()
	Reverts the meshes of the current study to the meshes of the original model, when the original model of the current study has meshes.

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. More...

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. More...

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

void	RunOptimization ()
	Runs optimization.

void	RunRangeFinder ()
	Runs the range finder.

void	RunTopologyOptimization ()
	Runs the topology optimization.

void	SetAirRegionVisibility (int index, bool visible)
	Switches the display of the air region. More...

void	SetCadParameterValue (String &name, Variant &value)
	Specifies a value for the CAD parameter of a model. More...

void	SetCheckForTopologyChanges (bool flag)
	Specifies whether or not to check the increase or decrease in the number of parts, faces, edges, and vertices. More...

void	SetCopyOnUpdate (bool flag)
	Specifies whether or not to copy a study during model update. More...

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

void	SetCurrentComposite (Variant &val)
	Specifies a name or index to dispaly the composite result. More...

void	SetCurrentContour (Variant &val)
	Specifies a name or index to specify the contour plot that is displayed. More...

void	SetCurrentFluxLine (Variant &val)
	Specifies a name or index to specify the flux line that is displayed. More...

void	SetCurrentScaling (Variant &val)
	Specifies a name or index to specify the scale that is displayed. More...

void	SetCurrentVector (Variant &val)
	Specifies a name or index to specify the vector plot that is displayed. More...

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

void	SetHiddenResults (String &list)
	Specifies the table result items to hide. More...

void	SetMaterial (Variant &val, Material *material)
	Specifies a material to a part using a variable. More...

void	SetMaterialAttributeParameters (String &items)
	Specifies material attribute items. More...

void	SetMaterialByName (Variant &val, String &matname)
	Specifies a material to a part using a variable. More...

void	SetMeasurementVariable (String &name, String &type, Selection *sel)
	Specifies a measurement variable. More...

void	SetMessageVisible (bool on)
	Since this is an internal function, it is not officially supported. More...

void	SetModelDivisionCadParameterName (String &name)
	Specifies the CAD parameter name that sets the number of divisions determined from the winding condition. More...

void	SetName (String &name)
	Specifies the name of a study. More...

void	SetPostCalculationScriptParameter (Variant &nameOrIndex, String &key, Variant &value)
	Specifies a post-calculation script parameter from the study by specifying the name or index. More...

void	SetTag (String &name, String &value)
	Adds a user defined tag. If the tag's name already exist it updates the tag with the given value. More...

void	SetUpdateByRelation (bool flag)
	Specifies whether to consider Parent-Child relation (Condition Parts to setting target). More...

void	SetUpdateCaseValuesWithGeometryAdjustedValues (bool flag)
	Specifies whether to update the case value with the adjusted value. More...

void	SetUseModelDivisionCadParameter (bool flag)
	Specifies whether to determine the number of divisions from the winding conditions. True=1 : Used False=0 : Does not used.

void	SetUserResponseVariable (String &name, int caseIndex, double value)
	Specifies or creates a variable of a response value using an user-defined value. More...

void	SetVariable (Variant &name, Variant &value)
	Specifies an equation. More...

void	SubmitAllLocal (bool queued)
	Corresponds to the following function of JMAG-Designer13.0 or later. CreateJob. More...

void	SubmitAllRemote (String &machine, String &cpu, Variant &keepremote, bool queued)
	Corresponds to the following function of JMAG-Designer13.0 or later. CreateJob. More...

void	SubmitLocal (bool queued)
	Corresponds to the following function of JMAG-Designer 13.0 or later. CreateJob. More...

void	SubmitRemote (String &machine, String &cpu, Variant &keepremote, bool queued)
	Corresponds to the following function of JMAG-Designer13.0 or later. CreateJob. More...

void	SuppressPart (Variant &part, int state)
	Specifies suppression to a part. More...

void	UnLockAll ()
	Since this is an internal function, it is not officially supported. More...

void	UpdateDriveCycleResponseParametricData (Variant &val, DriveCycleResponseDataParameter *parameter)
	Changes the response value of the drive cycle by specifying a name or index. More...

void	UpdateEfficiencyMapParametricData (Variant &val, EfficiencyMapResponseDataParameter *parameter)
	Changes the response value of the efficiency map by specifying a name or index. More...

void	UpdateParametricData (Variant &val, ResponseDataParameter *parameter)
	Changes a response data by specifying the name or index. More...

void	UpdateScriptParametricData (Variant &val, String &title, String &variable, String &script)
	Changes the script's response value by name or index. More...

void	UpdateSkew ()
	Applies skew on mesh if it is not applied.

void	UpdateSubroutineParameter (String &name, Variant &value)
	Updates user subroutine parameters. More...

void	WriteAllMeshJcf (String &path, String &filename, bool active)
	Exports JCF file (mesh data) of all cases included in a study to the specified folder. More...

void	WriteAllSolidJcf (String &path, String &filename, bool active, bool need_preprocess=true)
	Exports JCF file (geometry data) of all cases included in a study to the specified folder. More...

void	WriteAllSolidPartialMeshJcf (String &path, String &filename, bool active, bool need_preprocess=true)
	Exports JCF file (geometry data contain partial mesh) of all cases included in a study to the specified folder. More...

bool	WriteCaseReport (String &filename)
	Exports the case report. More...

void	WriteCoilPositionJsonFile (String &filename)
	Since this is an internal function, it is not officially supported. More...

void	WriteMeshJcf (String &filename)
	Exports a JCF file (mesh data) by specifying a file path. More...

void	WriteModelOutlineJsonFile (String &filename)
	Since this is an internal function, it is not officially supported. More...

bool	WriteResponseReport (String &filename)
	Exports a parametric report. More...

void	WriteSolidJcf (String &filename, bool need_preprocess=true)
	Exports a JCF file (geometry data) by specifying a file path. More...

void	WriteSolidPartialMeshJcf (String &filename, bool need_preprocess=true)
	Exports a JCF file (geometry data contain partial mesh) by specifying a file path. More...

void	WriteTopologyConfigurationFile (String &filename, int independentJobs)
	Runs the topology optimization. More...

Detailed Description

Study class is used to specify a study.
The class can be called from the Model or Application class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0)

Member Function Documentation

void Study::AddCadParameter ( String & name )

Adds a CAD parameter of a model to the target.

Parameters

name	Name of the CAD parameter

void Study::AddCadParameters ( StringList & names )

Adds CAD parameters of a model to the target.

Parameters

names List of CAD parameter names

void Study::AddMaterialByName ( String & matname )

Adds a new material.

Parameters

matname Material

ScriptObject * Study::AddPostCalculationScript ( String & title )

Adds an empty post-calculation script to the study.

Parameters

title The tile for the script object

Returns: Returns the added script object

ScriptObject * Study::AddPostCalculationScriptFromFile ( String & filename )

Adds an post-calculation script to the study using the contents of the specified file.

Parameters

filename The file to be read

Returns: Returns the added script object

void Study::AddRemoteCases ( String array & indices )

Add cases from remote calculations.

Parameters

indices Indexes to add

void Study::AddSubroutineParameter	(	String &	name,
		Variant &	value
	)

Adds user subroutine parameters.

Parameters

name	User variable name
value	Value

void Study::AddWarningAsError ( int code )

Adds a warning to the error list by specifying a code.

Parameters

code Code

bool Study::AnyCaseHasResult ( )

Returns True as a return value if any cases of the study have analysis results.

Returns: Whether or not any cases of the study have analysis results

String Study::CalculationFolder ( int caseno = -1 )

Returns calculation folder name.

Parameters

caseno Case ID

Returns: Calculation folder name

bool Study::CaseHasMesh ( int caseIndex )

Returns True as a return value if mesh is generated in the specified case of the study.

Parameters

caseIndex Case ID

Returns: Whether or not the specified case of the study has mesh

The caseIndex is numbered from zero.

bool Study::CaseHasMeshAnyPart ( int caseIndex )

Returns True as a return value if any part has a mesh in the specified case of the study.

Parameters

caseIndex Case ID

Returns: Whether or not the specified case of the study has mesh in any of the parts

The caseIndex is numbered from zero.

bool Study::CaseHasResult ( int caseIndex )

Returns True as a return value if the specified case of the study has analysis results.

Parameters

caseIndex Case ID

Returns: Whether or not the specified case of the study has analysis results

The caseIndex is numbered from zero.

void Study::CheckFolderResults ( String & folder )

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

Parameters

folder Folder path

Model * Study::ConvertMeshToModel ( )

Creates a model from the mesh.

Returns: Model object

ResultCalculation * Study::CopyCalculation ( ResultCalculation * cal )

Returns a new ResultCalculation object by copying the specified ResultCalculation object.

Parameters

cal	ResultCalculation object

Returns: ResultCalculation object

CalculationDefinition * Study::CopyCalculationDefinition ( CalculationDefinition * copy )

Creates a new CalculationDefinition object by copying the specified CalculationDefinition object.

Parameters

copy	CalculationDefinition object

Returns: CalculationDefinition object

CalculationTarget * Study::CopyCalculationTarget ( CalculationTarget * copy )

Creates a new CalculationTarget object by copying the specified CalculationTarget object.

Parameters

copy	CalculationTarget object

Returns: CalculationTarget object

ContourDefinition * Study::CopyContour ( ContourDefinition * contour )

Creates a ContourDefinition object by copying the specified ContourDefinition object.

Parameters

contour ContourDefinition object

Returns: ContourDefinition object

FluxLineDefinition * Study::CopyFluxLine ( FluxLineDefinition * contour )

Creates a FluxLineDefinition object by copying the specified FluxLineDefinition object.

Parameters

contour FluxLineDefinition object

Returns: FluxLineDefinition object

ProbeDefinition * Study::CopyProbe ( ProbeDefinition * copy )

Copies a probe.

Parameters

copy	ProbeDefinition object

Returns: ProbeDefinition object

ScalingFactor * Study::CopyScaling ( ScalingFactor * scaling )

Creates a ScalingFactor object by copying the specified ScalingFactor object.

Parameters

scaling ScalingFactor object

Returns: ScalingFactor object

VectorDefinition * Study::CopyVector ( VectorDefinition * vector )

Creates a VectorDefinition object by copying the specified VectorDefinition object.

Parameters

scaling VectorDefinition object

Returns: VectorDefinition object

VibrationDefinition * Study::CopyVibrationDefinition ( VibrationDefinition * vibration )

Creates a new VibrationDefinition object by copying the specified VibrationDefinition object.

Parameters

copy	VibrationDefinition object

Returns: VibrationDefinition object

WindingDefinition * Study::CopyWinding ( WindingDefinition * defn )

Creates a new winding definition by copying an existing winding definition.

Parameters

name	Orginal WindingDefinition object

Returns: Created WindingDefinition object

WindingRegion * Study::CopyWindingRegion ( WindingRegion * copy )

Creates a new winding region by copying an existing winding region.

Parameters

copy	Orginal winding region object

Returns: Created WindingRegion object

Study * Study::Create2DStudy ( String & name )

Creates a 2D (or axisymmetric) Study object from the section analysis study by specifying a name.

Parameters

name	Study name

Returns: Study object

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

Creates an analysis template from the study.

Parameters

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

Study * Study::CreateAxisymmetricCutPlaneStudy	(	String &	study_name,
		String &	condition_name
	)

Creates a Study object of section analysis (axisymmetric) by specifying a study name or Section condition title.

Parameters

study_name	Study name
condition_name	Title of the Section condition

Returns: Study object

ResultCalculation * Study::CreateCalculation	(	String &	typeName,
		String &	name
	)

Creates a ResultCalculation object by specifying a name and condition type.

Parameters

typeName	Condition type name FFT : Fourier transformation calculation (amount of distribution) Filter : Frequency filter calculation Difference : Calculation of result difference
name	Name

Returns: ResultCalculation object

For more information about the condition type name that can be specified as the argument typeName, see Properties and Flags for Calculating Results .

CalculationDefinition * Study::CreateCalculationDefinition ( String & name )

Creates a CalculationDefinition object by specifying a name (calculation of a part).

Parameters

name Name

Returns: CalculationDefinition object

Circuit * Study::CreateCircuit ( )

Adds a new circuit.

Returns: Circuit object

CompositeResultDefinition * Study::CreateCompositeResult ( String & name )

Creates a CompositeResultDefinition object by specifying the name.

Parameters

name	Composite result name

Returns: CompositeResultDefinition object

For more information about the commands in the CompositeResultDefinition class, see CompositeResultDefinition .

Condition * Study::CreateCondition	(	String &	typeName,
		String &	name
	)

Creates a Condition object by specifying the condition type and name.

Parameters

typeName	Condition type name
name	Condition name

Returns: Condition object

For more information about the condition type name that can be specified as argument "typeName", see Properties and Flags for Condition Settings .

ContourDefinition * Study::CreateContour ( String & name )

Creates a ContourDefinition object by specifying the name.

Parameters

name	Contour plot name

Returns: ContourDefinition object

For more information about the commands in the ContourDefinition class, see ContourDefinition .

Study * Study::CreateCutPlaneStudy	(	String &	study_name,
		String &	condition_name
	)

Creates a Study object of section analysis (2D) by specifying a study name and a Section condition title.

Parameters

study_name	Study name
condition_name	Title of the Section condition

Returns: Study object

DifferenceEfficiencyMapDefinition * Study::CreateDifferenceEfficiencyMapDefinition ( String & name )

Creates an new DifferenceEfficiencyMapDefinition onject.

Parameters

name	Name of the new difference efficiency map

Returns: Created DifferenceEfficiencyMapDefinition object

void Study::CreateDriveCycleResponseParametricData ( DriveCycleResponseDataParameter * parameter )

Creates an drive cycle response value from parameter object.

Parameters

parameter DriveCycleResponseDataParameter object

CalculationDefinition * Study::CreateEdgeCalculationDefinition ( String & name )

Creates a CalculationDefinition object by specifying a name (calculation of an edge).

Parameters

name Name

Returns: CalculationDefinition object

CalculationTarget * Study::CreateEdgeCalculationTarget ( String & name )

Creates a CalculationTarget object by specifying a name (edge).

Parameters

name Name

Returns: CalculationTarget object

EfficiencyMapDefinition * Study::CreateEfficiencyMapDefinition ( String & name )

Creates an new EfficiencyMapDefinition onject.

Parameters

name	The name of the new efficiency map

Returns: The created EfficiencyMapDefinition object

void Study::CreateEfficiencyMapParametricData	(	Variant &	val,
		EfficiencyMapResponseDataParameter *	parameter
	)

Creates an efficiency map response value by specifying the efficiency map name or index.

Parameters

val	Efficiency map name or index
parameter	EfficiencyMapResponseDataParameter object

ExternalEfficiencyMapDefinition * Study::CreateExternalEfficiencyMapDefinition ( String & name )

Creates an new ExternalEfficiencyMapDefinition onject.

Parameters

name	Name of the new external efficiency map

Returns: Created ExternalEfficiencyMapDefinition object

FilterDefinition * Study::CreateFilterDefinition ( String & name )

Creates a FilterDefinition object by specifying the name.

Parameters

name	Filter object name

Returns: FilterDefinition object

For more information about the commands in the FilterDefinition class, see FilterDefinition .

FluxLineDefinition * Study::CreateFluxLine ( String & name )

Creates a FluxLineDefinition object by specifying the name.

Parameters

name	Flux line name

Returns: FluxLineDefinition object

For more information about the commands in the FluxLineDefinition class, see FluxLineDefinition .

Job * Study::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

Study * Study::CreateLossStudy ( String & name )

Creates a Study object of iron loss analysis by specifying a name.

Parameters

name	Study name

Returns: Study object

Part * Study::CreateMeshPart ( String & name )

Creates a new mesh part in the study.

Parameters

name	The name of the new part

Returns: part The created part

void Study::CreateParametricDataFromCalculation	(	Variant &	val,
		ResponseDataParameter *	parameter,
		int	index = `0`
	)

Creates a response data by specifying the calculation name or index.

Parameters

val	Calculation name or index
parameter	ResponseDataParameter object
index	Index of the data

void Study::CreateParametricDataFromProbe	(	Variant &	val,
		ResponseDataParameter *	parameter,
		int	index = `0`
	)

Creates a response data by specifying the probe name or index.

Parameters

val	Probe name or index
parameter	ResponseDataParameter object
index	Index of the data

void Study::CreateParametricDataFromSection	(	Variant &	val,
		ResponseDataParameter *	parameter,
		int	index = `0`
	)

Creates a response data by specifying the section graph name or index.

Parameters

val	Section graph name or index
parameter	ResponseDataParameter object
index	Index of the data

void Study::CreateParametricDataFromTable	(	String &	val,
		ResponseDataParameter *	parameter
	)

Creates a response data by specifying the table name.

Parameters

val	Table name
parameter	ResponseDataParameter object

void Study::CreateParametricDataFromVectorExpression	(	Variant &	val,
		ResponseDataParameter *	parameter
	)

Creates response data by specifying the vector exprssion name.

Parameters

val	Vector expression name
parameter	ResponseDataParameter object

void Study::CreateParametricDataFromVibration	(	Variant &	val,
		ResponseDataParameter *	parameter,
		int	index = `0`
	)

Creates a response data by specifying the vibration name or index.

Parameters

val	Vibration name or index
parameter	ResponseDataParameter object
index	Index of the data

DataSet * Study::CreateParametricGraph	(	String &	xaxis,
		int	xseries,
		String &	yaxis,
		bool	pareto = `false`
	)

Creates a response graph.

Parameters

xaxis	The X-axis of the response graph to be created. Specify the item to be the axis from the case index, response value, objective function, constraint condition, and expression.
xseries	Line index of the X-axis (starts from 0)
yaxis	The Y-axis of the response graph to be created. Specify the item to be the axis from the case index, response value, objective function, constraint condition, and expression.

Returns: DataSet object

For more information about the commands in the DataSet class, see DataSet .

ParametricGraphDefinition * Study::CreateParametricGraphDefinition ( )

Creates a response graph object.

Returns: ParametricGraphDefinition object

DataSet * Study::CreateParametricGraphWithName	(	String &	graphname,
		String &	xaxis,
		int	xseries,
		String &	yaxis,
		bool	pareto = `false`
	)

Creates a response graph by specifying a name.

Parameters

graphname	Graph name
xaxis	The X-axis of the response graph to be created. Specify the item to be the axis from the case index, response value, objective function, constraint condition, and expression.
xseries	Line index of the X-axis (starts from 0)
yaxis	The Y-axis of the response graph to be created. Specify the item to be the axis from the case index, response value, objective function, constraint condition, and expression.

Returns: DataSet object

For more information about the commands in the DataSet class, see DataSet .

Condition * Study::CreatePostCondition	(	String &	typeName,
		String &	name
	)

Specifies the magnetic flux calculation to magnetic field analysis study.

Parameters

typeName	Condition type name (Flux)
name	Condition name

Returns: Condition object

For more information about condition type names that can be specified as the argument "typeName", see scriptFluxTableFlux.

ProbeDefinition * Study::CreateProbe ( String & name )

Creates a probe by specifying a name.

Parameters

name	Probe name

Returns: ProbeDefinition object

ResponseTableDefinition * Study::CreateResponseTableDefinition ( String & name )

Creates a ResponseTableDefinition definition for an accuracy priority efficiency map study.

Parameters

name	The name of the response table definition

Returns: The created ResponseTableDefinition object

ResponseTableResultType * Study::CreateResponseTableResultType ( String & name )

Creates a new response table result type definition (accuracy priority efficiency map study)

Parameters

name	The name of the new definition

Returns: The created ResponseTableResultType object

ScalingFactor * Study::CreateScaling ( String & name )

Creates a ScalingFactor object by specifying the name.

Parameters

name	Scaling name

Returns: ScalingFactor object

For more information about the commands in the ScalingFactor class, see ScalingFactor .

void Study::CreateScriptParametricData	(	String &	title,
		String &	variable,
		String &	script
	)

Creates script response values.

Parameters

title	Response value name
variable	Response value variable name
script	Script

SectionGraph * Study::CreateSectionGraph	(	String &	name,
		Variant &	index = `-1`
	)

Creates a SectionGraph object by specifying a name.

Parameters

name	Section graph name
index	Name or index of the calculation item

Returns: SectionGraph object

CalculationDefinition * Study::CreateSurfaceCalculationDefinition ( String & name )

Creates a CalculationDefinition object by specifying a name (calculation of a face).

Parameters

name Name

Returns: CalculationDefinition object

CalculationTarget * Study::CreateSurfaceCalculationTarget ( String & name )

Creates a CalculationTarget object by specifying a name (face).

Parameters

name Name

Returns: CalculationTarget object

ResponseTableCorrection * Study::CreateTableCorrection ( String & name )

Creates a new response table correction object for speed priority efficiency maps.

Parameters

name	The name of the new object

Returns: ResponseTableCorrection object

TableDefinition * Study::CreateTableDefinition ( )

Creates a TableDefinition object.

Returns: TableDefinition object

ThermalEfficiencyMapDefinition * Study::CreateThermalEfficiencyMapDefinition ( String & name )

Creates an new ThermalEfficiencyMapDefinition object for a thermal analysis.

Parameters

name	The name of the new efficiency map

Returns: The created ThermalEfficiencyMapDefinition object

ThermalModelRegion * Study::CreateThermalModelDefinition ( String & name )

Creates a new thermal model definition.

Parameters

name	Name of the new thermal model definition

Returns: The created ThermalModelDefinition object

ThermalModelRegion * Study::CreateThermalModelRegion ( String & name )

Creates a new thermal model region definition.

Parameters

name	Name of the new thermal model region

Returns: The created ThermalModelRegion object

VectorDefinition * Study::CreateVector ( String & name )

Creates a VectorDefinition object by specifying the name.

Parameters

name	Vector plot name

Returns: VectorDefinition object

For more information about the commands in the VectorDefinition class, see VectorDefinition .

VectorExpression * Study::CreateVectorExpression ( String & name )

Creates a VectorExpression object by specifying the name.

Parameters

name	Vector expression object name

Returns: VectorExpression object

For more information about the commands in the VectorExpression class, see VectorExpression .

VibrationDefinition * Study::CreateVibrationDefinition ( String & name )

Creates a VibrationDefinition object by specifying a name.

Parameters

name Name

Returns: VibrationDefinition object

WindingDefinition * Study::CreateWinding	(	String &	type,
		String &	name
	)

Creates a winding definition.

Parameters

name	Name of the winding definition

Returns: Created WindingDefinition object

WindingRegion * Study::CreateWindingRegion	(	String &	name,
		Variant &	type = `0`
	)

Creates a new winding region definition.

Parameters

name	Name of the new winding region
type	0 : Winding region (Geometry) 1 : Winding region (Coil template)

Returns: The created WindingRegion object

int Study::CurrentIndexPostCalculationScripts ( )

Returns the index of the active post-calculation script list.

Returns: Returns the script index

void Study::DeleteCadParameter ( String & name )

Removes a CAD parameter of a model from the target.

Parameters

name	Name of the CAD parameter

void Study::DeleteCalculation ( Variant & val )

Deletes a calculation item by specifying a name or index.

Parameters

val	Name or index of the calculation item

void Study::DeleteCalculationDefinition ( Variant & val )

Deletes a CalculationDefinition object by specifying name or index.

Parameters

val	Name or index

void Study::DeleteCalculationTarget ( Variant & val )

Deletes a CalculationTarget object by specifying name or index.

Parameters

val	Name or index

void Study::DeleteCompositeResult ( Variant & val )

Deletes composite result by specifying a name or index.

Parameters

val	Composite result name or index

void Study::DeleteCondition ( Variant & val )

Deletes a condition by specifying the name or index.

Parameters

val	Condition name or index

void Study::DeleteContour ( Variant & val )

Deletes a contour plot by specifying a name or index.

Parameters

val	Contour plot name or index

void Study::DeleteDifferenceEfficiencyMapDefinition ( Variant & val )

Deletes an DifferenceEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the difference efficiency map definition

void Study::DeleteEfficiencyMapDefinition ( Variant & val )

Deletes an EfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the efficiency map definition

void Study::DeleteExternalEfficiencyMapDefinition ( Variant & val )

Deletes an ExternalEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the external efficiency map definition

void Study::DeleteFilterResultDefinition ( Variant & val )

Deletes a filter object by specifying a name or index.

Parameters

val	Filter object name or index

void Study::DeleteFluxLine ( Variant & val )

Deletes a flux line plot by specifying a name or index.

Parameters

val	Flux line name or index

void Study::DeleteMeshPart ( Variant & var )

Removes a mesh part from the study.

Parameters

var	Part name or ID

void Study::DeleteParametricData ( Variant & val )

Deletes a response data by specifying the name or index.

Parameters

val	Response data name or index

void Study::DeletePostCalculationScript ( Variant & nameOrIndex )

Deletes a post-calculation script from the study by specifying the name or index.

Parameters

nameOrIndex name or index of the script

void Study::DeletePostCondition ( Variant & val )

Deletes the post condition by specifying the name or index.

Parameters

val	Name or index of the post condition

void Study::DeleteProbe ( Variant & val )

Deletes a probe by specifying a name or index.

Parameters

val	Probe name or index

void Study::DeleteResponseTable ( CircuitComponent * component )

Deletes the response value table created from the RT component.

Parameters

component CircuitComponent object

void Study::DeleteResponseTableDefinition ( Variant & val )

Deletes a response table definition object by specifying the name or index.

Parameters

val	name or index of the table

void Study::DeleteResponseTableResultType ( Variant & val )

Deletes a response table result type definition by specifying the name or index (accuracy priority efficiency map study)

Parameters

val	name or index of the table result type definition

void Study::DeleteResultCase ( int caseno )

Deletes the result of the specified case. This command also deletes result files.

Parameters

caseno Case ID

void Study::DeleteResultCaseFromStudy ( int caseno )

Removes the result of the specified case from the study.

The result file itself is not deleted with this command but the study and result file become unlinked.
Run the command CheckForNewResults for the Study class when linking the result file and study again.

Parameters

caseno Case ID

void Study::DeleteResultCurrentCaseFromStudy ( )

Removes the result of a current case from a study.

The result file itself is not deleted with this command but the study and result file become unlinked.
Run the command Study::CheckForNewResults for the Study class when linking the result file and study again.

void Study::DeleteResultFromStudy ( )

Removes results of all cases from a study.

The result file itself is not deleted with this command but the study and result file become unlinked.
For more information about the operation in the graphics window, see CheckForNewResults .

void Study::DeleteScaling ( Variant & val )

Deletes scaling by specifying a name or index.

Parameters

val	Scaling name or index

void Study::DeleteSectionGraph ( Variant & val )

Deletes a section graph by specifying a name or index.

Parameters

val	Section graph name or index

void Study::DeleteTableCorrection ( Variant & val )

Deletes a ResponseTableCorrection by specifying the name or index.

Parameters

val	The name or index of the correction

void Study::DeleteThermalEfficiencyMapDefinition ( Variant & val )

Deletes an ThermalEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the efficiency map definition

void Study::DeleteVector ( Variant & val )

Deletes a vector plot by specifying a name or index.

Parameters

val	Vector plot name or index

void Study::DeleteVectorExpression ( Variant & val )

Deletes a vector expression object by specifying a name or index.

Parameters

val	Vector expression object name or index

void Study::DeleteVibrationDefinition ( Variant & val )

Deletes a VibrationDefinition object by specifying name or index.

Parameters

val	Name or index

void Study::DeleteWinding ( Variant & val )

Deletes an winding definition by specifying the name or index.

Parameters

val	Name or index of the Winding Definition object

void Study::DeleteWindingRegion ( Variant & val )

Deletes an winding region definition by specifying the name or index.

Parameters

val	Name or index of the winding region definition

SectionGraph * Study::DuplicateSectionGraph ( Variant & val )

Returns a duplicated SectionGraph by specifying a name or index.

Parameters

val	Section graph name or index

Returns: SectionGraph object

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

Exports Analysis Parameter items to designated file.

Parameters

filename	Export file name
exportCADParameter	Whether to output CAD parameters

void Study::ExportCaseValueData ( String & filename )

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

Parameters

filename File path of destination

bool Study::ExportMinMaxTable	(	TableDefinition *	def,
		String &	filename
	)

Exports a file (*.htm, *.txt, *.csv) to the min/max table.

Parameters

def	TableDefinition object
filename	File path of the destination

The files of the following format can be exported.

HTML format (*.html)
Tab format (*.txt)
CSV format (*.csv)

bool Study::ExportPositionTable	(	TableDefinition *	def,
		String &	filename
	)

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

Parameters

def	TableDefinition object
filename	File path of the destination

The files of the following format can be exported.

HTML format (*.html)
Tab format (*.txt)
CSV format (*.csv)

void Study::ExportResponseTable	(	String &	filename,
		Variant &	nameOrIndex,
		int	caseIndex,
		double	temp = `0.0`
	)

Exports response table of efficiency map to file.

Parameters

filename	Export file name
nameOrIndex	The Response table name or index
caseIndex	Case index
temp	Response Table Temperature

The caseIndex is numbered from 0.

bool Study::ExportResultValuesTable	(	TableDefinition *	def,
		String &	filename
	)

Exports a file (*.htm, *.txt, *.csv) to the result values table.

Parameters

def	TableDefinition object
filename	File path of the destination

The files of the following format can be exported.

HTML format (*.html)
Tab format (*.txt)
CSV format (*.csv)

void Study::ExportRttFile ( RttFileParameter * parameter )

Exports an rtt file using the parameters set in RttFileParameter object.

Parameters

parameter RttFileParameter object

void Study::ExportSubroutineParameter ( String & filename )

Exports user subroutine parameters to a file (*.csv, *.txt).

Parameters

filename File path for exporting

bool Study::ExportTable	(	TableDefinition *	def,
		String &	filename,
		Variant &	filetype
	)

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

Parameters

def	TableDefinition object
filename	File path of the destination
filetype	0 or designer : Outputs a table in Designer format 1 or studio : Outputs a table in Studio format

The files of the following format can be exported.

HTML format (*.html)
Tab format (*.txt)
CSV format (*.csv)
However, Only Tab format output from Studio can be exported.

Returns
Whether or not a file is exported

void Study::ExportTags ( String & filename )

Exports user defined tags to a file (*.csv, *.txt).

Parameters

filename File path for importing

bool Study::ExportTranslationFile ( String & filename )

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

Deprecated:

ResultViewItemList * Study::GetAllCasesResultViewItemList ( )

Returns result view list for all cases.

Returns: ResultViewItemList object

ResultCalculation * Study::GetCalculation ( Variant & val )

Returns the ResultCalculation object by specifying a name or index.

Parameters

val	Name or index of the calculation item

Returns: ResultCalculation object

CalculationDefinition * Study::GetCalculationDefinition ( Variant & val )

Returns a CalculationDefinition object by specifying a name or index.

Parameters

val	Name or index

Returns: CalculationDefinition object

CalculationTarget * Study::GetCalculationTarget ( Variant & val )

Returns a CalculationTarget object by specifying a name or index.

Parameters

val	Name or index

Returns: CalculationTarget object

bool Study::GetCheckForTopologyChanges ( )

Returns whether or not to check the increase or decrease in the number of parts, faces, edges, and vertices.

Returns: Whether or not to check

Circuit * Study::GetCircuit ( )

Returns a Circuit object.

Returns: Circuit object

CompositeResultDefinition * Study::GetCompositeResult ( Variant & val )

Returns a CompositeResultDefinition object by specifying a name or index.

Parameters

val	Composite result name or index

Returns: CompositeResultDefinition object

Condition * Study::GetCondition ( Variant & val )

Returns a Condition object by specifying the name or index.

Parameters

val	Condition name or index

Returns: Condition object

Variant Study::GetConditionTypes ( )

Returns the list of usable condition types.

Returns: Names of usable condition types

For more information about names of condition types, see Properties and Flags for Condition Settings.

ContourDefinition * Study::GetContour ( Variant & val )

Returns a ContourDefinition object by specifying a name or index.

Parameters

val	Contour plot name or index

Returns: ContourDefinition object

bool Study::GetCopyOnUpdate ( )

Returns whether or not to copy a study on model update.

Returns: Whether or not to copy a study during model update

ResponseCreateAdditionalPointsInfo * Study::GetCreateResponseAdditionalPointsInfo ( )

Returns a ResponseCreateAdditionalPointsInfo object to specify additional calculation points for efficiency map speed priority.

Returns: ResponseCreateAdditionalPointsInfo object

ResponseCreateInfo * Study::GetCreateResponseInfo ( )

Returns a ResponseCreateInfo object to specify the efficiency map response table settings.

Returns: ResponseCreateInfo object

int Study::GetCurrentCase ( )

Returns the current active case ID.

Returns: Case ID

The returned Case ID is numbered from zero.

DataSet * Study::GetDataSet	(	String &	name,
		int	caseno
	)

Returns a DataSet object by specifying a name.

Parameters

name	Data set name
caseno	Case ID

Returns: DataSet object

String Study::GetDescription ( )

Returns the description.

Returns: Description

DesignTable * Study::GetDesignTable ( )

Returns interface for parametric settings.

Returns: DesignTable object

For more information about DesignTable class, see DesignTable and ParametricEquation .

DifferenceEfficiencyMapDefinition * Study::GetDifferenceEfficiencyMapDefinition ( Variant & val )

Returns an DifferenceEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the difference efficiency map definition

Returns: DifferenceEfficiencyMapDefinition object

EfficiencyMapPlot * Study::GetDifferenceEfficiencyMapPlot ( Variant & val )

Returns an EfficiencyMapPlot object by specifying the name or index.

Parameters

val	Name or index of the difference efficiency map

Returns: EfficiencyMapPlot object

EfficiencyMapDefinition * Study::GetEfficiencyMapDefinition ( Variant & val )

Returns an EfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	name or index of the efficiency map definition

Returns: The EfficiencyMapDefinition object

EfficiencyMapPlot * Study::GetEfficiencyMapPlot ( Variant & val )

Returns an EfficiencyMapPlot object by specifying the name or index.

Parameters

val	Name or index of the efficiency map

Returns: EfficiencyMapPlot object

ExternalEfficiencyMapDefinition * Study::GetExternalEfficiencyMapDefinition ( Variant & val )

Returns an ExternalEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	Name or index of the external efficiency map definition

Returns: ExternalEfficiencyMapDefinition object

EfficiencyMapPlot * Study::GetExternalEfficiencyMapPlot ( Variant & val )

Returns an EfficiencyMapPlot object by specifying the name or index.

Parameters

val	Name or index of the external data efficiency map

Returns: EfficiencyMapPlot object

bool Study::GetFacesHeight	(	String array &	facesList,
		Point *	vector
	)

Returns the height of the face in the specified direction.

Returns: Height of faces in specified direction

bool Study::GetFacesMaximumDistanceFromAxis	(	String array &	facesList,
		Point *	origin,
		Point *	vector
	)

Returns the maximum distance between the specified face and axis.

Returns: Furthest distance between specified axis and faces

FilterDefinition * Study::GetFilterResultDefinition ( Variant & val )

Returns a FilterDefinition object by specifying a name or index.

Parameters

val	Filter object name or index

Returns: FilterDefinition object

FluxLineDefinition * Study::GetFluxLine ( Variant & val )

Returns a FluxLineDefinition object by specifying a name or index.

Parameters

val	Flux line name or index

Returns: FluxLineDefinition object

String Study::GetHiddenResults ( )

Returns the table result items to hide.

Returns: list Result Type Name

Study * Study::GetMasterStudy ( )

Returns a Master Study object.

Returns: Study object

Material * Study::GetMaterial ( Variant & val )

Returns the material specified for a part with the name or ID.

Parameters

val	Part name or ID

Returns: Material object

String Study::GetMaterialAttributeParameters ( )

Returns a list of material properties.

Returns: list Names of material property items

Material * Study::GetMaterialByIndex ( int index )

Returns the material by specifying the index.

Parameters

index Material index

Returns: Material object

MeasurementVariable * Study::GetMeasurementVariable ( Variant & val )

Returns a measurement variable by specifying name or index.

Parameters

val	variable name or index

Returns: MeasurementVariable object

MeshControl * Study::GetMeshControl ( )

Returns a MeshControl object to specify mesh properties.

Returns: MeshControl object

MeshGroupList * Study::GetMeshGroupList ( )

Returns mesh group list.

Returns: MeshGroupList object

For more information about MeshGroupList, see MeshGroup and MeshGroupList .

Part * Study::GetMeshPart ( Variant & var )

Returns a mesh part object from the study.

Parameters

var	Part name or ID

Returns: part The mesh part

Part * Study::GetMeshPartByIndex ( int index )

Returns a mesh part object from the study by index.

Parameters

index The index of the part

Returns: part The mesh part

MeshToModelParameter * Study::GetMeshToModelParameter ( )

Returns an MeshToModelParameter object.

Returns: MeshToModelParameter object

Condition * Study::GetModelCopyControl ( )

Returns the object of the model copy that is created when the study has results. The model copy is created as a Condition object.

Returns: Condition object

String Study::GetName ( )

Returns the name of a study as a string.

Returns: Study name

Variant Study::GetNodeIdsOnEdge ( int edgeId )

Returns a list of IDs of nodes on the specified edge.

Parameters

edgeId edge ID

Returns: List of node IDs

Variant Study::GetNodeIdsOnFace ( int faceId )

Returns a list of IDs of nodes on the specified face.

Parameters

faceId Face ID

Returns: List of node IDs

OptimizationTable * Study::GetOptimizationTable ( )

Returns the optimization table object.

Returns: Optimization table object

ParameterSettingStatus * Study::GetParameterSettingStatus ( )

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

Returns: ParameterSettingStatus object

ScriptObject * Study::GetPostCalculationScript ( Variant & nameOrIndex )

Returns the specified post-calculation script object from the study.

Parameters

nameOrIndex name or index of the script

Returns: Returns the post calculation script object

Variant Study::GetPostCalculationScriptParameter	(	Variant &	nameOrIndex,
		String &	key
	)

Returns a post-calculation script parameter from the study by specifying the name or index.

Parameters

nameOrIndex	name or index of the script
key	parameter key

Returns: parameter

Condition * Study::GetPostCondition ( Variant & val )

Returns a magnetic flux calculation by specifying the name or index.

Parameters

val	Name or index of the magnetic flux calculation

double Study::GetPostValue ( String & name )

Returns result value of a scalar type.

Parameters

name	Post parameter name

Returns: Result value of scalar type

A value cannot be obtained when this command is used and a result does not exist in a study.
The post parameter name is "Result item name (component name) : condition name / part name / circuit component name (component name).
For example, the post parameter name "Lorentz force (X): Coil (X)" is specified when obtaining the value (part name "Coil" for Lorentz force (X component)) for the following figure.

ProbeDefinition * Study::GetProbe ( Variant & val )

Returns a probe by specifying a name or index.

Parameters

val	Probe name or index

Returns: ProbeDefinition object

Report * Study::GetReport ( )

Returns a Report object.

Returns: Report object

Variant Study::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.

ResponseTableDefinition * Study::GetResponseTableDefinition ( Variant & val )

Returns a response table definition object by specifying the name or index. (accuracy priority efficiency map study)

Parameters

val	name or index of the table

Returns: ResponseTableDefinition object

ResponseTableResultType * Study::GetResponseTableResultType ( Variant & val )

Returns a response table result type definition by specifying the name or index (accuracy priority efficiency map study)

Parameters

val	name or index of the table result type definition

Returns: The ResponseTableResultType object

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

Returns a value of a response value variable.

Parameters

name	Name of the response variable
caseIndex	Case ID

Returns: Variable value

The caseIndex is numbered from 0.

String Study::GetResultFileName ( )

Returns the result file name (*.jplot, *.plot).

Attention: If the output contains multiple result files, the main output file name for the studies or cases are output.
For example, when using multi slice conditions for a magnetic study, the output contains not only a main result file "Designer.jplot", but also the sub result files such as "Designer_slice_1.jplot" and "Designer_slice_2.jplot."

Returns: Path to the result file

StringList Study::GetResultFileNameList ( )

Returns a list of result files in a study as a character string.

Returns: List of result file names

Variant Study::GetResultFileNames ( )

Returns the list of result files in a study.

Returns: List of result file names

ResultTable * Study::GetResultTable ( )

Returns a ResultTable object.

Returns: ResultTable object

ResultViewItemList * Study::GetResultViewItemList ( )

Returns result view list.

Returns: ResultViewItemList object

ScalingFactor * Study::GetScaling ( Variant & val )

Returns a ScalingFactor object by specifying a name or index.

Parameters

val	Scaling name or index

Returns: ScalingFactor object

String Study::GetScriptTypeName ( )

Returns the study type as a character string.

Returns: Study type name

For more information about the returned study type name, see Study Type.

SectionGraph * Study::GetSectionGraph ( Variant & val )

Returns a SectionGraph object by specifying a name or index.

Parameters

val	Section graph name or index

Returns: SectionGraph object

Study * Study::GetSlaveStudy ( Variant & val )

Returns a slave study object by specifying the name or index.

Parameters

val	Slave Study name or index

Returns: Study object

Step * Study::GetStep ( )

Returns a Step object to specify the step control and frequency control of study properties.

Returns: Step object

int Study::GetStudyId ( )

Returns a unique study ID within the project.

Returns: Study ID

StudyProperties * Study::GetStudyProperties ( )

Returns a StudyProperties object.

Returns: StudyProperties object

ResponseTableCorrection * Study::GetTableCorrection ( Variant & val )

Returns a ResponseTableCorrection object by specifying the name or index.

Parameters

val	The name or index of the correction

Returns: The ResponseTableCorrection object

String Study::GetTagName ( int index )

Provides the tag name at the given index.

Parameters

index Index of the tag

String Study::GetTagValue ( Variant & indexOrName )

Provides tag value at the given index.

Parameters

index Index of the tag

ThermalEfficiencyMapDefinition * Study::GetThermalEfficiencyMapDefinition ( Variant & val )

Returns an ThermalEfficiencyMapDefinition onject by specifying the name or index.

Parameters

val	name or index of the efficiency map definition

Returns: The ThermalEfficiencyMapDefinition object

ThermalModelDefinition * Study::GetThermalModelDefinition ( )

Returns a thermal model definition.

Returns: ThermalModelDefinition object

ThermalModelRegion * Study::GetThermalModelRegion ( )

Returns a thermal model region definition.

Returns: ThermalModelRegion object

String Study::GetType ( )

Returns the analysis type of the study as a character string.

Returns: Analysis type of the study

bool Study::GetUpdateCaseValuesWithGeometryAdjustedValues ( )

Returns whether to update the case value with the adjusted value.

Returns: Whether to update

ParametricEquation * Study::GetVariable ( Variant & name )

Returns an equation by specifying a variable.

Parameters

name Variable

Returns: Equation

VectorDefinition * Study::GetVector ( Variant & val )

Returns a VectorDefinition object by specifying a name or index.

Parameters

val	Vector plot name or index

Returns: VectorDefinition object

VectorExpression * Study::GetVectorExpression ( Variant & val )

Returns a VectorExpression object by specifying a name or index.

Parameters

val	Vector expression object name or index

Returns: VectorExpression object

Variant Study::GetVectorPostValue ( String & name )

Returns result value of vector type.

Parameters

name	Post parameter name

Returns: Result value of vector type

A value cannot be obtained when this command is used and a result does not exist in a study.
For more information about post parameter names, see GetPostValue
.

VibrationDefinition * Study::GetVibrationDefinition ( Variant & val )

Returns a VibrationDefinition object by specifying a name or index.

Parameters

val	Name or index

Returns: VibrationDefinition object

WindingDefinition * Study::GetWinding ( Variant & val )

Returns an winding definition by specifying the name or index.

Parameters

val	Name or index of the Winding Definition object

Returns: WindingDefinition object

WindingRegion * Study::GetWindingRegion ( Variant & val )

Returns an winding region definition by specifying the name or index.

Parameters

val	Name or index of the winding region definition

Returns: WindingRegion object

bool Study::HasCircuit ( )

Returns True as a return value if a circuit exists in the study.

Returns: Whether or not a circuit exists in a study

bool Study::HasIntersection ( )

Checks interference among parts in a current case.

Returns: If interference among parts is found, True is returned.

Intersection check can be set for solids and regions. This function cannot be specified for mesh.
Use the GetLastMessage() when obtaining detailed information.
Describe the loop of all cases in script commands by using Run() or SubmitRemote() instead of RunAllCases() or SubmitAllRemote() when using interference check for all cases included in a study.
The following are examples of commands.

Set app=designer

Set geomApp = app.CreateGeometryEditor()

Set currentStudy = app.GetCurrentStudy()

numCases = currentStudy.GetDesignTable().NumCases()

For caseIndex= 0 To numCases-1 Step 1

currentStudy.SetCurrentCase(caseIndex)

hasIntersect = currentStudy.HasIntersection()

If hasIntersect = FALSE Then

currentStudy.Run()

Else

MsgBox("Interference has been found.")

End If

Next

bool Study::HasMasterStudy ( )

Returns True as a return value if a master study exists in the study.

Returns: Whether or not a master study exists in a study

bool Study::HasMesh ( )

Returns True as a return value if mesh is generated in the current case of the study.

Returns: Whether or not the current case of the study has mesh

bool Study::HasMeshAnyPart ( )

Returns True as a return value if any part has a mesh in the current case of the study.

Returns: Whether or not the current case of the study has mesh in any of the parts

bool Study::HasParametricData ( String & name )

Returns True as a return value if there is a response value with the name specified in the study.

Parameters

name	Name of the response value

Returns: Whether or not there is a response value to the study

bool Study::HasResult ( )

Returns True as a return value if the current case of the study has analysis results.

Returns: Whether or not the current case of the study has analysis results

bool Study::HasUseWinding ( )

Returns True if the study uses windings.

Returns: Whether or not the winding is used.

void Study::ImportSubroutineParameter ( String & filename )

Imports user subroutine parameters from a file (*.csv, *.txt).

Parameters

filename File path for importing

void Study::ImportTags ( String & filename )

Imports user defined tags from a file (*.csv, *.txt).

Parameters

filename File path for importing

bool Study::ImportTranslationFile ( String & filename )

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

Deprecated:

bool Study::IsAxisymmetricStudy ( )

Returns True as a return value if the study is an axisymmetric analysis.

Returns: Whether or not the study is an axisymmetric analysis

bool Study::IsCutPlaneStudy ( )

Returns True as a return value if the study is a cross section analysis.

Returns: Whether or not the study is a cross section analysis

bool Study::IsModelError ( int caseno = -1 )

Returns True as a return value if there is a model error.

Parameters

caseno Case ID

Returns: Whether or not there is a model error

bool Study::IsModelWarning ( int caseno = -1 )

Returns True as a return value if there is a model warning.

Parameters

caseno Case ID

Returns: Whether or not there is a model warning

bool Study::IsPartSuppressed ( Variant & part )

Returns suppressed state of a part.

Parameters

part Part

Returns: Whether or not parts are in a suppressed state

bool Study::IsValid ( )

Returns True if an object is valid.

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

Circuit * Study::LoadCircuit ( String & filename )

Adds a circuit by importing the specified file.

Parameters

filename Circuit file name (including path)

Returns: Circuit object

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

Adds a case to the study by specifying a weight file.

Parameters

csvFile	Weight file
cases	case indices to load
isDuplicate	lags for duplicating the study

bool Study::LoadMesh ( )

Loads created mesh in current case.

Returns: Whether or not a mesh file is loaded

void Study::LoadRemoteResults ( String array & cases )

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

Parameters

cases Cases to load

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

Loads the analysis results of topology optimization.

Parameters

typeName	Load type
numCases	Number of cases

String Study::MagnetizedMaterialName ( )

Returns the name of the user magnetization material created from an analysis in a study running a magnetization analysis.

Returns: Name of the user magnetization material

double Study::MeasureDistance	(	String &	fromType,
		Variant &	fromID,
		String &	toType,
		Variant &	toID
	)

Measures the distance between specified entities.

Parameters

fromType	Edge : Edge Vertex : Vertex Face : Face Node : Node Element-edge : Element edge Element-face : Element face
fromID	Vertex ID, face ID, edge ID, node ID, element face ID, or element edge ID
toType	Edge : Edge Vertex : Vertex Face : Face Node : Node Element-edge : Element edge Element-face : Element face
toID	Vertex ID, face ID, edge ID, node ID, element face ID, or element edge ID

Returns: Distance

double Study::MeasureDistanceFrom	(	double	x,
		double	y,
		double	z,
		String &	toType,
		Variant &	toID
	)

Measures the distance between the specified coordinates (x, y, z) and specified entity.

Parameters

x	X-Coordinate
y	Y-Coordinate
z	Z-Coordinate
toType	Edge : Edge Vertex : Vertex Face : Face Node : Node Element-edge : Element edge Element-face : Element face
toID	Vertex ID, face ID, edge ID, node ID, element face ID, or element edge ID

Returns: Distance

double Study::MeasureDistanceFromPoint	(	Point *	p,
		String &	toType,
		Variant &	toID
	)

Measures the distance between the specified Point object and entity.

Parameters

p	Point object
toType	Edge : Edge Vertex : Vertex Face : Face Node : Node Element-edge : Element edge Element-face : Element face
toID	Vertex ID, face ID, edge ID, node ID, element face ID, or element edge ID

Returns: Distance

double Study::MeasureNodeAngle	(	Variant &	fromID,
		Variant &	centerID,
		Variant &	toID
	)

Measures the angle of three specified points.

Parameters

fromID	Node ID
centerID	Node ID
toID	Node ID

Returns: Angle

double Study::MeasurePointNodeAngle	(	double	x,
		double	y,
		double	z,
		Variant &	fromID,
		Variant &	toID
	)

Measures the angle of the specified center point and two points.

Parameters

x	X-Coordinate of the center point
y	Y-Coordinate of the center point
z	Z-Coordinate of the center point
fromID	Node ID
toID	Node ID

Returns: Angle

double Study::MeasurePointVertexAngle	(	double	x,
		double	y,
		double	z,
		Variant &	fromID,
		Variant &	toID
	)

Measures the angle of the specified center point and two points.

Parameters

x	X-Coordinate of the center point
y	Y-Coordinate of the center point
z	Z-Coordinate of the center point
fromID	Vertex ID
toID	Vertex ID

Returns: Angle

double Study::MeasureVertexAngle	(	Variant &	fromID,
		Variant &	centerID,
		Variant &	toID
	)

Measures the angle of the three specified points.

Parameters

fromID	Vertex ID
centerID	Vertex ID
toID	Vertex ID

Returns: Angle

void Study::MergeJcf ( String & filename )

Specifies the jcf file path and merges model data of the jcf file into the current study.

Parameters

filename File path

void Study::MergeJcfForPreview ( String & filename )

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

Deprecated:

int Study::NumAirRegions ( )

Returns the number of air regions as an integer.

This air region corresponds to the air region displayed under [Study] > [Mesh] in the [Project Manager] of the graphics window.

Returns: Number of the air regions

int Study::NumCalculationDefinitions ( )

Returns the number of calculation items (parts, faces, edges) defined in a study as an integer.

Returns: Number of calculation items

int Study::NumCalculations ( )

Returns number of calculation items as an integer.

Returns: Number of calculation items

int Study::NumCalculationTargets ( )

Returns the number of calculation targets defined in a study as an integer.

Returns: Number of calculation targets

int Study::NumConditions ( )

Returns the number of conditions in the study as an integer.

Returns: Number of conditions in a study

int Study::NumContours ( )

Returns the number of contour plots as an integer.

Returns: Number of contour plots

int Study::NumDifferenceEfficiencyMapDefinitions ( )

Returns the number of difference efficiency map definitions.

Returns: Number of difference efficiency map definitions

int Study::NumEfficiencyMapDefinitions ( )

Returns the number of efficiency map definitions.

Returns: The number of efficiency map definitions.

int Study::NumExternalEfficiencyMapDefinitions ( )

Returns the number of external efficiency map definitions.

Returns: Number of external efficiency map definitions

int Study::NumFluxLines ( )

Returns the number of flux line plots as an integer.

Returns: Number of flux line plots

int Study::NumMaterials ( )

Returns the number of materials.

Returns: Number of materials

int Study::NumPostConditions ( )

Returns the number of the magnetic flux calculation in a magnetic field analysis study as an integer.

Returns: Number of magnetic flux calculations in a study

int Study::NumPostParameters ( )

Returns the number of post parameters as an integer.

Returns: Number of post parameters

Physical quantities outputted in table form such as magnetic flux calculation, part calculation, section graph, probe, response value, etc. are counted as post parameters.
The physical quantity output for each part is counted by the number of parts.
This command can be used regardless of whether or not there is a calculation result for studies that have run a calculation.

int Study::NumProbes ( )

Returns the number of probes.

Returns: Number of probes

int Study::NumResponseTableDefinitions ( )

Returns the number of response table definitions (accuracy priority efficiency map study).

Returns: Number of response tables

int Study::NumResponseTableResultTypes ( )

Returns the number of response table result type definitions (accuracy priority efficiency map study)

Returns: Number of response tables

int Study::NumScalings ( )

Returns the number of scalings as an integer.

Returns: Number of scaling

int Study::NumSectionGraphs ( )

Returns the number of section graphs as an integer.

Returns: Number of section graphs

int Study::NumSlaveStudies ( )

Returns the number of slave studies in the study as an integer.

Returns: Number of slave studies in a study

int Study::NumTableCorrections ( )

Returns the number of response table correction definitions.

Returns: Number of corrections

int Study::NumThermalEfficiencyMapDefinitions ( )

Returnsthe number of efficiency map definitions for a thermal analysis.

Returns: The number of efficiency map definitions.

int Study::NumVectors ( )

Returns the number of vector plots as an integer.

Returns: Number of vector plots

int Study::NumVibrationDefinitions ( )

Returns the number of vibration items defined in a study as an integer.

Returns: Number of vibration items

int Study::NumWindingRegions ( )

Returns the number of winding region definitions.

Returns: The number of winding regions

int Study::NumWindings ( )

Returns the number of winding definitions.

Returns: Number of winding definitions

Variant Study::ParametricDataNames ( )

Returns the name list of parameters.

Returns: List of parameters

String Study::PostParameterName ( int index )

Returns a post parameter name by specifying an index.

Parameters

index Index of post parameter

Returns: Post parameter name

This command can be used regardless of whether or not there is a calculation result for studies that have run a calculation.
For more information about post parameter names, see GetPostValue .

int Study::PostParameterType ( String & name )

Returns post parameter type by specifying a name.

Parameters

name	Post parameter name

Returns: Post parameter type

1 : Scalar

2 : Vector

This command can be used regardless of whether or not there is a calculation result for studies that have run a calculation.
For more information about post parameter names, see GetPostValue .

bool Study::RemoveAllResults ( )

Deletes the all results from the result file of the current case. Mesh is also removed.

True is returned as a return value when it is deleted.

Returns: Whether or not it is deleted

bool Study::RemoveAllResultsAllCases ( )

Deletes the all results from the result file of the all cases. Mesh is also removed.

True is returned as a return value when it is deleted.

Returns: Whether or not it is deleted

void Study::RemoveMaterialByName ( String & matname )

Deletes a material by specifying a name.

Parameters

matname Material name

void Study::RemoveMeasurementVariable ( Variant & val )

Deletes the measurement variable by specifying name or index.

Parameters

val	measurement variable name or index

bool Study::RemoveSelectedResults ( StringList & results )

Deletes the specified results from the result file of the current case.

True is returned as a return value when it is deleted.

Parameters

results Result type name list

Returns: Whether or not it is deleted

bool Study::RemoveSelectedResultsAllCases ( StringList & results )

Deletes the specified results from the result file of the all cases.

True is returned as a return value when it is deleted.

Parameters

results Result type name list

Returns: Whether or not it is deleted

bool Study::RemoveSelectedResultsStepList	(	StringList &	results,
		String &	steps
	)

Deletes the specified result from the result file of the current case by specifying multiple retained steps to the result file with a character string.

A range of steps can be specified using a ‘, (comma)’, such as “1,2,3” or using a ‘- (hyphen)’, such as “4-8”. True is returned as a return value when it is deleted.

Parameters

results	Result type name list
steps	Step

Returns: Whether or not it is deleted

bool Study::RemoveSelectedResultsStepListAllCases	(	StringList &	results,
		String &	steps
	)

Deletes the specified result from the result file of the current case by specifying multiple retained steps to the result file with a character string.

A range of steps can be specified using a ‘, (comma)’, such as “1,2,3” or using a ‘- (hyphen)’, such as “4-8”. True is returned as a return value when it is deleted.

Parameters

results	Result type name list
steps	Step

Returns: Whether or not it is deleted

bool Study::RemoveSelectedResultsSteps	(	StringList &	results,
		int	start,
		int	end,
		int	inter
	)

Deletes the specified result from the result file of the current case by specifying the range and interval of the retained step to the result file.

True is returned as a return value when it is deleted.

Parameters

results	Result type name list
start	Start step
end	End step
inter	Interval

Returns: Whether or not it is deleted

bool Study::RemoveSelectedResultsStepsAllCases	(	StringList &	results,
		int	start,
		int	end,
		int	inter
	)

Deletes the specified result from the result file of all cases by specifying the range and interval of the retained step to the result file.

True is returned as a return value when it is deleted.

Parameters

results	Result type name list
start	Start step
end	End step
inter	Interval

Returns: Whether or not it is deleted

void Study::RemoveSubroutineParameter ( String & name )

Deletes user subroutine parameters.

Parameters

name	User variable name

void Study::RemoveTag ( String & name )

Removes the designated user defined tag

Parameters

name	User tag name

void Study::RemoveVariable ( Variant & name )

Deletes the equation by specifying a variable.

Parameters

name Variable

void Study::RemoveWarningAsError ( int code )

Deletes the warning from the error list by specifying a code.

Parameters

code Code

void Study::Restart	(	int	steps,
		int	outputStep
	)

Resumes calculation of selected study.

Parameters

steps	Number of analysis steps or number of eigenvalues to run calculation
outputStep	Output start step

Recalculates using the Restart command when the [Use Previous Eigenvalue Analysis Results] check box in structural analysis (eigenmode analysis) is selected. Specify the number of eigenvalue to be calculated as step.

void Study::RestartAdaptive ( int stages )

Specifies the maximum stage of the adaptive mesh control and resumes the calculation of the selected study.

Parameters

stages Maximum stage of the adaptive mesh control

void Study::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.

An analysis is not run when results of the current case are already output.
The analysis for the first case is run when multiple cases exist in a study and a case is not selected.

For more information about operations for running an analysis in the graphics window, see "Running the Analysis".

void Study::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.

An analysis is run for only cases without results and not for cases with results.

void Study::RunAllPostCalculationScripts ( )

Runs all of the post-calculation scripts.

Attention: Disabled scripts are not run.

void Study::SetAirRegionVisibility	(	int	index,
		bool	visible
	)

Switches the display of the air region.

Parameters

index	Index of the air region
visible	True=1 : Display False=0 : Hide

void Study::SetCadParameterValue	(	String &	name,
		Variant &	value
	)

Specifies a value for the CAD parameter of a model.

Parameters

name	Name of the CAD parameter
value	Value

void Study::SetCheckForTopologyChanges ( bool flag )

Specifies whether or not to check the increase or decrease in the number of parts, faces, edges, and vertices.

Parameters

flag	True=1 : Check False=0 : Do not check

void Study::SetCopyOnUpdate ( bool flag )

Specifies whether or not to copy a study during model update.

Parameters

flag	True=1 : Copies the study False=0 : Does not copy the study

void Study::SetCurrentCase ( int caseIndex )

Specifies the current case ID.

Parameters

caseIndex Case ID

The caseIndex is numbered from zero.

void Study::SetCurrentComposite ( Variant & val )

Specifies a name or index to dispaly the composite result.

Parameters

val	Name or index of the composite result

void Study::SetCurrentContour ( Variant & val )

Specifies a name or index to specify the contour plot that is displayed.

Parameters

val	Name or index of the contour plot (start from 0)

The index of a contour plot is assigned in the order of "0, 1, 2 …" as displayed in the [Project Manager].
For example, the index of the contour plot in the following diagram [Magnetization : magnetization] is "2".

void Study::SetCurrentFluxLine ( Variant & val )

Specifies a name or index to specify the flux line that is displayed.

Parameters

val	Name or index of the flux line (start from 0)

The index of a flux line is assigned in the order of "0, 1, 2…" as displayed in the [Project Manager].

void Study::SetCurrentScaling ( Variant & val )

Specifies a name or index to specify the scale that is displayed.

Parameters

val	Name or index of the scale (start from 0)

The index for a scale is assigned in the order of "0, 1, 2…" as displayed in the [Project Manager].

void Study::SetCurrentVector ( Variant & val )

Specifies a name or index to specify the vector plot that is displayed.

Parameters

val	Name or index of the vector plot (start from 0)

The index of a contour plot is assigned in the order of "0, 1, 2 …" as displayed in the [Project Manager].

void Study::SetDescription ( String & description )

Specifies the description.

Parameters

description Description

void Study::SetHiddenResults ( String & list )

Specifies the table result items to hide.

Parameters

list	Result Type Name

void Study::SetMaterial	(	Variant &	val,
		Material *	material
	)

Specifies a material to a part using a variable.

Parameters

val	Part name or ID
material	Material object

To display the part ID on the graphics window, tick the [Part ID] under [Display] > [ID information] on the JMAG-Designer menu bar.

void Study::SetMaterialAttributeParameters ( String & list )

Specifies material attribute items.

Parameters

list	Material attribute name

void Study::SetMaterialByName	(	Variant &	val,
		String &	matname
	)

Specifies a material to a part using a variable.

Parameters

val	Part name or ID
matname	Material name

void Study::SetMeasurementVariable	(	String &	name,
		String &	type,
		Selection *	sel
	)

Specifies a measurement variable.

Parameters

name	measurement variable name
type	measurement variable type
sel	Selection object

void Study::SetMessageVisible ( bool on )

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

Deprecated:

void Study::SetModelDivisionCadParameterName ( String & name )

Specifies the CAD parameter name that sets the number of divisions determined from the winding condition.

Parameters

name	CAD parameter name

void Study::SetName ( String & name )

Specifies the name of a study.

Parameters

name	Study name

void Study::SetPostCalculationScriptParameter	(	Variant &	nameOrIndex,
		String &	key,
		Variant &	value
	)

Specifies a post-calculation script parameter from the study by specifying the name or index.

Parameters

nameOrIndex	name or index of the script
key	parameter key
value	parameter value

void Study::SetTag	(	String &	name,
		String &	value
	)

Adds a user defined tag. If the tag's name already exist it updates the tag with the given value.

Parameters

name	User tag name
value	Value

void Study::SetUpdateByRelation ( bool flag )

Specifies whether to consider Parent-Child relation (Condition Parts to setting target).

Parameters

flag	True=1 : Considered False=0 : Does not considered

void Study::SetUpdateCaseValuesWithGeometryAdjustedValues ( bool flag )

Specifies whether to update the case value with the adjusted value.

Parameters

flag	True=1 : Update False=0 : Do not update

void Study::SetUserResponseVariable	(	String &	name,
		int	caseIndex,
		double	value
	)

Specifies or creates a variable of a response value using an user-defined value.

Parameters

name	Name of the response variable
caseIndex	Case index specified for the response value
value	Variable value

The caseIndex is numbered from 0.

void Study::SetVariable	(	Variant &	name,
		Variant &	value
	)

Specifies an equation.

Parameters

name	Variable
value	Expression

void Study::SubmitAllLocal ( bool queued )

Corresponds to the following function of JMAG-Designer13.0 or later.
CreateJob.

Deprecated:: Runs batch processing of all cases on a local machine.

Parameters

queued

Job state
True : Submit Queue
False: Wait

void Study::SubmitAllRemote	(	String &	machine,
		String &	cpu,
		Variant &	keepremote,
		bool	queued
	)

Corresponds to the following function of JMAG-Designer13.0 or later.
CreateJob.

Deprecated:: Specifies machine and runs batch processing of all cases.

Parameters

machine	Management server name of a remote system
cpu	CPU group used in calculation
keepremote	Whether or not results are kept in management server On : Leaves results on remote machine Off : Moves results to local machine Both : Copies to local and leaves on server
queued	Job state True : Submit Queue False : Wait

void Study::SubmitLocal ( bool queued )

Corresponds to the following function of JMAG-Designer 13.0 or later.
CreateJob.

Deprecated:: Runs batch processing of the current case on a local machine.

Parameters

queued

Job state
True : Submit queue
False : Wait

void Study::SubmitRemote	(	String &	machine,
		String &	cpu,
		Variant &	keepremote,
		bool	queued
	)

Corresponds to the following function of JMAG-Designer13.0 or later.
CreateJob.

Deprecated:: Specifies the machine and runs batch processing of the current case.

Parameters

machine	Management server name of the remote system
cpu	CPU group used in a calculation
keepremote	Keeps results in management server On : Leave results on remote machine Off : Move results to local machine Both : Copies to local and deletes on remote machine
queued	Job state True : Submit Queue False : Wait

void Study::SuppressPart	(	Variant &	part,
		int	state
	)

Specifies suppression to a part.

Parameters

part	Part name or ID
state	True=1 : Suppress part False=0 : Clears part suppression

void Study::UnLockAll ( )

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

Deprecated:

void Study::UpdateDriveCycleResponseParametricData	(	Variant &	val,
		DriveCycleResponseDataParameter *	parameter
	)

Changes the response value of the drive cycle by specifying a name or index.

Parameters

val	Response data name or index
parameter	DriveCycleResponseDataParameter object

void Study::UpdateEfficiencyMapParametricData	(	Variant &	val,
		EfficiencyMapResponseDataParameter *	parameter
	)

Changes the response value of the efficiency map by specifying a name or index.

Parameters

val	Response data name or index
parameter	EfficiencyMapResponseDataParameter object

void Study::UpdateParametricData	(	Variant &	val,
		ResponseDataParameter *	parameter
	)

Changes a response data by specifying the name or index.

Parameters

val	Response data name or index
parameter	ResponseDataParameter object

void Study::UpdateScriptParametricData	(	Variant &	val,
		String &	title,
		String &	variable,
		String &	script
	)

Changes the script's response value by name or index.

Parameters

val	The name or index of the response value to change
title	Response value name
variable	Response value variable name
script	Script

void Study::UpdateSubroutineParameter	(	String &	name,
		Variant &	value
	)

Updates user subroutine parameters.

Parameters

name	User variable name
value	Value

void Study::WriteAllMeshJcf	(	String &	path,
		String &	filename,
		bool	active
	)

Exports JCF file (mesh data) of all cases included in a study to the specified folder.

Parameters

path	Path of export folder
filename	Basic file name
active	True : Outputs cases that do not have results False : Outputs all cases whether or not there are results.

void Study::WriteAllSolidJcf	(	String &	path,
		String &	filename,
		bool	active,
		bool	preprocess = `true`
	)

Exports JCF file (geometry data) of all cases included in a study to the specified folder.

Parameters

path	Path of export folder
filename	Basic file name
active	True : Outputs cases that do not have results False : Outputs all cases whether or not there are results.
preprocess	True : Perform preprocessing for mesh generation. False : Not Perform preprocessing for mesh generation.

void Study::WriteAllSolidPartialMeshJcf	(	String &	path,
		String &	filename,
		bool	active,
		bool	preprocess = `true`
	)

Exports JCF file (geometry data contain partial mesh) of all cases included in a study to the specified folder.

Parameters

path	Path of export folder
filename	Basic file name
active	True : Outputs cases that do not have results False : Outputs all cases whether or not there are results.
preprocess	True : Perform preprocessing for mesh generation. False : Not Perform preprocessing for mesh generation.

bool Study::WriteCaseReport ( String & filename )

Exports the case report.

Parameters

filename Name of the report file to export

Returns: Whether or not a report file is exported

void Study::WriteCoilPositionJsonFile ( String & filename )

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

Deprecated:

void Study::WriteMeshJcf ( String & filename )

Exports a JCF file (mesh data) by specifying a file path.

Parameters

filename File path

void Study::WriteModelOutlineJsonFile ( String & filename )

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

Deprecated:

bool Study::WriteResponseReport ( String & filename )

Exports a parametric report.

Parameters

filename Name of the report file to export

Returns: Whether or not a report file is exported

void Study::WriteSolidJcf	(	String &	filename,
		bool	preprocess = `true`
	)

Exports a JCF file (geometry data) by specifying a file path.

Parameters

filename	File path
preprocess	True : Perform preprocessing for mesh generation. False : Not Perform preprocessing for mesh generation.

void Study::WriteSolidPartialMeshJcf	(	String &	filename,
		bool	preprocess = `true`
	)

Exports a JCF file (geometry data contain partial mesh) by specifying a file path.

Parameters

filename	File path
preprocess	True : Perform preprocessing for mesh generation. False : Not Perform preprocessing for mesh generation.

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

Runs the topology optimization.

Parameters

filename	File name to output
independentJobs	Number of simultaneous calculation executions

Public Member Functions

Detailed Description

Member Function Documentation