XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace BatteryML:2.0
Version 1.0
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • urn:oasis:names:tc:unitsml:schema:xsd:UnitsMLSchema-1.0 (at UnitsML-v1.0-csd03.xsd)
  • This schema includes components from the following schema document(s):
    • common_basic_data_types.xsd

Declared Namespaces

Prefix Namespace
Default namespace BatteryML:2.0
xml http://www.w3.org/XML/1998/namespace
unitsml urn:oasis:names:tc:unitsml:schema:xsd:UnitsMLSchema-1.0
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="BatteryML:2.0" elementFormDefault="qualified" attributeFormDefault="unqualified" version="1.0">
<xsd:import schemaLocation="UnitsML-v1.0-csd03.xsd" namespace="urn:oasis:names:tc:unitsml:schema:xsd:UnitsMLSchema-1.0"/>
<xsd:include schemaLocation="common_basic_data_types.xsd"/>
...
</xsd:schema>
top

Global Declarations

Element: Category

Name Category
Type CategoryType
Nillable no
Abstract no
Documentation Category element.
XML Instance Representation
<Category
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<Parameters> ... </Parameters> [0..1]
<PropertyType> ... </PropertyType> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</Category>
Schema Component Representation
<xsd:element name="Category" type="CategoryType"/>
top

Element: CategorySet

Name CategorySet
Type CategorySetType
Nillable no
Abstract no
Documentation Container for category and category set.
XML Instance Representation
<CategorySet
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<!--
Uniqueness Constraint - NameIdKey-2
Selector - ./*
Field(s) - @id
-->

<Category> ... </Category> [0..*]
<CategorySet> ... </CategorySet> [0..*]
<PropertyType> ... </PropertyType> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</CategorySet>
Schema Component Representation
<xsd:element name="CategorySet" type="CategorySetType">
<xsd:unique name="NameIdKey-2">
<xsd:selector xpath="./*"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: Definition

Name Definition
Type DefinitionType
Nillable no
Abstract no
Documentation Definition element.
XML Instance Representation
<Definition>
<Parameters> ... </Parameters> [0..1]
Start Choice [0..*]
<Category> ... </Category> [0..*]
<CategorySet> ... </CategorySet> [0..*]
End Choice
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Definition>
Schema Component Representation
<xsd:element name="Definition" type="DefinitionType"/>
top

Element: Function

Name Function
Type FunctionType
Nillable no
Abstract no
Documentation Basic function type.
XML Instance Representation
<Function
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<NParameters> NonNegativeIntType </NParameters> [1]
<NVariables> NonNegativeIntType </NVariables> [1]
<Parameters> ... </Parameters> [1]
<Variables> ... </Variables> [1]
<FunctionType> ... </FunctionType> [1]
Start Choice [1]
<unitsml:UnitsML> ... </unitsml:UnitsML> [0..1]
<CAEBAT_Unit> UnitsType </CAEBAT_Unit> [0..1]
<Unit> ShortStringType </Unit> [0..1]
End Choice
<Mathform> ShortStringType </Mathform> [0..1]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Function>
Schema Component Representation
<xsd:element name="Function" type="FunctionType"/>
top

Element: FunctionType

Name FunctionType
Type FunctionTypeType
Nillable no
Abstract no
Documentation Function type container. Will be expanded.
XML Instance Representation
<FunctionType> FunctionTypeType </FunctionType>
Schema Component Representation
<xsd:element name="FunctionType" type="FunctionTypeType"/>
top

Element: Functions

Name Functions
Type FunctionsType
Nillable no
Abstract no
Documentation Container for Function entries with enforced uniqueness on id-s
XML Instance Representation
<Functions>
<!--
Uniqueness Constraint - FunctionIdKey
Selector - ./*
Field(s) - @id
-->

<Function> FunctionType </Function> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Functions>
Schema Component Representation
<xsd:element name="Functions" type="FunctionsType">
<xsd:unique name="FunctionIdKey">
<xsd:selector xpath="./*"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: Index

Name Index
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Index associated to data in the container.
XML Instance Representation
<Index
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
count="NonNegativeIntType [0..1]">
Start Choice [1]
<Start> IndexIntType </Start> [0..1]
<End> IndexIntType </End> [0..1]
<Increment> PositiveIntType </Increment> [0..1]
<IntegerList> IndexIntListType </IntegerList> [1]
<NameList> IndexNameListType </NameList> [1]
<Encoded> Encoded64Type </Encoded> [1]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Index>
Schema Component Representation
<xsd:element name="Index">
<xsd:complexType>
<xsd:sequence>
<xsd:choice>
<xsd:group ref="IndexIntBoundsGroup"/>
<xsd:element name="IntegerList" type="IndexIntListType"/>
<xsd:element name="NameList" type="IndexNameListType"/>
<xsd:element name="Encoded" type="Encoded64Type"/>
<-- <xsd:element ref="Index"/> -->
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
<xsd:attributeGroup ref="OptionalCountGroup"/>
</xsd:complexType>
</xsd:element>
top

Element: Map

Name Map
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Generic map element with attribute keys (name, id) for enforcing uniqueness. To be restricted.
XML Instance Representation
<Map
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
count="NonNegativeIntType [0..1]">
<!--
Uniqueness Constraint - NameIdKey
Selector - Item
Field(s) - @id
-->

<Item> MapItemType </Item> [0..*]
</Map>
Schema Component Representation
<xsd:element name="Map">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="Item" type="MapItemType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
<xsd:attributeGroup ref="OptionalCountGroup"/>
</xsd:complexType>
<xsd:unique name="NameIdKey">
<xsd:selector xpath="Item"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: NamedParametersML_Doc

Name NamedParametersML_Doc
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Container used for testing consistency of the XSD schema. The element is not used in the actual XML instance documents.
XML Instance Representation
<NamedParametersML_Doc>
Allow any elements from this schema's namespace (strict validation). [0..*]
</NamedParametersML_Doc>
Schema Component Representation
<xsd:element name="NamedParametersML_Doc">
<xsd:complexType>
<xsd:sequence>
<xsd:any namespace="##targetNamespace" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: Parameter

Name Parameter
Type ParameterType
Nillable no
Abstract no
Documentation Basic Name/Value pair.
XML Instance Representation
<Parameter
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
Start Choice [1]
<Scalar> AnySingleValueType </Scalar> [1]
<List> AnySingleListValueType </List> [1]
<Sequence> AnyValueType </Sequence> [1]
<Vector> ... </Vector> [1]
<Map> ... </Map> [1]
<Index> ... </Index> [1]
<Function> ... </Function> [1]
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
End Choice
Start Choice [1]
<unitsml:UnitsML> ... </unitsml:UnitsML> [0..1]
<CAEBAT_Unit> UnitsType </CAEBAT_Unit> [0..1]
<Unit> ShortStringType </Unit> [0..1]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Parameter>
Schema Component Representation
<xsd:element name="Parameter" type="ParameterType"/>
top

Element: ParameterSet

Name ParameterSet
Type ParameterSetType
Nillable no
Abstract no
Documentation Basic container for Name/Value pairs set.
XML Instance Representation
<ParameterSet
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<!--
Uniqueness Constraint - NameIdKey-1
Selector - ./*
Field(s) - @id
-->

Start Choice [0..*]
<Parameter> ... </Parameter> [0..*]
<ParameterSet> ... </ParameterSet> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</ParameterSet>
Schema Component Representation
<xsd:element name="ParameterSet" type="ParameterSetType">
<xsd:unique name="NameIdKey-1">
<xsd:selector xpath="./*"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: Parameters

Name Parameters
Type ParametersType
Nillable no
Abstract no
Documentation Container for Parameter and ParameterSet entries with enforced uniqueness on id-s
XML Instance Representation
<Parameters>
<!--
Uniqueness Constraint - ParameterIdKey
Selector - ./*
Field(s) - @id
-->

Start Choice [0..*]
<ParameterSet> ParameterSetType </ParameterSet> [0..*]
<Parameter> ParameterType </Parameter> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Parameters>
Schema Component Representation
<xsd:element name="Parameters" type="ParametersType">
<xsd:unique name="ParameterIdKey">
<xsd:selector xpath="./*"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: PropertyType

Name PropertyType
Type PropertyTypeType
Nillable no
Abstract no
Documentation Property type container.
XML Instance Representation
<PropertyType> PropertyTypeType </PropertyType>
Schema Component Representation
<xsd:element name="PropertyType" type="PropertyTypeType"/>
top

Element: Variables

Name Variables
Type VariablesType
Nillable no
Abstract no
Documentation Container for Variable and VariableSet entries with enforced uniqueness on id-s
XML Instance Representation
<Variables>
<!--
Uniqueness Constraint - VariableIdKey
Selector - ./*
Field(s) - @id
-->

Start Choice [0..*]
<VariableSet> ParameterSetType </VariableSet> [0..*]
<Variable> ParameterType </Variable> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</Variables>
Schema Component Representation
<xsd:element name="Variables" type="VariablesType">
<xsd:unique name="VariableIdKey">
<xsd:selector xpath="./*"/>
<xsd:field xpath="@id"/>
</xsd:unique>
</xsd:element>
top

Element: Vector

Name Vector
Type VectorType
Nillable no
Abstract no
Documentation Generic vector element. To be restricted.
XML Instance Representation
<Vector
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
count="NonNegativeIntType [0..1]">
Allow any elements from any namespace (lax validation). [0..*]
</Vector>
Schema Component Representation
<xsd:element name="Vector" type="VectorType"/>
top

Global Definitions

Attribute Group: IndexGroup

Name IndexGroup
Documentation Start and end index for the set of values.
XML Instance Representation
start="IndexIntType [0..1] ?"
end="IndexIntType [0..1] ?"
increment="PositiveIntType [0..1] ?"
Schema Component Representation
<xsd:attributeGroup name="IndexGroup">
<xsd:attribute name="start" type="IndexIntType" use="optional"/>
<xsd:attribute name="end" type="IndexIntType" use="optional"/>
<xsd:attribute name="increment" type="PositiveIntType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: LengthGroup

Name LengthGroup
Documentation Number of elements in the list container.
XML Instance Representation
length="NonNegativeIntType [0..1]"
Schema Component Representation
<xsd:attributeGroup name="LengthGroup">
<xsd:attribute name="length" type="NonNegativeIntType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: OptionalCountGroup

Name OptionalCountGroup
Documentation Number of elements in the container at the element root level.
XML Instance Representation
count="NonNegativeIntType [0..1]"
Schema Component Representation
<xsd:attributeGroup name="OptionalCountGroup">
<xsd:attribute name="count" type="NonNegativeIntType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: OptionalIdGroup

Name OptionalIdGroup
Documentation Id attribute. No spaces. Optional attribute.
XML Instance Representation
id="ShortNameType [0..1]"
Schema Component Representation
<xsd:attributeGroup name="OptionalIdGroup">
<xsd:attribute name="id" type="ShortNameType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: OptionalNameGroup

Name OptionalNameGroup
Documentation Name attribute group. Optional attribute.
XML Instance Representation
name="ShortTokenType [0..1]"
Schema Component Representation
<xsd:attributeGroup name="OptionalNameGroup">
<xsd:attribute name="name" type="ShortTokenType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: OptionalTypeGroup

Name OptionalTypeGroup
Documentation Type attribute. Optional attribute.
XML Instance Representation
type="ShortTokenType [0..1]"
Schema Component Representation
<xsd:attributeGroup name="OptionalTypeGroup">
<xsd:attribute name="type" type="ShortTokenType" use="optional"/>
</xsd:attributeGroup>
top

Attribute Group: RequiredIdGroup

Name RequiredIdGroup
Documentation Id attribute. No spaces. Required attribute.
XML Instance Representation
id="ShortNameType [1]"
Schema Component Representation
<xsd:attributeGroup name="RequiredIdGroup">
<xsd:attribute name="id" type="ShortNameType" use="required"/>
</xsd:attributeGroup>
top

Attribute Group: RequiredNameGroup

Name RequiredNameGroup
Documentation Name attribute group. Required attribute.
XML Instance Representation
name="ShortTokenType [1]"
Schema Component Representation
<xsd:attributeGroup name="RequiredNameGroup">
<xsd:attribute name="name" type="ShortTokenType" use="required"/>
</xsd:attributeGroup>
top

Attribute Group: RequiredTypeGroup

Name RequiredTypeGroup
Documentation Type attribute. Required attribute.
XML Instance Representation
type="ShortTokenType [1]"
Schema Component Representation
<xsd:attributeGroup name="RequiredTypeGroup">
<xsd:attribute name="type" type="ShortTokenType" use="required"/>
</xsd:attributeGroup>
top

Complex Type: AnyCategoryType

Super-types: None
Sub-types: None
Name AnyCategoryType
Abstract no
Documentation Container for any category set.
XML Instance Representation
<...>
Start Choice [0..*]
<Category> ... </Category> [0..*]
<CategorySet> ... </CategorySet> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>
Schema Component Representation
<xsd:complexType name="AnyCategoryType">
<xsd:sequence>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="Category" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CategorySet" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: CategoryNoIdType

Super-types: None
Sub-types: None
Name CategoryNoIdType
Abstract no
Documentation Category element type without id attribute.
XML Instance Representation
<...
name="ShortTokenType [0..1]">
<Parameters> ... </Parameters> [0..1]
<PropertyType> ... </PropertyType> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>
Schema Component Representation
<xsd:complexType name="CategoryNoIdType">
<xsd:sequence>
<xsd:element ref="Parameters" minOccurs="0"/>
<xsd:element ref="PropertyType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
</xsd:complexType>
top

Complex Type: CategorySetType

Super-types: None
Sub-types: None
Name CategorySetType
Abstract no
Documentation Type for container for category set.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<Category> ... </Category> [0..*]
<CategorySet> ... </CategorySet> [0..*]
<PropertyType> ... </PropertyType> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="CategorySetType">
<xsd:sequence>
<xsd:element ref="Category" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CategorySet" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="PropertyType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
</xsd:complexType>
top

Complex Type: CategoryType

Super-types: None
Sub-types: None
Name CategoryType
Abstract no
Documentation Category element type.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<Parameters> ... </Parameters> [0..1]
<PropertyType> ... </PropertyType> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
</...>
Schema Component Representation
<xsd:complexType name="CategoryType">
<xsd:sequence>
<xsd:element ref="Parameters" minOccurs="0"/>
<xsd:element ref="PropertyType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
</xsd:complexType>
top

Complex Type: DefinitionType

Super-types: None
Sub-types: None
Name DefinitionType
Abstract no
Documentation Main model definition container type.
XML Instance Representation
<...>
<Parameters> ... </Parameters> [0..1]
Start Choice [0..*]
<Category> ... </Category> [0..*]
<CategorySet> ... </CategorySet> [0..*]
End Choice
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="DefinitionType">
<xsd:sequence>
<xsd:element ref="Parameters" minOccurs="0"/>
<-- <xsd:element ref="NamedParameter" minOccurs="0"/> -->
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="Category" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="CategorySet" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: FunctionType

Super-types: None
Sub-types: None
Name FunctionType
Abstract no
Documentation Basic function type
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
<NParameters> NonNegativeIntType </NParameters> [1]
<NVariables> NonNegativeIntType </NVariables> [1]
<Parameters> ... </Parameters> [1]
<Variables> ... </Variables> [1]
<FunctionType> ... </FunctionType> [1]
Start Choice [1]
<unitsml:UnitsML> ... </unitsml:UnitsML> [0..1]
<CAEBAT_Unit> UnitsType </CAEBAT_Unit> [0..1]
<Unit> ShortStringType </Unit> [0..1]
End Choice
<Mathform> ShortStringType </Mathform> [0..1]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="FunctionType">
<xsd:sequence>
<xsd:element name="NParameters" type="NonNegativeIntType"/>
<xsd:element name="NVariables" type="NonNegativeIntType"/>
<xsd:element ref="Parameters"/>
<xsd:element ref="Variables"/>
<xsd:element ref="FunctionType"/>
<xsd:choice>
<xsd:element ref="unitsml:UnitsML" minOccurs="0"/>
<xsd:element name="CAEBAT_Unit" type="UnitsType" minOccurs="0"/>
<xsd:element name="Unit" type="ShortStringType" minOccurs="0"/>
</xsd:choice>
<xsd:element name="Mathform" type="ShortStringType" minOccurs="0"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
</xsd:complexType>
top

Complex Type: FunctionsType

Super-types: None
Sub-types: None
Name FunctionsType
Abstract no
XML Instance Representation
<...>
<Function> FunctionType </Function> [0..*]
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="FunctionsType">
<xsd:sequence>
<xsd:element name="Function" type="FunctionType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: MapItemType

Super-types: None
Sub-types: None
Name MapItemType
Abstract no
Documentation Generic map item element type with attribute keys (name, id) for uniqueness. To be restricted.
XML Instance Representation
<...
name="ShortTokenType [1]"
id="ShortNameType [1]"
count="NonNegativeIntType [0..1]">
Allow any elements from any namespace (lax validation). [0..*]
</...>
Schema Component Representation
<xsd:complexType name="MapItemType">
<xsd:sequence>
<xsd:any namespace="##any" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
<xsd:attributeGroup ref="RequiredNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
<xsd:attributeGroup ref="OptionalCountGroup"/>
</xsd:complexType>
top

Complex Type: MapType

Super-types: None
Sub-types: None
Name MapType
Abstract no
Documentation Generic map element type with attribute keys (name, id) for uniqueness. To be restricted.
XML Instance Representation
<...>
<Map> ... </Map> [1]
</...>
Schema Component Representation
<xsd:complexType name="MapType">
<xsd:sequence>
<xsd:element ref="Map"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: ParameterSetType

Super-types: None
Sub-types: None
Name ParameterSetType
Abstract no
Documentation Type for basic container for Name/Value pairs.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
Start Choice [0..*]
<Parameter> ... </Parameter> [0..*]
<ParameterSet> ... </ParameterSet> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="ParameterSetType">
<xsd:sequence>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="Parameter" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="ParameterSet" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
</xsd:complexType>
top

Complex Type: ParameterType

Super-types: None
Sub-types: None
Name ParameterType
Abstract no
Documentation Basic Name/Value pair type
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]">
Start Choice [1]
<Scalar> AnySingleValueType </Scalar> [1]
<List> AnySingleListValueType </List> [1]
<Sequence> AnyValueType </Sequence> [1]
<Vector> ... </Vector> [1]
<Map> ... </Map> [1]
<Index> ... </Index> [1]
<Function> ... </Function> [1]
Allow any elements from a namespace other than this schema's namespace (lax validation). [0..*]
End Choice
Start Choice [1]
<unitsml:UnitsML> ... </unitsml:UnitsML> [0..1]
<CAEBAT_Unit> UnitsType </CAEBAT_Unit> [0..1]
<Unit> ShortStringType </Unit> [0..1]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="ParameterType">
<xsd:sequence>
<xsd:choice>
<xsd:element name="Scalar" type="AnySingleValueType"/>
<xsd:element name="List" type="AnySingleListValueType"/>
<xsd:element name="Sequence" type="AnyValueType"/>
<xsd:element ref="Vector"/>
<xsd:element ref="Map"/>
<xsd:element ref="Index"/>
<xsd:element ref="Function"/>
<xsd:any namespace="##other" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:choice>
<xsd:choice>
<xsd:element ref="unitsml:UnitsML" minOccurs="0"/>
<xsd:element name="CAEBAT_Unit" type="UnitsType" minOccurs="0"/>
<xsd:element name="Unit" type="ShortStringType" minOccurs="0"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
</xsd:complexType>
top

Complex Type: ParametersType

Super-types: None
Sub-types: None
Name ParametersType
Abstract no
XML Instance Representation
<...>
Start Choice [0..*]
<ParameterSet> ParameterSetType </ParameterSet> [0..*]
<Parameter> ParameterType </Parameter> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="ParametersType">
<xsd:sequence>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="ParameterSet" type="ParameterSetType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Parameter" type="ParameterType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: VariablesType

Super-types: None
Sub-types: None
Name VariablesType
Abstract no
XML Instance Representation
<...>
Start Choice [0..*]
<VariableSet> ParameterSetType </VariableSet> [0..*]
<Variable> ParameterType </Variable> [0..*]
End Choice
Start Group: ElementInfoGroup [0..1]
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
End Group: ElementInfoGroup
</...>
Schema Component Representation
<xsd:complexType name="VariablesType">
<xsd:sequence>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element name="VariableSet" type="ParameterSetType" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="Variable" type="ParameterType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:choice>
<xsd:group ref="ElementInfoGroup" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: VectorType

Super-types: None
Sub-types: None
Name VectorType
Abstract no
Documentation Type for generic vector element. To be restricted.
XML Instance Representation
<...
name="ShortTokenType [0..1]"
id="ShortNameType [1]"
count="NonNegativeIntType [0..1]">
Allow any elements from any namespace (lax validation). [0..*]
</...>
Schema Component Representation
<xsd:complexType name="VectorType">
<xsd:sequence>
<xsd:any namespace="##any" minOccurs="0" maxOccurs="unbounded" processContents="lax"/>
</xsd:sequence>
<xsd:attributeGroup ref="OptionalNameGroup"/>
<xsd:attributeGroup ref="RequiredIdGroup"/>
<xsd:attributeGroup ref="OptionalCountGroup"/>
</xsd:complexType>
top

Model Group: ElementInfoGroup

Name ElementInfoGroup
Documentation Description of elements in the parent element container.
XML Instance Representation
<Description> StringType </Description> [0..1]
<Comment> StringType </Comment> [0..1]
<Documentation> EmbeddedXMLType </Documentation> [0..1]
Schema Component Representation
<xsd:group name="ElementInfoGroup">
<xsd:sequence>
<xsd:element name="Description" type="StringType" minOccurs="0"/>
<xsd:element name="Comment" type="StringType" minOccurs="0"/>
<xsd:element name="Documentation" type="EmbeddedXMLType" minOccurs="0"/>
</xsd:sequence>
</xsd:group>
top

Model Group: IndexIntBoundsGroup

Name IndexIntBoundsGroup
Documentation Integer index for auto-incrementation.
XML Instance Representation
<Start> IndexIntType </Start> [0..1]
<End> IndexIntType </End> [0..1]
<Increment> PositiveIntType </Increment> [0..1]
Schema Component Representation
<xsd:group name="IndexIntBoundsGroup">
<xsd:sequence>
<xsd:element name="Start" type="IndexIntType" minOccurs="0"/>
<xsd:element name="End" type="IndexIntType" minOccurs="0"/>
<xsd:element name="Increment" type="PositiveIntType" minOccurs="0"/>
</xsd:sequence>
</xsd:group>
top

Simple Type: FunctionTypeType

Super-types: ShortTokenType < FunctionTypeType (by restriction)
Sub-types: None
Name FunctionTypeType
Content
  • 'ShortTokenType' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'Polynomial'|'Polynomial_Exponential'|'Product'|'Quotient'|'Sum'|'Subtraction'|'Butler_Volmer_Kinetics'|'Linear Kinetics'|'Arrhenius'|'FunctionOther'}
Documentation Function type group. Single choice.
Schema Component Representation
<xsd:simpleType name="FunctionTypeType">
<xsd:restriction base="ShortTokenType">
<xsd:enumeration value="Polynomial"/>
<xsd:enumeration value="Polynomial_Exponential"/>
<xsd:enumeration value="Product"/>
<xsd:enumeration value="Quotient"/>
<xsd:enumeration value="Sum"/>
<xsd:enumeration value="Subtraction"/>
<xsd:enumeration value="Butler_Volmer_Kinetics"/>
<xsd:enumeration value="Linear Kinetics"/>
<xsd:enumeration value="Arrhenius"/>
<xsd:enumeration value="FunctionOther"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: IndexIntListType

Super-types: None
Sub-types: None
Name IndexIntListType
Content
  • List of:
    • Locally defined type:
      • 'Int64Type' super type was not found in this schema. Its facets could not be printed out.
Documentation Index as list integer value.
Schema Component Representation
<xsd:simpleType name="IndexIntListType">
<xsd:list>
<xsd:simpleType>
<xsd:restriction base="IndexIntType"/>
</xsd:simpleType>
</xsd:list>
</xsd:simpleType>
top

Simple Type: IndexIntType

Super-types: Int64Type < IndexIntType (by restriction)
Sub-types: None
Name IndexIntType
Content
  • 'Int64Type' super type was not found in this schema. Its facets could not be printed out.
Documentation Index as integer value (64 bits, signed). Used for indexing the data types.
Schema Component Representation
<xsd:simpleType name="IndexIntType">
<xsd:restriction base="Int64Type"/>
</xsd:simpleType>
top

Simple Type: IndexNameListType

Super-types: None
Sub-types: None
Name IndexNameListType
Content
  • List of:
    • Locally defined type:
      • 'ShortNameType' super type was not found in this schema. Its facets could not be printed out.
Documentation Index as list integer value.
Schema Component Representation
<xsd:simpleType name="IndexNameListType">
<xsd:list>
<xsd:simpleType>
<xsd:restriction base="IndexNameType"/>
</xsd:simpleType>
</xsd:list>
</xsd:simpleType>
top

Simple Type: IndexNameType

Super-types: ShortNameType < IndexNameType (by restriction)
Sub-types: None
Name IndexNameType
Content
  • 'ShortNameType' super type was not found in this schema. Its facets could not be printed out.
Documentation Index as name value (no spaces).
Schema Component Representation
<xsd:simpleType name="IndexNameType">
<xsd:restriction base="ShortNameType"/>
</xsd:simpleType>
top

Simple Type: PropertyTypeType

Super-types: ShortTokenType < PropertyTypeType (by restriction)
Sub-types: None
Name PropertyTypeType
Content
  • 'ShortTokenType' super type was not found in this schema. Its facets could not be printed out.
  • value comes from list: {'Composition'|'Physical'|'Chemical'|'Electrical'|'Interfacial'|'Bulk'|'Surface'|'Line'|'Point'|'Thermodynamics'|'Kinetics'|'Transport'|'Thermal'|'Mechanical'|'Geometrical'|'Cost'|'Coupling'|'PropertyOther'}
Documentation Property type group. Single choice.
Schema Component Representation
<xsd:simpleType name="PropertyTypeType">
<xsd:restriction base="ShortTokenType">
<xsd:enumeration value="Composition"/>
<xsd:enumeration value="Physical"/>
<xsd:enumeration value="Chemical"/>
<xsd:enumeration value="Electrical"/>
<xsd:enumeration value="Interfacial"/>
<xsd:enumeration value="Bulk"/>
<xsd:enumeration value="Surface"/>
<xsd:enumeration value="Line"/>
<xsd:enumeration value="Point"/>
<xsd:enumeration value="Thermodynamics"/>
<xsd:enumeration value="Kinetics"/>
<xsd:enumeration value="Transport"/>
<xsd:enumeration value="Thermal"/>
<xsd:enumeration value="Mechanical"/>
<xsd:enumeration value="Geometrical"/>
<xsd:enumeration value="Cost"/>
<xsd:enumeration value="Coupling"/>
<xsd:enumeration value="PropertyOther"/>
</xsd:restriction>
</xsd:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia">
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice[1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1]?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top