An array of the available displacement results in the model. The id's are unique and >= 0. The names describe the results. Use the Ids when specifying the displacement result id in the ModelSpec.
Whether the model has a rigid body transformation result.
An array of the parts in the model. See PartInfo for more information about parts.
An array of the available scalar results in the model. The id's are unique and >= 0. The names describe the results. Use the Ids when specifying scalar result ids in the ModelSpec, CuttingPlanes, Isosurfaces, Isovolumes or ParticleTraceGroups.
An array of the available element sets in the model. The id's are unique and >= 0. The names describe the set. Use the Ids when specifying the visible sets in the ModelSpec.
Meta data info for the current simulation
An array of the available states in the model. The id's are unique and >= 0. The names describe the states/time steps. Use the Ids when specifying state ids in the ModelSpec.
An array of the available vector results in the model. The id's are unique and >= 0. The names describe the results. Use the Ids when specifying vector result ids in the ModelSpec, CuttingPlanes, Isosurfaces, Isovolumes or ParticleTraceGroups.
An array of cases present in the VTFx file. Use the format modelKey|caseId to open a specific case from a VTFx file.
Returns an array of all state ids in the model.
Useful for setting up an animation over all states.
Returns the name of the displacement result with the given id, or undefined if the id is invalid.
Returns the name of the part with the given geometryIndex/partId, or undefined if the geometryIndex/id pair is invalid.
Find the result id of the result with the given type and idString
Returns -1 of the result idString was not found
Find the idString of the result with the given type and result id
Returns undefined result id was not found
Find the result info of the result with the given type and idString
Returns the name of the scalar result with the given id, or undefined if the id is invalid.
Returns the name of the element set with the given id, or undefined if the id is invalid.
Returns the name of the state with the given id, or undefined if the id is invalid.
Returns the reference value of the state with the given id, or undefined if the id is invalid.
Returns the name of the vector result with the given id, or undefined if the id is invalid.
Returns true if the given state contains the given scalar result id
Returns true if the given state contains the given scalar result id
Returns true if the given state contains the given vector result id
Generated using TypeDoc
The model directory contains a table of contents of what is available in the current CAE analysis. It has a list of all states/time steps, results and part infos in the model.
The model directory can be used to populate a UI with the available states and results. It is used by property accessors when specifying results and states (e.g. in the ModelSpec) to verify that the input is correct.
You can access the model directory using RemoteModel.modelDirectory.