ModelDirectory

class cee.ug.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.

Index

Properties

• displacementResultArray
• hasTransformationResult
• partInfoArray
• scalarResultArray
• setInfoArray
• simulationInfo
• stateGroupInfoArray
• stateInfoArray
• vectorResultArray
• vtfxCaseInfoArray

Methods

• getAllStateIds
• getDisplacementNameById
• getPartNameById
• getResultIdByIdString
• getResultIdStringById
• getResultInfoByIdString
• getScalarNameById
• getSetNameById
• getStateNameById
• getStateReferenceValueById
• getVectorNameById
• hasDisplacementResult
• hasScalarResult
• hasVectorResult

Properties

cee.ug.ModelDirectory.displacementResultArray

readonly

displacementResultArray: readonly  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.

cee.ug.ModelDirectory.hasTransformationResult

readonly

hasTransformationResult: boolean

Whether the model has a rigid body transformation result.

cee.ug.ModelDirectory.partInfoArray

readonly

partInfoArray: readonly  PartInfo[]

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

cee.ug.ModelDirectory.scalarResultArray

readonly

scalarResultArray: readonly  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.

cee.ug.ModelDirectory.setInfoArray

readonly

setInfoArray: readonly  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.

cee.ug.ModelDirectory.simulationInfo

readonly

simulationInfo: SimulationInfo

Meta data info for the current simulation

cee.ug.ModelDirectory.stateGroupInfoArray

readonly

stateGroupInfoArray: readonly  StateGroupInfo[]

An array of the available state groups in the model. The id’s are unique and >= 0. The names describe the group. Use the property StateGroupInfo.stateIdArr when specifying state ids in the ModelSpec.stateIdArray.

cee.ug.ModelDirectory.stateInfoArray

readonly

stateInfoArray: readonly  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.

cee.ug.ModelDirectory.vectorResultArray

readonly

vectorResultArray: readonly  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.

cee.ug.ModelDirectory.vtfxCaseInfoArray

readonly

vtfxCaseInfoArray: readonly  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

cee.ug.ModelDirectory.getAllStateIds()

getAllStateIds(): number[]

Returns an array of all state ids in the model.

Useful for setting up an animation over all states.

Returns: number[]

cee.ug.ModelDirectory.getDisplacementNameById()

getDisplacementNameById(id: number): string

Returns the name of the displacement result with the given id, or null if the id is invalid.

Parameters

id: number

Returns: string

cee.ug.ModelDirectory.getPartNameById()

getPartNameById(geometryIndex: number, id: number): string

Returns the name of the part with the given geometryIndex/partId, or null if the geometryIndex/id pair is invalid.

Parameters

geometryIndex: number

id: number

Returns: string

cee.ug.ModelDirectory.getResultIdByIdString()

getResultIdByIdString(resultType: ResultType, idString: string): number

Find the result id of the result with the given type and idString.

Returns -1 if the result idString was not found.

Parameters

resultType: ResultType

idString: string

Returns: number

cee.ug.ModelDirectory.getResultIdStringById()

getResultIdStringById(resultType: ResultType, id: number): string

Find the idString of the result with the given type and result id.

Returns null if id was not found.

Parameters

resultType: ResultType

id: number

Returns: string

cee.ug.ModelDirectory.getResultInfoByIdString()

getResultInfoByIdString(resultType: ResultType, idString: string): ResultInfo

Find the result info of the result with the given type and idString. Returns null when no match is found.

Parameters

resultType: ResultType

idString: string

Returns: ResultInfo

cee.ug.ModelDirectory.getScalarNameById()

getScalarNameById(id: number): string

Returns the name of the scalar result with the given id, or null if the id is invalid.

Parameters

id: number

Returns: string

cee.ug.ModelDirectory.getSetNameById()

getSetNameById(id: number): string

Returns the name of the element set with the given id, or null if the id is invalid.

Parameters

id: number

Returns: string

cee.ug.ModelDirectory.getStateNameById()

getStateNameById(id: number): string

Returns the name of the state with the given id, or null if the id is invalid.

Parameters

id: number

Returns: string

cee.ug.ModelDirectory.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

cee.ug.ModelDirectory.getVectorNameById()

getVectorNameById(id: number): string

Returns the name of the vector result with the given id, or null if the id is invalid.

Parameters

id: number

Returns: string

cee.ug.ModelDirectory.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

cee.ug.ModelDirectory.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

cee.ug.ModelDirectory.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