Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModelDirectory

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.

Hierarchy

  • ModelDirectory

Index

Properties

Readonly displacementResultArray

displacementResultArray: ReadonlyArray<ResultInfo> = []

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.

Readonly hasTransformationResult

hasTransformationResult: boolean = false

Whether the model has a rigid body transformation result.

Readonly partInfoArray

partInfoArray: ReadonlyArray<PartInfo> = []

An array of the parts in the model. See PartInfo for more information about parts.

Readonly scalarResultArray

scalarResultArray: ReadonlyArray<ResultInfo> = []

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.

Readonly setInfoArray

setInfoArray: ReadonlyArray<SetInfo> = []

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.

Readonly simulationInfo

simulationInfo: SimulationInfo

Meta data info for the current simulation

Readonly stateInfoArray

stateInfoArray: ReadonlyArray<StateInfo> = []

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.

Readonly vectorResultArray

vectorResultArray: ReadonlyArray<ResultInfo> = []

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.

Readonly vtfxCaseInfoArray

vtfxCaseInfoArray: ReadonlyArray<VTFxCaseInfo> = []

An array of cases present in the VTFx file. Use the format modelKey|caseId to open a specific case from a VTFx file.

Methods

getAllStateIds

  • getAllStateIds(): number[]
  • Returns an array of all state ids in the model.

    Useful for setting up an animation over all states.

    Returns number[]

getDisplacementNameById

  • getDisplacementNameById(id: number): string
  • Returns the name of the displacement result with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns string

getPartNameById

  • getPartNameById(geometryIndex: number, id: number): string
  • Returns the name of the part with the given geometryIndex/partId, or undefined if the geometryIndex/id pair is invalid.

    Parameters

    • geometryIndex: number
    • id: number

    Returns string

getResultInfoByIdString

  • Find the result info of the result with the given type and idString

    Parameters

    Returns ResultInfo | undefined

getScalarNameById

  • getScalarNameById(id: number): string
  • Returns the name of the scalar result with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns string

getSetNameById

  • getSetNameById(id: number): string
  • Returns the name of the element set with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns string

getStateNameById

  • getStateNameById(id: number): string
  • Returns the name of the state with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns string

getStateReferenceValueById

  • getStateReferenceValueById(id: number): number
  • Returns the reference value of the state with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns number

getVectorNameById

  • getVectorNameById(id: number): string
  • Returns the name of the vector result with the given id, or undefined if the id is invalid.

    Parameters

    • id: number

    Returns string

hasDisplacementResult

  • hasDisplacementResult(stateId: number, resultId: number): boolean
  • Returns true if the given state contains the given scalar result id

    Parameters

    • stateId: number
    • resultId: number

    Returns boolean

hasScalarResult

  • hasScalarResult(stateId: number, resultId: number): boolean
  • Returns true if the given state contains the given scalar result id

    Parameters

    • stateId: number
    • resultId: number

    Returns boolean

hasVectorResult

  • hasVectorResult(stateId: number, resultId: number): boolean
  • Returns true if the given state contains the given vector result id

    Parameters

    • stateId: number
    • resultId: number

    Returns boolean

Generated using TypeDoc