PortML.Documents 1.1.27

About

PortML stands for Port Markup Language. It is a descriptive language or document which describes container port assets, such as yard sets, quay cranes, wharves, and AGVs, as a markup code for modelling and simulation. In the future, besides the assets, it will include events as part of the document as well.

PortML Spec

PortML document follows the PortML specification which is defined in the schema file PortML.xsd. The schema defines all of the datatypes and base infrastructure types.

The PortML is described using the following format.

<PortML xmlns="http://o2des.com/portml-namespace" (attrA="value")>
   <nameA><nameA>
   <nameB[x]></nameB>
   <nameC> 
     <nameD></nameD>
   </nameC>
 <name>

Using this format:

• To build a valid XML instance of a resource, simply replace the contents of the elements and attributes with valid content as described by the cardinality, type rules and content description found in the comment in each element;
• Elements are always in the namespace http://o2des.com/portml-namespace. This is usually specified as the default namespace on the root element;
• Element name is case-sensitive (though duplicates that differ only in case are never defined);
• Elements must always appear in the order documented;
• Elements which are not documented in this PortML Spec should not be included in the PortML document;
• Any of the XML elements may have an id attribute to serve as the target of an internal reference;
• Attributes can never be empty. Either they are absent, or they are present with at least one character of non-whitespace content;
• Implementers should trim leading and trailing whitespace before writing and SHOULD trim leading and trailing whitespace when reading attribute values;
• XML comments, processing instructions and formatting are not part of the contents of a resource;
• XML resources MUST be exchanged using UTF-8 encoding. Specifying the character encoding using a <?xml encoding="UTF-8" ?> processing instruction is not needed;
• The MIME-type for this format is application/xml.

How to Use

using (StreamReader file = new StreamReader("<path to PortML document>"))
{
    try
    {
        string portMLDocument = file.ReadToEnd();

        var parser = new PortML.Documents.PortMLParser();
        var portML = parser.Parse(portMLDocument);
        ...
    }
    catch (Exception ex)
    {
        ...
    }
}

Terminal

There will be one and only one Terminal module in the same PortML document. It is to specify the boundary of the terminal and to provide static properties which are general to the entire port system.

To retrieve the wharf information from the PortML object, use the following code.

var terminal = portML.GetTerminal();

The code above will return a list of WharfInfo object which contains the following information.

Wharf

Wharf is the side of the port terminal where vessels will be parked at.

Quay cranes will be located at the land side of the wharf while vessels will be parked at the sea side. As shown in the following diagram, the direction of the wharf, defined by StartingAt and EndingAt, is important. The wharf direction will decide which side of it is land side and which side of it is sea side.

To retrieve the wharf information from the PortML object, use the following code.

var wharfs = portML.GetAllWharfs();

The code above will return a list of WharfInfo object which contains the following information.

Yard Set

YardSet module is corresponding to the container yard in the sea port terminal.

The starting point and facing direction of a yardset is defined in the way shown in the following diagram. The Facing property defines the direction of the yardset in radian rotating around the StartingAt point.

To retrieve the wharf information from the PortML object, use the following code.

var yardSets = portML.GetAllYardSets();

The code above will return a list of YardSetInfo object which contains the following information.

Release Notes

• Introduced TerminalInfo;
• Introduced WharfInfo;
• Introduced YardSetInfo.

Feedback

Bug reports and contributions are welcome at PortML Contact Us Page.