Installation

The installation of a RXF by Willert Software Tools requires you to already have installed a modelling tool like Rhapsody, a toolchain and an RTOS (if any). A release of a RXF always comes with an installer, which may ask you some paths. Since each RXF is installed in a separate directory, there is no need to make a backup of a previous installation.

To see what is exactly in your product, please click here for further details.

Prerequisuites

Before you can install your product, please make sure the following prerequisuites are met:

Rhapsody in C or C++ (depending on your product) by IBM Rational
a toolchain which includes a C or C++ compiler (depending on your product) and debugger
an RTOS (depending on your product)
several non-demo versions of our products: an IDE to deploy or manually add the generated files to. Usually it comes with your toolchain. If you want to use a different IDE, your product must support it, or you must implement the interface to your IDE yourselves.

Components and Bridges installed

The architecture of a V5 RXF shows the components and bridges which build an overall system:

The installation deals with the following components:

the OO RTX. The Object Oriented RealTime eXecution system comes in C or C++ form, and replaces the standard OXF Framework by IBM Rational.
one or more PMF's which extend the product with a shared library form of the OO RTX, an extention for a particular RTOS or Debugger (for runtime- and offline- target animation).
the Deployer which deploys Rhapsody generated source files, some configuration files, the OO RTX, optional PMF components and the bridges to your IDE environment. Note: The Deployer is not part of all products or adaptations.

The installation deals with the following bridges:

interface / configuration details for use with Rhapsody, like a property file and profile
interface implementation of your compiler
interface implementation of your target
for non-demo versions of our products: the interface implementation of your IDE used by the Deployer. Note: The IDE integration is not part of all products or adaptations.
interface implementation of your RTOS (if any)
interface implementation of your debugger (when using a e PMF for runtime- and offline- target animation).

Depending on your product, some parts of a Board Support Package may be installed too.

To see what components and bridges are exactly part of a release, please refer to your product details. Each release contains a Bill Of Materials, BOM.txt, which contains an overview of all files installed. For each file its Subversion Revision and its originating component or bridge is specified.

Each product installation also includes the files:

WST_Product.h, which defines constants for your product
WSTProlog.h and WSTEpilog.h which allows you to hook details in, as these are part of a generic interface.
WST_RXF_Main.c which is the main EntryPoint of your application.
This source contains main() and a call to WST_RXF_Main(), generated by Rhapsody.
WSTMemoryTypePragmas.txt.example which serves as an example for an implementation of WSTMemoryTypePragmas.txt if that file is left empty to speed the compilation process. Please refer to the exact files installed for your compiler.
WSTMemoryTypeMacro.template which is used to generate a WSTMemoryTypes.h used in Memory Section Management.
WSTMemoryTypes.h although this file is normally generated.
The reason is that you need a CreateRXFLibrary project to create RXF libraries, but the sources used include WSTMemoryTypes.h so we provide a default one. (You do need to take care of recreating your libraries when WSTMemoryTypes.h changes, see Memory Section Management.)
RxfConstants.h although this file is normally generated.
The reason is that you need a CreateRXFLibrary project to create RXF libraries, but the sources used include RxfConstants.h so we provide a default one.
the property file WST_RXF_V5.prp
the profile <your product>.sbs which depends on your compiler and RTOS if any.
the batchfile RhapsodyRun.bat. In demo versions of our products it will launch the IDE after the build. In non-demo versions of our products it will launch the Deployer or ask you to manually include the generated files into your build enviroment or IDE.

Version Number

The Version 5 products are installed in a way which is different from earlier versions. In <your Rhapsody>\Share directory, there will be a directory created called WST_RXF_V5, where each product is installed in a directory which name is composed of:

the name of a composer.
a version number. The version number is build up as V5.XrY where X is a number which is incremented when there are functional changes with respect to version X-1, and Y is a fix number which is incremented due to bugfixes.

The same detailed product name (so including exact version number) is used for the Environment which you can select in Rhapsody, and installed in a separate directory under the WST_RXF_V5 directory. This enables you to use different products and even versions next to each other.

Directory Structure

The Version 5 products are installed in <your Rhapsody>\Share\WST_RXF_V5\<your product> using the same directory structure for each product:

Config, with the subdirectories
- Profile(s) for all profiles released with the product
- Properties with a product specific property file
- MemorySections for use of Memory Section Management in your application, including the Framework code.
Doc with the subdirectories
- Books which contains Release Notes and Getting Started
- Help which contains all Help files in HTML and Windows Help format.
Samples with the subdirectory
- Code for example projects for your IDE (for non-demo versions of our products).
- Model for example projects for Rhapsody.
Source which contains all source files of your product for non-demo versions of our products. The demo versions of our products contain only the sources needed to compile an application and use a RXF library which is part of a demo-release.
Tools which contain all tools which come with your product, needed to generate configuration files inside Rhapsody. For several non-demo versions of our products these include tools to deploy all files to your IDE environment.