API Provided in the Previous Version (JMAG-Designer)

This chapter explains the script provided in the previous version. Categorization is based on the class that each command belongs to.
In the new version, the API of a script may have been reworked in order to expand its functions. Please use the API of the new version when creating a script with the latest version.
The API for the previous version, however, can still be used with the latest version.

Member AnalysisGroup::HasMultipleModels ()

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

Member AnalysisGroup::RunCoupled ()

Runs coupled analysis calculation for the current case.

Member AnalysisGroup::RunCoupledAllCases ()

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

Member AnalysisGroup::RunSelectStudies (String array &studylist)

Runs sequential calculation of the selected studies.

Parameters

studylist

Study index to perform analysis

Member AnalysisGroup::RunSequential ()

Runs sequential calculation for the current case.

Member AnalysisGroup::RunSequentialAllCases ()

Runs sequential calculation for all cases.

Member Application::AppendScriptXML (String &xml)

Member Application::AttachMotorTemplate (long pid)

Member Application::CreateGeometryEditorInternal (bool askForSave=true)

Member Application::CreateMotorTemplateInternal ()

Member Application::CreateTransformerEditorInternal ()

Member Application::DetachMotorTemplate ()

Member Application::GetDefaultModelFolderPath ()

Member Application::GetStudyResult (String &studyIdentifier, int caseIndex)

Member Application::IsIdRecordingMode ()

Member Application::IsStartRecording ()

Member Application::LoadNewCaseData (String &xmldata)

Member Application::LoadNewCaseFile (String &filename)

Member Application::OnHiddenMotorTemplate (qint64 pid)

Member Application::OutputLogDebugInfo (String &info)

Member Application::OutputLogInfo (String &info)

Member Application::SetCloseWithoutTermination (bool flag)

Member Application::SetMessageVisible (bool on)

Member Application::SetShowProgressDialog (bool show)

Member Circuit::ClearVoltageDifferenceLabel ()

Deletes all differences in results between the two terminals added to the result table.

Member Circuit::CreateResponseTable (CircuitComponent *component)

Creates a response value table from the RT component.

Parameters

component

CircuitComponent object

Member Circuit::CreateVoltageDifferenceLabel (String &name, int x1, int y1, int x2, int y2)

Adds the difference in results between two terminals to a result table.

Member Circuit::DeleteVoltageDifferenceLabel (int x1, int y1, int x2, int y2)

Deletes the difference in results between two terminals from a result table.

Member Condition::InsertSubConditionByIndex (int conditionIndex, int subIndex)

Inserts the lower conditions to the condition by specifying the indexes.

Parameters

conditionIndex	Index of the condition to insert.
subIndex	Index of the lower conditions

Member Condition::NodeIsOnTarget (int nodeId, double tolerance=1e-6)

Member CutPlane::GetShowCutOnly ()

Returns the flag for displaying the cut part of the model.

Returns

Whether or not to display the cut part

True=1
False=0

Member CutPlane::SetShowCutOnly (bool flag)

Specifies the switching state of the cut plane.

Parameters

flag	True=1 : Displays the cut part only False=0 : Displays the cross-section

Member DataManager::IsSingleton ()

Member FunctionObjectFactory::IsSingleton ()

Member MaterialLibrary::IsSingleton ()

Member MeshControl::CreateLayerMesh (Selection *selection, double thickness, int division, double lamination)

Adds the layer mesh.

Parameters

selection	Selection object
thickness	Thickness
division	Number of layers
lamination	Lamination factor

Returns

Condition object

Member MeshControl::CreateLayerMeshWithUnit (Selection *selection, double thickness, int division, double lamination, String &unitName)

Adds layer mesh with unit specification.

Parameters

selection	Selection object
thickness	Thickness
division	Number of layers
lamination	Lamination factor
unitName	Unit

Returns

Condition object

Member MeshControl::CreateSizeCondition (String &typeName, Selection *selection, double value)

Creates a mesh condition of the specified type to set the element size of the Selection range to value.

Parameters

typeName	Type name: Face Part Edge Vertex
selection	Selection object
value	Value of element size

Returns

Condition object

Member MeshControl::CreateSizeConditionWithUnit (String &typeName, Selection *selection, double value, String &unitName)

Creates a mesh condition of the specified type to set the element size of the Selection range to value with unit specification.

Parameters

typeName	Type name: Face Part Edge Vertex
selection	Selection object
value	Value of element size
unitName	Unit

Returns

Condition object

Member MeshControl::CreateSkinDepthSize (String &typeName, Selection *selection, double skinDepth, int division)

Creates a mesh condition of a specified type to set the element size of the Selection range to value.

Parameters

typeName	Type name
selection	Selection object
value	Value of element size
skinDepth	Skin depth
division	Number of divisions

Returns

Condition object

Member MeshControl::CreateSkinDepthSizeWithUnit (String &typeName, Selection *selection, double skinDepth, int division, String &unitName)

Creates a mesh condition of a specified type to set the element size of the Selection range to value with unit specification.

Parameters

typeName	Type name
selection	Selection object
value	Value of element size
skinDepth	Skin depth
division	Number of divisions
unitName	Unit

Returns

Condition object

Member MeshControl::DeleteConditionByType (String &typeName, Variant &val)

Deletes a condition specifying the element size of mesh.

Parameters

typeName	Type name
val	Name or index of the condition

Member MeshControl::GetConditionByType (String &typeName, Variant &val)

Returns the mesh condition for the specified type.

Parameters

typeName	Condition type name
val	Name or index of the condition

Returns

Condition object

Member MeshControl::NumConditionsByType (String &typeName)

Returns the number of mesh conditions for the specified type as an integer.

Parameters

typeName

Type of mesh condition

Returns

Number of mesh conditions for the specified type

Member Model::RunSelectStudies (String array &studylist)

Runs sequential calculation of the selected studies.

Parameters

studylist

Study index to perform analysis

Member Model::WriteModelOutlineJsonFile (String &filename, int divisions)

Member OptimizationTable::AlwaysCheckConflict ()

Returns whether or not to run a calculation when running a conflict check.

Member OptimizationTable::MaxCases ()

Member OptimizationTable::NewCasesPerLoop ()

Member OptimizationTable::SetAlwaysCheckConflict (bool isAlways)

Specifies whether or not to run an conflict check when running a calculation.

Member OptimizationTable::SetMaxCases (int cases)

Member OptimizationTable::SetNewCasesPerLoop (int cases)

Member OptimizationTable::SetTolerance (double tolerance)

Member OptimizationTable::Tolerance ()

Member ParameterSettingStatus::GetDesignVariable ()

Member ParameterSettingStatus::SetDesignVariable (bool check)

Member Step::InsertSubConditionByIndex (int conditionIndex, int subIndex)

Inserts the steady state condition by specifying the indexes.

Parameters

conditionIndex	Index of the condition to insert.
subIndex	Index of the steady state condition

Member Study::ExportTranslationFile (String &filename)

Member Study::ImportTranslationFile (String &filename)

Member Study::MergeJcfForPreview (String &filename)

Member Study::SetMessageVisible (bool on)

Member Study::SubmitAllLocal (bool queued)

Runs batch processing of all cases on a local machine.

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

Specifies machine and runs batch processing of all cases.

Member Study::SubmitLocal (bool queued)

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

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

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

Member Study::UnLockAll ()

Member Study::WriteCoilPositionJsonFile (String &filename)

Member Study::WriteModelOutlineJsonFile (String &filename)

Member UserComponentList::IsSingleton ()

Member VibrationDefinition::GetRevolutionSpeed ()

Gets the revolution speed.

Returns

Revolution speed

Member VibrationDefinition::SetRevolutionSpeed (Variant &speed)

Sets revolution speed.

Parameters

speed

Revolution speed SetRevolutionSpeed(2000); SetRevolutionSpeed(REVOLUTION_SPEED);

Member ViewController::IsSingleton ()

Member WindingDefinition::CoilPitchValues ()

Member WindingDefinition::ParallelNumberValues ()