Improved Simantics/SCL module SCL module/script functionality

[simantics/platform.git] / bundles / org.simantics.modeling / scl / Simantics / SCL.md

diff --git a/bundles/org.simantics.modeling/scl/Simantics/SCL.md b/bundles/org.simantics.modeling/scl/Simantics/SCL.md
new file mode 100644 (file)
index 0000000..d985176
--- /dev/null
+++ b/bundles/org.simantics.modeling/scl/Simantics/SCL.md
@@ -0,0 +1,59 @@
+# Simantics/SCL\r
+\r
+This module contains functions closely related to SCL and storing\r
+SCL related constructs in the Simantics database.\r
+\r
+## SCL Command Session\r
+\r
+::data[CommandResponse]\r
+::value[createTextAndErrors]\r
+::value[execute]\r
+::value[isSuccessful]\r
+\r
+### SCL Realm\r
+\r
+::value[getOrCreateSCLRealm]\r
+::value[readSCLRealm]\r
+::value[refreshVariables]\r
+::value[sclRealmById]\r
+::value[syncExec]\r
+\r
+### Command Session Variable Access\r
+\r
+::value[setVariable]\r
+::value[variableValue]\r
+\r
+## SCL Values\r
+\r
+::value[createSCLValue]\r
+::value[createSCLValueIndependent]\r
+::value[setExpression]\r
+\r
+## SCL Modules\r
+\r
+::value[createSCLModuleAction]\r
+::value[createSCLModuleDefault]\r
+::value[createSCLModule]\r
+::value[createSCLModuleR]\r
+::value[createSCLModuleWithDefinition]\r
+::value[setSCLModuleDefinition]\r
+\r
+## SCL Scripts\r
+\r
+::value[createSCLScriptAction]\r
+::value[createSCLScriptDefault]\r
+::value[createSCLScript]\r
+::value[createSCLScriptR]\r
+::value[createSCLScriptWithDefinition]\r
+::value[setSCLScriptDefinition]\r
+\r
+## Ontology definitions (PGraphs)\r
+\r
+PGraph (partial graph) is a textual format for specifying ontologies for Simantics.\r
+For more information on the format, see [this documentation](http://dev.simantics.org/index.php/Graph_File_Format).\r
+\r
+::value[createPGraphAction]\r
+::value[createPGraphDefault]\r
+::value[createPGraph]\r
+::value[createPGraphR]\r
+::value[setPGraphDefinition]\r