Strolch
/
strolch-website
mirror of
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[Minor] cleaned up formatting

This commit is contained in:
Robert von Burg 2021-07-15 08:56:24 +02:00
parent 39aada61e1
commit c3a6f7c25f
1 changed files with 84 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
content/api/_index.md
View File

@ -31,10 +31,14 @@ stored in the respective ElementMaps in their Strolch realm. Thus
accessing a certain parameter from a Resource would look like this:
```java
try (StrolchTransaction tx = openTx(realmName)) {
Resource resource = tx.getResourceBy("TestType", "MyTestResource");
Date date = resource.getDate("@bag01", "@param6");
logger.info("@param6 date is " + date);
public class Test {
public static void main(String[] args) {
try (StrolchTransaction tx = openTx(realmName)) {
Resource resource = tx.getResourceBy("MyType", "myResource");
Date date = resource.getDate("myBag", "myParam1");
logger.info("myParam date has value " + date);
}
}
}
```
@ -42,19 +46,19 @@ XML Presentation of Strolch's top level elements of Resources:
```xml
<!-- Resource instance -->
<Resource Id="MyTestResource" Name="Test Name" Type="TestType">
<ParameterBag Id="@bag01" Name="Test Bag" Type="TestBag">
<Parameter Id="@param7" Name="StringList Param" Type="StringList" Value="Hello;World" />
<Parameter Id="@param6" Name="Date Param" Type="Date" Value="2012-11-30T18:12:05.628+01:00" />
<Parameter Id="@param5" Name="String Param" Type="String" Value="Strolch" />
<Resource Id="myResource" Name="Test Name" Type="MyType">
<ParameterBag Id="parameters" Name="Parameters" Type="Parameters">
<Parameter Id="myParam2" Name="StringList Param" Type="StringList" Value="Hello, World" />
<Parameter Id="myParam1" Name="Date Param" Type="Date" Value="2012-11-30T18:12:05.628+01:00" />
<Parameter Id="myParam3" Name="String Param" Type="String" Value="Strolch" />
</ParameterBag>
<ParameterBag Id="@bag02" Name="Test Bag" Type="TestBag">
<Parameter Id="@param4" Name="Long Param" Type="Long" Value="4453234566" />
<Parameter Id="@param3" Name="Integer Param" Type="Integer" Value="77" />
<Parameter Id="@param2" Name="Float Param" Type="Float" Value="44.3" />
<Parameter Id="@param1" Name="Boolean Param" Type="Boolean" Value="true" />
<ParameterBag Id="additionalParameters" Name="Parameters" Type="Parameters">
<Parameter Id="myParam1" Name="Long Param" Type="Long" Value="4453234566" />
<Parameter Id="myParam2" Name="Integer Param" Type="Integer" Value="77" />
<Parameter Id="myParam3" Name="Float Param" Type="Float" Value="44.3" />
<Parameter Id="myParam4" Name="Boolean Param" Type="Boolean" Value="true" />
</ParameterBag>
<TimedState Id="@integerState" Name="Integer State" Type="IntegerState">
<TimedState Id="myState" Name="Integer State" Type="IntegerState">
<Value Time="0" Value="1" />
<Value Time="1" Value="2" />
<Value Time="2" Value="3" />
@ -66,17 +70,17 @@ XML Presentation of Strolch's top level elements of Orders:
```xml
<!-- Order instance -->
<Order Id="MyTestOrder" Name="Test Name" Type="TestType" Date="2013-11-20T07:42:57.699Z" State="CREATED">
<ParameterBag Id="@bag01" Name="Test Bag" Type="TestBag">
<Parameter Id="@param7" Name="StringList Param" Type="StringList" Value="Hello;World" />
<Parameter Id="@param6" Name="Date Param" Type="Date" Value="2012-11-30T18:12:05.628+01:00" />
<Parameter Id="@param5" Name="String Param" Type="String" Value="Strolch" />
<Order Id="myOrder" Name="Test Name" Type="MyOrderType" Date="2013-11-20T07:42:57.699Z" State="CREATED">
<ParameterBag Id="parameters" Name="Parameters" Type="Parameters">
<Parameter Id="myParam2" Name="StringList Param" Type="StringList" Value="Hello, World" />
<Parameter Id="myParam1" Name="Date Param" Type="Date" Value="2012-11-30T18:12:05.628+01:00" />
<Parameter Id="myParam3" Name="String Param" Type="String" Value="Strolch" />
</ParameterBag>
<ParameterBag Id="@bag02" Name="Test Bag" Type="TestBag">
<Parameter Id="@param4" Name="Long Param" Type="Long" Value="4453234566" />
<Parameter Id="@param3" Name="Integer Param" Type="Integer" Value="77" />
<Parameter Id="@param2" Name="Float Param" Type="Float" Value="44.3" />
<Parameter Id="@param1" Name="Boolean Param" Type="Boolean" Value="true" />
<ParameterBag Id="additionalParameters" Name="Parameters" Type="Parameters">
<Parameter Id="myParam1" Name="Long Param" Type="Long" Value="4453234566" />
<Parameter Id="myParam2" Name="Integer Param" Type="Integer" Value="77" />
<Parameter Id="myParam3" Name="Float Param" Type="Float" Value="44.3" />
<Parameter Id="myParam4" Name="Boolean Param" Type="Boolean" Value="true" />
</ParameterBag>
</Order>
```
@ -86,68 +90,54 @@ XML Presentation of Strolch's top level elements of Activities:
```xml
<!-- Activity instance -->
<Activity Id="bicycleProduction" Name="Bicycle Production" Type="Series">
<Activity Id="componentProduction" Name="Production of components" Type="Series">
<Action Id="consumeGears" Name="Gears"
ResourceId="gears" ResourceType="Article" Type="Consume">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT0S" />
</ParameterBag>
</Action>
<Activity Id="frameProduction" Name="Production frame" Type="Series">
<Action Id="produce" Name="Production frame"
ResourceId="frameProduction" ResourceType="Machine" Type="Use">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M" />
</ParameterBag>
</Action>
<Action Id="toStock" Name="Frame ToStock"
ResourceId="frame" ResourceType="Article" Type="Produce">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M" />
</ParameterBag>
</Action>
</Activity>
<Activity Id="brakeProduction" Type="Series" Name="Herstellen Bremsen" TimeOrdering="Series">
<Action Id="produce" Name="Production saddle"
ResourceId="saddleProduction" ResourceType="Machine" Type="Use">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M" />
</ParameterBag>
</Action>
<Action Id="toStock" Name="Saddle ToStock"
ResourceId="frame" ResourceType="Article" Type="Produce">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M" />
</ParameterBag>
</Action>
</Activity>
<Activity Id="componentProduction" Name="Production of components" Type="Series">
<Action Id="consumeGears" Name="Gears" ResourceId="gears" ResourceType="Article" Type="Consume">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT0S"/>
</ParameterBag>
</Action>
<Activity Id="frameProduction" Name="Production frame" Type="Series">
<Action Id="produce" Name="Production frame" ResourceId="frameProduction" ResourceType="Machine" Type="Use">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M"/>
</ParameterBag>
</Action>
<Action Id="toStock" Name="Frame ToStock" ResourceId="frame" ResourceType="Article" Type="Produce">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M"/>
</ParameterBag>
</Action>
</Activity>
<Action Id="assembly" Name="Bicycle assemble"
ResourceId="bicycleAssembly" ResourceType="Assembly" Type="Use">
<Activity Id="brakeProduction" Name="Herstellen Bremsen" TimeOrdering="Series" Type="Series">
<Action Id="produce" Name="Production saddle" ResourceId="saddleProduction" ResourceType="Machine" Type="Use">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M" />
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M"/>
</ParameterBag>
</Action>
<Action Id="toStock" Name="Bicycle to stock"
ResourceId="bicycle" ResourceType="Product" Type="Produce">
</Action>
<Action Id="toStock" Name="Saddle ToStock" ResourceId="frame" ResourceType="Article" Type="Produce">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1" />
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M" />
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M"/>
</ParameterBag>
</Action>
</Action>
</Activity>
</Activity>
<Action Id="assembly" Name="Bicycle assemble" ResourceId="bicycleAssembly" ResourceType="Assembly" Type="Use">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT5M"/>
</ParameterBag>
</Action>
<Action Id="toStock" Name="Bicycle to stock" ResourceId="bicycle" ResourceType="Product" Type="Produce">
<ParameterBag Id="objectives" Name="Production goals" Type="Objectives">
<Parameter Id="quantity" Name="Quantity" Type="Float" Value="1"/>
<Parameter Id="duration" Name="Duration" Type="Duration" Value="PT1M"/>
</ParameterBag>
</Action>
</Activity>
```
@ -171,14 +161,18 @@ Strolch agent implements:
back to the persistence layer. This allows for fast in-memory quries, but
makes sure no data is lost when the agent is restarted.
Strolch Realms are also responsible for opening Transactions, as these are
bound to the persistence layer configured for this realm. At runtime, a realm
is then accessed from the ComponentContainer:
Strolch Realms are also responsible for opening Transactions, as these are bound
to the persistence layer configured for this realm. At runtime, a realm is then
accessed from the ComponentContainer:
```java
ComponentContainer container = getAgent().getContainer();
StrolchRealm realm = container.getRealm(StrolchConstants.DEFAULT_REALM);
try(StrolchTransaction tx = realm.openTx()) {
Resource resource = tx.getResourceBy("TestType", "MyTestResource");
...
public class Example {
public static void main(String[] args) {
ComponentContainer container = getAgent().getContainer();
StrolchRealm realm = container.getRealm(StrolchConstants.DEFAULT_REALM);
try (StrolchTransaction tx = realm.openTx()) {
Resource resource = tx.getResourceBy("TestType", "MyTestResource");
}
}
}
```