xmile

package
v0.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2015 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

The xmile package implements the system dynamics XML Interface Language (XMILE) standard currently being drafted by the OASIS Technical Committee.

For more information, see: https://www.oasis-open.org/apps/org/workgroup/xmile/

Index

Examples

Constants

View Source 
const XMLDeclaration = `<?xml version="1.0" encoding="utf-8" ?>`

the standard XML declaration, declared as a constant for easy reuse.

Variables

This section is empty.

Functions

func UUIDv4 

func UUIDv4() (string, error)

UUIDv4 returns a version 4 (random) variant of a UUID, or an error if it can not.

Types

type Behavior added in v0.1.1 

type Behavior struct {
	XMLName     xml.Name
	NonNegative bool `xml:"non_negative,attr"`
}

type Connect 

type Connect struct {
	XMLName xml.Name
	To      string `xml:"to,attr"`
	From    string `xml:"from,attr"`
}

type Dimension 

type Dimension struct {
	XMLName xml.Name `xml:"dim"`
	Name    string   `xml:"name,attr"`
	Size    string   `xml:"size,attr"`
}

type Display 

type Display struct {
	XMLName xml.Name
	Rect
	Style
	Name            string     `xml:"name,attr,omitempty"`                // stock,flow,aux
	UID             string     `xml:"uid,attr,omitempty"`                 // BUG(bp) should this be an int?
	Label           string     `xml:"label,attr,omitempty"`               // stock,flow,aux
	LabelSide       string     `xml:"label_side,attr,omitempty"`          // stock,flow,aux
	LabelAngle      string     `xml:"label_angle,attr,omitempty"`         // stock,flow,aux
	From            string     `xml:"from,omitempty"`                     // connector
	To              string     `xml:"to,omitempty"`                       // connector
	Angle           string     `xml:"angle,attr,omitempty"`               // connector
	Points          *[]*Point  `xml:"pts>pt"`                             // flow,connector
	IconOf          string     `xml:"icon_of,attr,omitempty"`             // graph-pad-icon
	Precision       int        `xml:"precision,attr,omitempty"`           // lamp
	Units           string     `xml:"units,attr,omitempty"`               // lamp
	SeperatorK      bool       `xml:"thousands_separator,attr,omitempty"` // lamp
	ShowName        bool       `xml:"show_name,attr,omitempty"`           // lamp
	RetainEndingVal bool       `xml:"retain_ending_value,attr,omitempty"` // lamp
	Zones           *[]Zone    `xml:"zones>zone"`                         // lamp
	Entity          *EntRef    `xml:"entity"`                             // lamp,knob
	Min             float64    `xml:"min,attr,omitempty"`                 // knob
	Max             float64    `xml:"max,attr,omitempty"`                 // knob
	Increment       int        `xml:"increment,attr,omitempty"`           // knob
	PadPageVisible  int        `xml:"visible_index,attr,omitempty"`       // stacked_container
	Graphs          *[]Graph   `xml:"graph"`                              // stacked_container
	ScrollX         float64    `xml:"scroll_x,attr,omitempty"`            // chapter (storytelling)
	ScrollY         float64    `xml:"scroll_y,attr,omitempty"`            // chapter (storytelling)
	Fill            string     `xml:"fill,attr,omitempty"`                // graphics_frame
	Image           *Image     `xml:"image"`                              // graphics_frame
	NavAction       *NavAction `xml:"link"`                               // button
	MenuAction      string     `xml:"menu_action,omitempty"`              // button
	StyleStr        string     `xml:"style,attr,omitempty"`               // button
	Appearance      string     `xml:"appearance,attr,omitempty"`          // button,text_box
	LockText        bool       `xml:"lock_text,attr,omitempty"`           // text_box
	Content         string     `xml:",chardata"`                          // text_box
	Children        []*Display `xml:",any,omitempty"`                     // button,popup,lamp,container
}

Display represents a visual entity in a view, such as a stock, flow, button or graph.

type EntRef 

type EntRef struct {
	Name    string `xml:"name,attr,omitempty"`
	Content string `xml:",chardata"`
}

type Exister 

type Exister string

Exister is used as a pointer when we want to make sure an empty tag exists.

type File 

type File struct {
	XMLName    xml.Name     `xml:"http://www.systemdynamics.org/XMILE xmile"`
	Version    string       `xml:"version,attr"`
	Level      int          `xml:"level,attr"`
	Header     Header       `xml:"header"`
	SimSpec    SimSpec      `xml:"sim_specs"`
	Dimensions []*Dimension `xml:"dimensions>dim,omitempty"`
	ModelUnits *ModelUnits  `xml:"model_units"`
	Behavior   *Behavior    `xml:"behavior"`
	Models     []*Model     `xml:"model"`
}

File represents the entire contents of a XMILE document.

func NewFile 

func NewFile(level int, name string) *File

NewFile returns a new File object of the given XMILE compliance level and name, along with a new UUID.

Example 
package main

import (
	"encoding/xml"
	"github.com/bpowers/go-xmile/xmile"
	"log"
	"os"
)

func main() {
	m := &xmile.Model{
		Variables: []*xmile.Variable{
			&xmile.Variable{
				XMLName: xml.Name{Local: "flow"},
				Name:    "migrations",
				Eqn:     "10",
				Units:   "people/year",
			},
			&xmile.Variable{
				XMLName:  xml.Name{Local: "stock"},
				Name:     "population",
				Eqn:      "100",
				Inflows:  []string{"births", "migrations"},
				Outflows: []string{"deaths"},
				Units:    "people",
			},
		},
		Views: []*xmile.View{},
	}

	f := xmile.NewFile(1, "hello xworld")
	f.Header.UUID = "7a435517-ce5d-c816-9ec5-b34e44ec4fee"
	f.Models = append(f.Models, m)
	f.SimSpec.TimeUnits = "year"

	output, err := xml.MarshalIndent(f, "", "    ")
	if err != nil {
		log.Fatalf("xml.MarshalIndent: %s", err)
	}

	os.Stdout.Write([]byte(xmile.XMLDeclaration + "\n"))
	os.Stdout.Write(output)
	os.Stdout.Write([]byte("\n"))

}

Output:

<?xml version="1.0" encoding="utf-8" ?>
<xmile xmlns="http://www.systemdynamics.org/XMILE" version="1.0" level="1">
    <header>
        <name>hello xworld</name>
        <uuid>7a435517-ce5d-c816-9ec5-b34e44ec4fee</uuid>
        <vendor>XMILE TC</vendor>
        <product version="0.1" lang="en">go-xmile</product>
    </header>
    <sim_specs time_units="year">
        <start>0</start>
        <stop>0</stop>
        <dt>0</dt>
    </sim_specs>
    <model>
        <variables>
            <flow name="migrations">
                <eqn>10</eqn>
                <units>people/year</units>
            </flow>
            <stock name="population">
                <eqn>100</eqn>
                <inflow>births</inflow>
                <inflow>migrations</inflow>
                <outflow>deaths</outflow>
                <units>people</units>
            </stock>
        </variables>
    </model>
</xmile>

type GF 

type GF struct {
	XMLName  xml.Name `xml:"gf"`
	Discrete bool     `xml:"discrete,attr"`
	XPoints  string   `xml:"xpts,omitempty"`
	YPoints  string   `xml:"ypts"`
	XScale   Scale    `xml:"xscale"`
	YScale   Scale    `xml:"yscale"`
}

GF contains the definition of a graphical function associated with a variable.

type Graph 

type Graph struct {
	Type            string  `xml:"type,attr"`
	Title           string  `xml:"title,attr"`
	Background      string  `xml:"background,attr"`
	ShowGrid        bool    `xml:"show_grid,attr"`
	NumbersOnPlots  bool    `xml:"numbers_on_plots,attr"`
	UseFiveSegments bool    `xml:"use_five_segments,attr"`   // BUG(bp) isee ns
	DateTime        int     `xml:"date_time,attr,omitempty"` // BUG(bp) isee ns
	Cleared         string  `xml:"cleared,attr"`
	TimePrecision   int     `xml:"time_precision,attr"`
	From            string  `xml:"from,attr,omitempty"` // x-axis/time
	To              string  `xml:"to,attr,omitempty"`   // x-axis/time
	Plots           *[]Plot `xml:"plot"`
}
type Header struct {
	Smile   *Smile  `xml:"smile"`
	Name    string  `xml:"name"`
	UUID    string  `xml:"uuid"`
	Vendor  string  `xml:"vendor"`
	Product Product `xml:"product"`
}

Header contains metadata about a given XMILE File.

type Image 

type Image struct {
	XMLName xml.Name `xml:"image"`
	Size
	Data string `xml:",chardata"`
}

type Model 

type Model struct {
	XMLName   xml.Name    `xml:"model"`
	Name      string      `xml:"name,attr,omitempty"`
	Variables []*Variable `xml:"variables>variable"`
	Views     *[]*View    `xml:"views>view"`
}

Model represents a container for both the computational definition of a system dynamics model, as well as the visual representations of that model.

type ModelUnits 

type ModelUnits struct {
}
type NavAction struct {
	Target string `xml:"target,attr"`
	Point
	Link string `xml:",innerxml"`
}

type Node 

type Node interface {
	// contains filtered or unexported methods
}

An XML node

type Pages 

type Pages struct {
	Show     bool `xml:"show,attr"`
	RowCount int  `xml:"row_count,attr"`
	ColCount int  `xml:"column_count,attr"`
	HomePage int  `xml:"home_page,attr"`
	Size
}

FIXME: maybe isee specific?

type Plot 

type Plot struct {
	PenWidth  int    `xml:"pen_width,attr"` // graph/plot
	Precision int    `xml:"precision,attr"` // graph/plot,lamp
	Index     int    `xml:"index"`
	Color     string `xml:"color"`
	ShowYAxis bool   `xml:"show_y_axis"`
	Scale     *Scale `xml:"scale"`
	Entity    EntRef `xml:"entity"`
}

type Point 

type Point struct {
	X float64 `xml:"x,attr,omitempty"`
	Y float64 `xml:"y,attr,omitempty"`
}

Point represents a position in a 2D plane

type Product 

type Product struct {
	Name    string `xml:",chardata"`
	Version string `xml:"version,attr"`
	Lang    string `xml:"lang,attr,omitempty"`
}

Product contains information about the software that created this XMILE document.

type Rect 

type Rect struct {
	Point
	Size
}

Rect is an area with a position.

type Scale 

type Scale struct {
	Min float64 `xml:"min,attr"`
	Max float64 `xml:"max,attr"`
}

type Security 

type Security struct {
	XMLName xml.Name
}

TODO(bp) implement and document

type SimSpec 

type SimSpec struct {
	TimeUnits string  `xml:"time_units,attr,omitempty"`
	Start     float64 `xml:"start"`
	Stop      float64 `xml:"stop"`
	DT        float64 `xml:"dt"`
	SaveStep  string  `xml:"save_step,omitempty"`
	Method    string  `xml:"method,omitempty"`
}

SimSpec defines the time parameters a given model should be simulated with, or the defaults for all models defined in a given file.

type Size 

type Size struct {
	Width  float64 `xml:"width,attr,omitempty"`
	Height float64 `xml:"height,attr,omitempty"`
}

Size represents an area on a 2D plane

type Smile 

type Smile struct {
	Version       string   `xml:"version,attr,omitempty"`
	UsesArrays    int      `xml:"uses_arrays,omitempty"`
	UsesQueue     *Exister `xml:"uses_queue"`
	UsesConveyer  *Exister `xml:"uses_conveyer"`
	UsesSubmodels *Exister `xml:"uses_submodels"`
}

Smile contains information on the features used in this model.

type Style 

type Style struct {
	Parent      *Style `xml:"-"` // for the style cascade
	Background  string `xml:"background,attr,omitempty"`
	Color       string `xml:"color,attr,omitempty"`
	FontFamily  string `xml:"font-family,attr,omitempty"`
	FontSize    string `xml:"font-size,attr,omitempty"`
	FontStyle   string `xml:"font-style,attr,omitempty"`
	FontWeight  string `xml:"font-weight,attr,omitempty"`
	TextAlign   string `xml:"text-align,attr,omitempty"`
	TextDeco    string `xml:"text-decoration,attr,omitempty"`
	Margin      string `xml:"margin,attr,omitempty"`
	Padding     string `xml:"padding,attr,omitempty"`
	BorderColor string `xml:"border-color,attr,omitempty"`
	BorderStyle string `xml:"border-style,attr,omitempty"`
	BorderWidth string `xml:"border-width,attr,omitempty"` // BUG(bp) <double>?
}

Style contains information about the visual appearance of a display entity.

type Variable 

type Variable struct {
	XMLName  xml.Name
	Name     string     `xml:"name,attr"`
	Doc      string     `xml:"doc,omitempty"`
	Eqn      string     `xml:"eqn,omitempty"`
	NonNeg   *Exister   `xml:"non_negative"`      // stock,(uni-)flow
	Inflows  []string   `xml:"inflow,omitempty"`  // empty for non-stocks
	Outflows []string   `xml:"outflow,omitempty"` // empty for non-stocks
	Units    string     `xml:"units,omitempty"`
	GF       *GF        `xml:"gf"` // nil if one doesn't exist
	Params   []*Connect `xml:",any,omitempty"`
}

Variable is the definition of a model entity. Some fields, such as Inflows and Outflows are only applicable for certain variable types. The type is determined by the tag name and is stored in XMLName.Name.

type View 

type View struct {
	XMLName         xml.Name
	Name            string     `xml:"name,attr,omitempty"`
	SimDelay        float64    `xml:"simulation_delay,omitempty"`
	Pages           *Pages     `xml:"pages"`
	Ents            []*Display `xml:",any,omitempty"`
	ScrollX         float64    `xml:"scroll_x,attr"`
	ScrollY         float64    `xml:"scroll_y,attr"`
	Zoom            float64    `xml:"zoom,attr"`
	PageWidth       int        `xml:"page_width,attr,omitempty"`
	PageHeight      int        `xml:"page_height,attr,omitempty"`
	PageRows        int        `xml:"page_rows,attr,omitempty"`
	PageCols        int        `xml:"page_cols,attr,omitempty"`
	PageSequence    string     `xml:"page_sequence,attr,omitempty"`
	ReportFlows     string     `xml:"report_flows,attr,omitempty"`
	ShowPages       bool       `xml:"show_pages,attr,omitempty"` // BUG(bp) default (omitted) when true
	ShowValsOnHover bool       `xml:"show_values_on_hover,attr,omitempty"`
	ConverterSize   string     `xml:"converter_size,attr,omitempty"`
}

View is a collection of objects representing the visual structure of a model, such as a stock and flow diagram, a causal loop diagram, or the iThink interface layer.

type Window 

type Window struct {
	XMLName xml.Name
	Size
	Orientation string `xml:"orientation,attr,omitempty"`
}

type Zone 

type Zone struct {
	Type  string  `xml:"type,attr"`
	Color string  `xml:"color,attr"`
	Min   float64 `xml:"min"`
	Max   float64 `xml:"max"`
}

Notes

Bugs

  • default (omitted) when true

  • <double>?

  • should this be an int?

  • isee ns

  • isee ns

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.