Usage

In this section, you will find information on the following subjects:

Buildsets. You can switch between a Debug and a Release buildset.
Create RXF libraries. You can use the CreateRXFLibrary project which comes with your product.
Deployer. You must deploy or manually add Rhapsody generated code, some configuration files and dimensioning sources to your IDE.
Properties. Each product comes with a property file specific for its environment.
Profiles. Each product comes with one or more profiles.
Dimensioning. You can finetune the size of various buffer pools, so these resources match your running application. You can use highwater marks to verify the usage of these resources.
Memory Management. You can use static or dynamic allocated memory and here you will find details on how to do so.
Interrupts. You can send events from within an Interrupt Service Routine via the CGEN_ISR macro but this also effects the implementation needed of your critical region handlers.
Timing. You want to use timeouts in your Rhapsody model, and the duration on your hardware should match the timeouts specified.
Memory Section Management. You can exactly define where data- and code symbols are allocated, using Memory Section Management. The source code of the RXF is independant of a particular toolchain, and here you will read how to map toolchain specific pragmas to section macros used in all sources, including those generated by Rhapsody.
RTOS Support. If you are using a RXF with an RTOS, here is how the RTOS resources are used and these can be configured.
Versions. Depending on the version of Rhapsody, your toolchain or your RTOS some code in the RXF is disabled or enabled.
Error handler. When an error is detected by the RXF, a function called RiCErrorHandler() is called. By default, it is implemented as an endless loop - we do not know what is feasible for your application, so here you will find detailed information on the error codes and how to use your own error handler.
Frequently Asked Questions.

Buildsets

It is very likely that you want to distinguish between optimzed production code, and code you want to debug. For this, your product supports two buildsets, as defined in the property C_CG::<your environment>:::BuildCommandSet:

Debug. In this buildset, the property C_CG::<your environment>::CppCompileDebug is used. The default value is -D_DEBUG -DWST_HIGHWATERMARKS, unless it is overridden via a profile which comes with the release of your product.

Release. In this buildset, the property C_CG::<your environment>::CppCompileRelease is used. The default value is -DNDEBUG, unless it is overridden via a profile which comes with the release of your product.

Depending on your buildset, the propety CppCompileDebug or the property CppCompileRelease is added to the property C_CG::<your environment>::CppCompileSwitches. These resulting CppCompileSwitches should include -D<macro definition> options only. The reason for this, is that you build your application in your IDE: that is where you specify for example include paths and other options.
The options or macros set via the property CppCompileSwitches result in #defines in a generated RxfConstants.h when you select Code | Build or Code | Rebuild in Rhapsody.

NOTE

The options or constants set via CppCompileSwitches must match the options in your IDE project CreateRXFLibrary to create RXF libraries. You should not compile the libraries with for example support for UML ports, or use highwatermarks in a debug version, and use different options to compile your application with.

Properties

The following properties are set for C_CG::<your Environment (name of composer plus version number)>:

AddtionalreservedWords - reserved for future use
BuildCommandSet is an enumeration which correspond to the buildsets supported: Debug and Release. A Debug buildset automatically sets the proper tool options to allow source level debugging. Also, the constant WST_HIGHWATERMARKS is by default set to support highwater marks, which enables you to trim the footprint of your application.
CppCompileCommand will echo a string stating you must build inside your IDE.
CppCompileDebug. The default value is -D_DEBUG -DWST_HIGHWATERMARKS, unless it is overridden via a profile which comes with the release of your product.
CppCompileRelease is used. The default value is -DNDEBUG, unless it is overridden via a profile which comes with the release of your product.
CppCompileSwitches. This property contains values independent on the buildset (Debug or Release), and the CppCompileDebug or CppCompileDebug contents is apended to it by Rhapsody when generating RxfConstants.h
These resulting CppCompileSwitches should include -D<macro definition> options only: if you need other options you should specify these in your IDE. The default value of CppCompileSwitches is -DWST_RXF_V5 -DWST_RIC_VERSION $(OMCPPCompileCommandSet)
DependancyRule - reserved for future use
EntryPoint which is set to WST_RXF_Main, which function will be generated by Rhapsody and called from main() in WST_RXF_Main.c
ErrorMessageTokensFormat - reserved for future use
FileDependancies - reserved for future use
GeneratedAllDependancyRule - reserved for future use
HasInterfaceDLL - reserved for future use
IDEInterfaceDLL - reserved for future use
ImpExtension is set to .c for C based products and .cpp for C++ based products
Include is set to !INCLUDE because we are using Borland make thus using Borland syntax for include makefiles
InvokeExecutable which is set to RhapsodyRun.bat which will launch the Deployer or display a message to manually add files to your build environment or IDE
InvokeMake which will generate the files RxfConstants.h, RxfDimensions.h and WSTMemoryTypes.h
IsFilenameShort is set to False
LibExtension - reserved for future use
LinkDebug is left empty: linking is done inside your IDE.
LinkRelease: ibed.
LinkSwitches: ibed.
MakefileContent is used by Rhapsody to generate a makefile which builds:

the batchfile RhapsodyRun.bat to launch the Deployer via WSTDeployer.bat (if the Deployer is available in your product / adaptation),
a makefile <your Rhapsody component>.mak which will generate the files RxfConstants.h, RxfDimensions.h and WSTMemoryTypes.h
This makefile is executed using Borland make via the batchfile RhapsodyMake.bat

ObjectCleanCommand is left empty: all building is done within your IDE
ObjectName is left empty: all building is done within your IDE
ObjectsDirectory is left empty: all building is done within your IDE
OSFileSystemCaseSensitive is set to False for Windows, but may be overwritten via a profile for a Linux RTOS bridge.
ParseErrorMessage - reserved for future use
QuoteOMROOT is set to True. This Rhapsody path may contain spaces.
SpecExtension is set to .h for C based products and .hpp for C++ based products
UseRemoteHost is set to True
WSTTimeOutIncrementSize
WSTReleasePath. The name of your product (name of composer plus version number) used as directory underneath <your Rhapsody>\Share\WST_RXF_V5

Profiles

We use a profile for two reasons:

to set properties which may be outside for C_CG::<your Environment (name of composer plus version number)>. If such a 'global' property is set in a property file, each and every project using that property file would have that value for that property even when using a different environment!
to set properties for typical use of the RXF: using a RXF with an RTOS.

Please refer to the section on Profiles for your product.