Simantics/Model module documentation

model :: String -> <ReadGraph> Resource
model name

Returns an existing model in the current project with the given name

configurationOf :: Resource -> <ReadGraph> Resource
configurationOf model

Returns the configuration of the given model and returns the configuration resource

allModels :: () -> <ReadGraph> [Resource]

Returns the list of all models in the current project.

getPossibleModel :: Resource -> <ReadGraph> Resource

Undocumented entities

activateModel :: Resource -> <WriteGraph> Boolean

Activates the specified model but does not wait for any of the effects caused by the activation to be completed. In most cases the blocking version syncActivateModel should be used instead of this function.

activateModelAction :: Resource -> <Proc> ()
copyAnnotationTypes :: Resource -> Resource -> <WriteGraph> ()

Copies annotation types from one model to another.

createGenericModel :: Resource -> String -> <WriteGraph> Resource
deleteIndex :: Resource -> <WriteGraph> ()
listIndexEntries :: Resource -> String -> <ReadGraph> String
possibleIndexRoot :: Resource -> <ReadGraph> Maybe Resource
releaseMemory :: () -> <WriteGraph> ()
removeIndex :: Resource -> <WriteGraph> ()

Removes the index associated with the model.

resetIssueSources :: Resource -> <WriteGraph> ()
searchByQuery :: Resource -> String -> <ReadGraph> [Resource]
searchByQueryShallow :: Resource -> String -> <ReadGraph> [Resource]
searchByType :: Resource -> Resource -> <ReadGraph> [Resource]
searchByTypeAndFilter :: Resource -> Resource -> (Resource -> <ReadGraph> Boolean) -> <ReadGraph> [Resource]
searchByTypeAndName :: Resource -> Resource -> String -> <ReadGraph> [Resource]
searchByTypeAndNameShallow :: Resource -> Resource -> String -> <ReadGraph> [Resource]
searchByTypeShallow :: Resource -> Resource -> <ReadGraph> [Resource]
syncActivateModel :: Resource -> <Proc> Boolean

Activates the specified model and blocks until all effects caused by the activation have been completed. This function is a synchronous version of the older activateModel function that does not wait for activation completion, i.e. works asynchronously. In most cases it is recommended to use this functions instead of

The effect completion waiting works based on the org.simantics.db.service.ServiceActivityMonitor service offered by the database client. Therefore implementation that want to support waiting for activation completion need to register/unregister activities with this service accordingly.