PearlYMLTool

Joseph E Coffland

05 April 2006

Version 1.5.0

PearlYMLTool - A general tool for extracting information from YML files for ymlpearl(1).

Table of Contents

• Syntax
• Description
• Options
• Examples
• Authors
• See Also

Syntax

Description

PearlYMLTool is part of the SESAME software system. More information can be found on the web at http://sesamesim.sourceforge.net/.

PearlYMLTool is used in project Makefiles in order to extract build information from YML files. It is also used by YMLEditor(1) to create template classes.

PearlYMLTool was created with XmlPL, the XML Processing Language.

Options

--classes architecture.yml

Print the names of each class referenced in the provided YML file.

--sources architecture.yml

Print the source files referenced in the provided YML file.

--create-node-template path

Creates default header (.ps) and implementation (.pi) files for a ymlpearl node.

--create-stub architecture.yml

Generates a stub (.ps) file for ymlpearl which includes all the the necessary classes for the supplied simulation. Subsequently passing this generated file to ymlpearl will build the supplied architecture simulation.

--help

Print command line help.

Examples

  # Print architecture classes
  PearlYMLTool --classes architecture.yml

  # Create architecture stub and build the simulation
  touch mysim.pi
  PearlYMLTool --create-stub architecture.yml >mysim.ps
  ymlpearl mysim

  # See the MJPEG case-study Makefiles for more examples.

Authors

See Also