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
Properties
Methods
Properties
- cee.ug.ModelDirectory.displacementResultArray
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
Whether the model has a rigid body transformation result.
- cee.ug.ModelDirectory.partInfoArray
An array of the parts in the model. See
PartInfo
for more information about parts.
- cee.ug.ModelDirectory.scalarResultArray
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
CuttingPlane
Isosurface
Isovolume
orParticleTraceGroup
- cee.ug.ModelDirectory.setInfoArray
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
Meta data info for the current simulation
- cee.ug.ModelDirectory.stateInfoArray
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
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
CuttingPlane
Isosurface
Isovolume
orParticleTraceGroup
- cee.ug.ModelDirectory.vtfxCaseInfoArray
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
- cee.ug.ModelDirectory.getAllStateIds()
Returns an array of all state ids in the model.
- Return type
[number]
Useful for setting up an animation over all states.
getDisplacementNameById
- cee.ug.ModelDirectory.getDisplacementNameById(id)
Returns the name of the displacement result with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
string
getPartNameById
- cee.ug.ModelDirectory.getPartNameById(geometryIndex, id)
Returns the name of the part with the given geometryIndex/partId, or undefined if the geometryIndex/id pair is invalid.
- Arguments
geometryIndex (
number
) –id (
number
) –
- Return type
string
getResultIdByIdString
- cee.ug.ModelDirectory.getResultIdByIdString(resultType, idString)
Find the result id of the result with the given type and idString
- Arguments
resultType (
cee.ug.ResultType
) –idString (
string
) –
- Return type
number
Returns -1 of the result idString was not found
getResultIdStringById
- cee.ug.ModelDirectory.getResultIdStringById(resultType, id)
Find the idString of the result with the given type and result id
- Arguments
resultType (
cee.ug.ResultType
) –id (
number
) –
- Return type
{ }
Returns undefined result id was not found
getResultInfoByIdString
- cee.ug.ModelDirectory.getResultInfoByIdString(resultType, idString)
Find the result info of the result with the given type and idString
- Arguments
resultType (
cee.ug.ResultType
) –idString (
string
) –
- Return type
{ }
getScalarNameById
- cee.ug.ModelDirectory.getScalarNameById(id)
Returns the name of the scalar result with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
string
getSetNameById
- cee.ug.ModelDirectory.getSetNameById(id)
Returns the name of the element set with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
string
getStateNameById
- cee.ug.ModelDirectory.getStateNameById(id)
Returns the name of the state with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
string
getStateReferenceValueById
- cee.ug.ModelDirectory.getStateReferenceValueById(id)
Returns the reference value of the state with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
number
getVectorNameById
- cee.ug.ModelDirectory.getVectorNameById(id)
Returns the name of the vector result with the given id, or undefined if the id is invalid.
- Arguments
id (
number
) –
- Return type
string
hasDisplacementResult
- cee.ug.ModelDirectory.hasDisplacementResult(stateId, resultId)
Returns true if the given state contains the given scalar result id
- Arguments
stateId (
number
) –resultId (
number
) –
- Return type
boolean
hasScalarResult
- cee.ug.ModelDirectory.hasScalarResult(stateId, resultId)
Returns true if the given state contains the given scalar result id
- Arguments
stateId (
number
) –resultId (
number
) –
- Return type
boolean
hasVectorResult
- cee.ug.ModelDirectory.hasVectorResult(stateId, resultId)
Returns true if the given state contains the given vector result id
- Arguments
stateId (
number
) –resultId (
number
) –
- Return type
boolean