Study

Study
This namespace holds top-level commands and queries related to Study

CreateTask

Create a task, given the name for the task type.

Return     The component created for the task.
    Type     DataReference

Required Arguments

System    The system where the task component should be created.
    Type     DataReference
Type    The task type to create.
    Type     string

Optional Arguments

Input    Optional, the task component which should be an upstream source for the created component.
    Type     DataReference
Output    Optional, the task component which should be downstream of the created component.
    Type     DataReference
Example

Required example does not exist.

CreateGroup

Create a new task group based on the given task group name.+

Return     The newly created group
    Type     DataReference

Required Arguments

Name    The name of the new group
    Type     string

GetAllEngineeringDataInProject

Find all engineering data objects in the project.

Return     All engineering data objects in the project
    Type     DataReferenceSet

GetAllLeafTasksInProject

Returns all leaf tasks in the project.

Return     All leaf tasks in the project.
    Type     DataReferenceSet

GetAllRootTasksInProject

Returns all root tasks in the project.

Return     All root tasks in the project.
    Type     DataReferenceSet

GetAllTasksInProject

Returns all tasks in the project.

Return     All tasks in the project.
    Type     DataReferenceSet

GetInputMesh

If available for a task, return the input mesh; otherwise null.

Return     The input mesh.
    Type     DataReference

Required Arguments

Task    The task to query.
    Type     DataReference

GetInputModel

If available for a task, return the input model; otherwise null.

Return     The input model.
    Type     DataReference

Required Arguments

Task    The task to query.
    Type     DataReference

GetOutputMesh

If available for a task, return the output mesh; otherwise null.

Return     The output mesh.
    Type     DataReference

Required Arguments

Task    The task to query.
    Type     DataReference

GetOutputModel

If available for a task, return the output model; otherwise null.

Return     The output model.
    Type     DataReference

Required Arguments

Task    The task to query.
    Type     DataReference

GetReferences

Returns a list of reference strings of the specified model components.

Return     A List of the reference strings of the specified model components.
    Type     List<string>

Required Arguments

ModelComponents    The DataReferenceSet of the model components of interest.
    Type     DataReferenceSet

GetReferenceString

Returns a reference string for a user object. This is a special case query, for those objects that contain references, not stored in LocationSets. For now, works on Locator objects only, and is to be used to retrieve the surface area of bounded surfaces: Sphere, Torus, and CappingSurface only.

Return     Reference string for the specified object.
    Type     string

Required Arguments

ObjectReference    The DataReference for the specified object that is assumed to be Analytic.
    Type     DataReference

GetTaskUserObjectBelongsTo

Returns a data reference to a Task that the provided UserObject maps to. May return null.

Return     The input tasks for the given task.
    Type     DataReference

Required Arguments

UserObjectReference    The user object to map to a task.
    Type     DataReference

InitializeGuidedSimulations

Initializes data when executing Guided Simulations.


Release 18.2 - © ANSYS, Inc. All rights reserved.