Class: MeshWorkflowStepGroup

Object that wraps IDSEngineeringModelWorkflow.

Methods

Name Description
Activate() Activate the current object.
AddFigure() Creates a new child Figure.
AddImage(String) Creates a new child Image. If a filePath is provided, the image will be loaded from that file, if not, the image will be a screen capture of the Geometry window.
AddSettings(SettingsType) Add the settings of the input SettingsType to the Steps node.
AddStep(OperationType) Add another operation to the sequence of steps to be executed for the mesh workflow.
ClearDataAndDisableCheckpoints() Clear all checkpoints data and disable checkpointing for the workflow.
ConvertSizingSettings(SettingsType) Convert the active sizing settings to the input SettingsType for the Steps node.
CopyTo(DataModelObject) Copies all visible properties from this object to another.
CreateParameter(String) Creates a new parameter for a Property.
Delete() Run the Delete action.
DeleteAllStepsAndClearGeneratedData() Deletes all steps and reset workflow type to undefined and also resets all inactive geometry parts/bodies to active again, clears the output data, and resets the state of the child objects (“Input”, “Steps”, “Output”) to the initial state. However, any user-defined settings such as the “Input” node scoping are retained.
DeleteSettings(SettingsType) Delete the settings of the input SettingsType from the Steps node. All the Settings specific entries are removed automatically to the Steps details.
DisableAllCheckpoints() Disables checkpoints for all editable steps in the workflow.
Duplicate() Creates a copy of the current DataModelObject.
EnableAllCheckpoints() Enables checkpoints for all editable steps in the workflow.
ExecuteAllSteps() Executes all steps defined under the “StepGroup” object (which is the “Steps” node in the UI).
ExecuteNextStep() Executes the next step, i.e. the next operation which is ready to be executed under the parent “StepGroup” object.
ExecuteUpToStep(Object) Executes any not yet ready steps up to and including the specified step.
GetParameter(String) Gets the parameter corresponding to the given property.
GetPath() Gets the path of the object.
GroupAllSimilarChildren() Run the GroupAllSimilarChildren action.
GroupSimilarObjects() Run the GroupSimilarObjects action.
PropagateSettings(SettingsType) Propagate the settings of the input SettingsType to the attributes of the Step nodes. The meshing attributes of the Step nodes will then be automatically defined based on the physical parameters of the settings. Otherwise, the meshing attributes need to be manually specified.
PropertyByAPIName(String) Get a property by its API name. If multiple properties have the same API Name, only the first property with that name will be returned.
PropertyByName(String) Get a property by its unique name.
RemoveParameter(String) Removes the parameter from the parameter set corresponding to the given property.
RevertToLastCheckpoint() Revert to the last available checkpoint; if no checkpoint is available, then an exception will be raised.
RevertToStep(Object) Revert to the specified step; if no checkpoint is available, then an exception will be raised.

Properties

Name Description
AcousticCurvatureAngle Gets or sets the curvature angle of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default curvature angle is used.
AcousticDefeatureMeshSize Gets or sets the defeature element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.
AcousticGrowthRate Gets or sets the growth rate of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the default growth rate is used.
AcousticMinimumMeshSize Gets or sets the minimum element size of the mesh to be used in workflow steps for the acoustic workflow. If set to 0, the value is automatically defined based on the model size.
AnalysisFrequency Defines the analysis frequency of the acoustic scenario.
BoundingBoxFactor Gets or sets the bounding box factor applied to compute automatically the StackerMeshSize from the model. If set to 0, the default bouding box factor is used.
CurvatureAngle Gets or sets the curvature angle of the mesh to be used in workflow steps. If set to 0, the default curvature angle is used.
DataModelObjectCategory Gets the name of the current DataModelObject's category.
DirectionX Gets or sets the X component of stacking direction used by stacker operations , with respect to Global Coordinate System.
DirectionY Gets or sets the Y component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.
DirectionZ Gets or sets the Z component of stacking direction to be used in stacker steps, with respect to Global Coordinate System.
Figures Gets the list of associated figures.
GlobalMeshSize Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.
GrowthRate Gets or sets the growth rate of the mesh to be used in workflow steps. If set to 0, the default growth rate is used.
Images Gets the list of associated images.
InternalObject Gets the internal object. For advanced usage only.
LateralDefeatureSize Gets or sets the defeature size to be used along the lateral direction of stacking in stacker operations.
MaximumMeshSize Gets or sets the element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.
MeshSize Defines the mesh size of the acoustic scenario based on the wave velocity and the frequency.
MinimumMeshSize Gets or sets the minimal element size of the mesh to be used in workflow steps. If set to 0, the value is automatically defined based on the model size.
Name Gets the name of the object.
NonStackableBodyMeshSize Gets or sets the element size to be used in meshing non-stackable bodies in stacker workflow.
NumberOfAcousticLayers Gets or sets the number of layers in the acoustic region. If set to 0, the value defaults to 1 if QuadraticElements is enabled (see ) or 2 otherwise.
NumberOfCores Defines how many CPU cores to be used in an operation (if supported by the operation).
NumberOfPMLs Gets or sets the number of layers in the perfectly meshed layers region. If set to 0, the value defaults to 2 if QuadraticElements is enabled (see ) or 4 otherwise.
ObjectId Gets the internal id of the object.
ObjectTags Gets an IEnumerable object of the tags that 'this' is a part of.
OriginX Gets or sets the X coordinate location of base face for the volume flattening step.
OriginY Gets or sets the Y coordinate location of base face for the volume flattening step.
OriginZ Gets or sets the Z coordinate location of base face for the volume flattening step.
Parent Gets the parent object.
Properties Gets the list of properties for this object.
QuadraticElements Defines if the quadratic elements are used for the mesh generation.
SpeedOfSound Defines the speed of sound in the acoustic scenario.
StackingDefeatureSize Gets or sets the defeature size to be used along the stacking direction in stacker operations.
VisibleProperties Gets the list of properties that are visible for this object.