Simulation Object Navigation Functions

GetCategoryDiscipline

An attribute in the metadata of a Simulation object determines to which category (Model, Scenario, or Result) the object belongs and hence the icon to associate with the object. If this attribute is not provided, you can use the GetCategoryDiscipline function to temporarily update the model and to find the correct icon. This function is used to update old models.

Signature

GetCategoryDiscipline(Entity : SIMObjSimulationCategoryReference) : String

Arguments


Name	Input / Output	Required?	Type	Comment
`Entity`	In	Yes	SIMObjSimulationCategoryReference	None

ReturnType

Return Type

String

Example

Let rattrapDiscipline(String)
rattrapDiscipline = GetCategoryDiscipline(ThisObject)

GetIconForSimulationDocument

Return the appropriate icon to be displayed in the user interface for a particular file type (MIME type).

Signature

GetIconForSimulationDocument(iMimeType) : String

Arguments


Name	Input / Output	Required?	Type	Comment
`iMimeType`	In	Yes	String	Searches for `PSM_SIMREP_3DNAVREP_iMimeType.cgr` and `MimeType: iMimeType`. If neither are found, returns default of `I_SimulationRep`.

ReturnType

Return Type

String

Example

Let iconFilename(String)
Let Prefixtmp(String)
iconFilename = GetIconForSimulationDocument(Prefixtmp)

GetNavRepForSimulationDocument

Return the appropriate navigational representation (NavRep) to be displayed in the user interface for a particular file type (MIME type).

Signature

GetNavRepForSimulationDocument(iMimeType) : String

Arguments


Name	Input / Output	Required?	Type	Comment
`iMimeType`	In	Yes	String	Searches for `PSM_SIMREP_3DNAVREP_I_Simulation_iMimeType.cgr`. If not found, returns default of `PSM_SIMREP_3DNAVREP.cgr`

ReturnType

String

Example

Let cgrFilename(String)
Let Prefixtmp(String)
cgrFilename = GetNavRepForSimulationDocument(Prefixtmp)