User Guide

The User Guide describes the Xholon runtime framework systematically and in detail. It is currently just a stub.

The sample applications that come with the Xholon release use certain conventions in naming their XML configuration files. These conventions are shown in the following table. In some cases the main part of the name is suffixed with additional information to distinguish between different versions of an application. Keep in mind that these are just conventions and that you may use any name you wish, as long as these are consistent with the names you provide in the main configuration file (appname_xhn.xml).

The following are all the standard configuration parameters that can currently be used in _xhn.xml files. In addition, any model can create and use its own parameters.

1. ShowParams "true" or "false" Whether to display the parameters at runtime in the console window. default: false
2. ModelName ex: "Hello World" Displayable name of the model. default: null
3. AppM "true" or "false" Whether to display application messages at runtime in the console window. default: true
4. InfoM "true" or "false" Whether to display information messages at runtime in the console window. default: true
5. ErrorM "true" or "false" Whether to display error messages at runtime in the console window. default: true
6. MaxXholons ex: "20" Maximum number of Xholon nodes to preallocate if using TreeNodeFactoryStatic. default: 0
7. MaxXholonClasses ex:"5" Maximum number of Xholon Class nodes to preallocate if using TreeNodeFactoryStatic. default: 0
8. MaxStateMachineEntities ex: "100" Maximum number of State Machine nodes to preallocate if using TreeNodeFactoryStatic. default: 0
9. MaxActivities ex: "5000" Maximum number of Activity nodes to preallocate if using TreeNodeFactoryStatic. default: 0
10. MaxProcessLoops ex: "10" special: "-1" = loop forever Maximum number of time steps to run the application. default: 10
11. TimeStepInterval ex: "10" Number of milliseconds per time step. Implemented by XholonTime. default: 10
12. InheritanceHierarchyFile ex: "./config/HelloWorld/InheritanceHierarchy.xml" Location of the InheritanceHierarchy XML file. default: null
13. CompositeStructureHierarchyFile ex: "./config/HelloWorld/CompositeStructureHierarchy.xml" Location of the CompositeStructureHierarchy XML file. default: null
14. ClassDetailsFile ex: "./config/HelloWorld/ClassDetails.xml" Location of the ClassDetails XML file. default: null
15. InformationFile ex: "./config/HelloWorld/Information.xml" Location of the Information XML file. default: null
16. JavaClassName ex: "org.primordion.xholon.tutorials.AppHelloWorld" Name of the Java subclass that implements IApplication and extends Application. default: null
17. JavaXhClassName (ctrnn/AdapSysLab, cellontro/sbml/*) ex: "org.primordion.ctrnn.app.XhAdapSysLab" ex: "org.primordion.cellontro.app.sbml.XhCellModel" Name of the Java subclass that implements IXholon and extends Xholon. default: null
18. UseDataPlotter "JFreeChart" or "gnuplot" or "none" Whether the data each timestep is plotted on a graph, and which software to use. default: "none"
19. UseGraphicalTreeViewer "true" or "false" Whether to draw a graphical tree diagram of the composite structure hierarchy. default: false
20. UseGraphicalNetworkViewer "true" or "false" Whether to draw a graphical network diagram showing port connections between xholons. default: false
21. UseGridViewer "true" or "false" Whether to use 2D graphics to view the grid. default: false
22. UseInteractions ex: "true" or "false" Whether to capture interactions between Xholons, that can be output as a graphical UML Sequence Diagram. default: false
23. UseVrml "true" or "false" Whether to capture the composite structure of this application as a VRML file. default: false
24. UseDraw "true" or "false" Whether to draw simple text-based tree diagram of the composite structure hierarchy. default: false
25. SaveSnapshots "true" or "false" Whether to save a complete snapshot each time stamp. default: false
26. UseDefaultViewer @deprecated