The following table lists the predefined keyword variables used in IBM® Rational® Rhapsody®.
| Keywords | Where Used | Description |
|---|---|---|
|
|
The file name (including the full path) of the archive that you selected in the Connect to Archive window. This name can be either a file or a directory. |
|
|
The directory part of $archive. If $archive is a directory, $archive and $archiveddirectory are the same. |
|
|
The arguments of the operation. |
|
|
The description of the event or operation argument , used by the DescriptionTemplate property. |
|
|
The object of an operation on attributes. The qualifier :c capitalizes the name of the attribute. |
|
|
The name of the reactive object. |
|
|
The command executed to check configuration items out of the archive using the main Configuration Items window. |
|
|
The name of the ATL class. |
|
|
The list of class files used in a build. |
|
|
The name of the container used to hold relations. Typical containers are arrays, lists, stacks, heaps, and maps. |
|
|
The name of the coclass that exposes the COM interface. |
|
|
The date of code generation. This information is printed in the headers and footers of generated files. |
|
|
The name of the component, |
|
|
The name of the component that caused the code to be generated. This information is printed in the headers and footers of generated files. |
|
|
The name of the configuration that caused the generation of the model element found in a file. This information is printed in headers and footers of generated files. |
|
|
The data member. |
|
|
The declaration modifier. |
|
|
The element description, used by the DescriptionTemplate property. |
|
|
The argument direction (in, out, and so on), used by the DescriptionTemplate property. |
|
|
The name of the duplicate interface. |
|
|
The path to the executable binary file generated by the Rational Rhapsody code generator. |
|
|
The name of the file used:
|
|
Framework: start method | Used to specify whether the OMMainThread singleton event loop runs on the application main thread or in a separate thread. |
|
|
The full path name of the file. This information is printed in headers and footers of generated files. |
|
|
The full name of the file used:
|
|
|
The full name of a model element in <package>::<class> format. is printed in headers and footers of generated files. For example, Radar::Engine, for a class named Engine found in a package named Radar. |
|
|
The full path of the element (P1::P2::C.a) used by the DescriptionTemplate property. |
|
|
The identifier. |
|
|
The interface ID of a COM interface. |
|
|
An index used to randomly access items in a container. |
|
Property: CORBA::TAO::InitialInstance | Refers to the default initial instance of the TAO ORB. |
|
|
The name of the interface. |
|
Property: CORBA::Class::IDLSequence | Represents the name of the CORBA interface with the string Seq added to the end of the term. |
|
|
A class or instance whose behaviors are implemented by a container. Rational Rhapsody generates various add, remove, find, and get operations to manipulate items in containers. |
|
|
The name of the iterator used to traverse a container. |
|
|
The name of a key used to access items in maps. A key is typically a string that maps to a dictionary that is used to locate items. |
|
|
An optional revision label of a configuration item, provided in the Check In/Check Out window. |
|
|
An optional comment provided in the Check In window. |
|
|
The user-specified comment for the CM operation. |
|
|
The login name of the user who generated the file. This information is printed in headers and footers of generated files. |
|
|
The name of the makefile generated by the Rational Rhapsody code generator. |
|
|
Depending on the option selected in the Code menu, this selection
expands to one of the following operations:
|
|
|
The name of the reactive member (equivalent to the base class) of the object. |
|
|
The name of the user object (the value of the Me property). The member and mePtr objects are not equivalent if the user object is active. |
|
|
A flag indicating the locking mode provided in the Check In/Check Out window. If the item is locked, $mode is replaced with the contents of the CM property ReadWrite. If unlocked, $mode is replaced with the contents of the ReadOnly property. |
|
|
The locking mode of the CM operation. For example, you can check out a file from an archive as either locked or unlocked. |
|
|
The element name, used by the DescriptionTemplate property. |
|
|
The number of arguments for the operation. |
|
|
The list of files to be included in the executable. |
|
|
The dependency rule of a specific source file (A.cpp: A.h B.h C.idl). |
|
Makefiles | The compiler switches for Debug versus Release mode, as specified in the Settings window for the active configuration. |
|
Makefiles | The list of delete commands for each object file in the makefile. Each entry in the list is created from the value of the ObjCleanCommand property. |
|
|
Specifies that the COM application
to be linked is a windows application rather than a console application.
This keyword is resolved based on the value of the <lang>_CG:: <Environment>::COM property. |
|
|
The compiler switches specified by the CompileSwitches property for a configuration. |
|
|
The link switches of the configuration, set in the Settings tab for the configuration. |
|
|
The list of dependencies and the compilation command for each model file that is built as part of the component. Each entry is made up of the value of the DependencyRule property followed by the value of the CPPCompileCommand property. |
|
|
The set of generated macros, including:
For more information, see MakeFileContent. |
|
|
The compilation switches related to the CPPCompileDebug/CPPCompileRelease properties. The property to be used is based on the value of the BuildCommandSet property. Set the value of BuildCommandSet using the configuration Settings tab in the browser. |
|
|
The compile switches needed to create a Debug version of a component in a given environment, as specified by the CPPCompileDebug property. |
|
Makefiles | The compile switches needed to create a Release version of a component in a given environment, as specified by the CPPCompileRelease property. |
|
Makefiles | This is used in the CPPCompileCommand property
to bring in additional GUI-defined settings. The content is generated
by Rational Rhapsody (either
based on content of fields or based on internal rules). It is one of the predefined keywords including, but not limited to:
|
|
Makefiles | Supports the default specification/implementation source directory
feature. To set a default directory for a configuration,
set the <lang>_CG:: |
|
Makefiles | The extension of the definition file (.def). This keyword applies to the MicrosoftDLL/COM environments. |
|
Makefiles | The extension of the dynamic linked library file (.dll). This keyword applies to the MicrosoftDLL/COM environments. |
|
|
The extension of the compiled executable. |
|
|
Used as part of a source file dependency line. It is a calculated list of files on which the source file depends. |
|
|
The relative name and path of the implementation file. It is used in a source file dependency and compilation commands. |
|
|
The relative path and name of an object file that is related to a given implementation and specification files. It is used as part of a file compilation command. |
|
|
The relative path and name of a specification file. It is used in a source file dependency line. |
|
Makefiles | Maintained for backwards compatibility. |
|
|
The list of all #includes done in the related implementation file. It is used as part of a source file dependency line. |
|
|
The extension of an implementation file generated for a model element. |
|
|
The include path. The path is calculated from dependencies between components and from the Include Path setting in the active component/configuration feature window. |
|
|
The active configuration instrumentation mode (None, Tracing, or Animation). |
|
|
Represents the preprocessor directives required for the selected type of instrumentation: animation, tracing, or none. |
|
|
Represents the libraries required for the selected type of instrumentation: animation, tracing, or none. |
|
|
The extension of library files. |
|
|
The names of additional libraries (besides the framework library) to link when building a component. It is calculated from dependencies between components and the Libraries list in the active component/configuration feature windows. |
|
|
Represents the suffix to use for library names. The keyword is replaced by the value of the DebugLibSuffix property or the ReleaseLibSuffix property depending upon the build. |
|
|
The link switches related to the LinkDebug/LinkRelease properties. The property to be used is based on the value of the BuildCommandSet property. Set the value of BuildCommandSet using the configuration Settings tab in the browser. |
|
|
The environment-specific link switches used to build a Debug version of a component. This switch is the value of the LinkDebug property. |
|
|
The value of the LinkRelease property. |
|
|
The main file name and path: [<imp
dir>/]$TARGET_ |
|
|
The name of the makefile. |
|
|
The library component the model depends on. For example, if executable component A depends on the library component L, this keyword is replaced with the string <filepath>\L.lib. |
|
|
The extension of object files (temporary compiler files) for a given environment. This is the value of the ObjExtension property. |
|
|
The list of object files to link into the build by the makefile. |
|
|
A calculated keyword based on the <lang>_CG:: <Environment>:: ObjectsDirectory property). |
|
|
The location of the \Share subdirectory in the Rational Rhapsody installation. This is set in your rhapsody.ini file. |
|
|
Links the COM application with the DLL version of the framework
instead of the default static libraries. This keyword is resolved
based on the value of the <lang>_CG:: <Environment>:: RPFrameWorkDll property. |
|
Maintained for backwards compatibility. | |
|
|
(Rational Rhapsody in J) Lists the source (*.java) files used in a build. |
|
|
The extension of the specification file generated for a model element. |
|
|
Lists all the #includes done in the related specification file. |
|
|
The type of program for the Microsoft linker (for example, windows). |
|
|
The name of the file that contains the main() function for an executable component. |
|
|
The name of the compiled version of a component. |
|
|
The type of component to be built (library or executable), |
|
|
The time model setting for a configuration (simulated or real time). |
|
INTEGRITY build files (.gpj) | Represents the content of the Include Path field found on the Settings tab of the Features window for configurations. This content is included in generated .gpj files for environments that use such files, for example, INTEGRITY5. |
|
|
The list of operations. |
|
ATL | The name of the operation. |
|
ATL | The return type of the operation. |
|
ATL | The name of the package. |
|
ATL | The package library. |
|
ATL | The value of the ProgID property (Default = $component.$class.1). |
|
|
The project name. |
|
|
The value of the element property with the specified name (under C or CPP_CG::CG:: <metatype>). This keyword is used by the DescriptionTemplate property. |
|
|
Specifies whether the COM server needs to register its type library. Automatically expands to TRUE/FALSE depending upon COM ATL server includes type library. |
|
|
The current version of Rational Rhapsody, not including the build number. This information is printed in headers and footers of generated files. |
|
|
The path to the _rpy directory, which consists of the project repository. The repository contains all the configuration items for a project. |
|
|
The operation signature, used by the DescriptionTemplate property. |
|
|
In the code generated by Rational Rhapsody for checking whether an application is in a given state, this keyword is replaced by the state name. |
|
|
The target of an operation on relations. This is generally
the role name. For example, in a class with a relation called myServer, the role name myServer would replace the variable $target when expanding properties that involve that relation. The value add$target:c would become: addMyServer() The qualifier :c capitalizes the role name. |
|
|
The other end of the association, used by the DescriptionTemplate property. |
|
|
The target directory. |
|
|
The value of the ThreadingModel property (Default = Apartment). |
|
|
The full path of the COM type library file. |
|
|
The name of the type. For example, if you create a type named MyType and set its in property to "const $type&", the generation of an in argument is as follows: "const MyType& <argname>" |
|
|
The argument type, used by the DescriptionTemplate property. |
|
|
The value of the TypeName property, which specifies the declaration of the class type being registered (Default = $class). |
|
|
Unit of collaboration. This is the name of the file that corresponds to the configuration item (package, configuration, or diagram) on which a CM command operates. If more than one unit is provided, the command is performed repeatedly in a for each loop. |
|
|
Replaced with the value of the VersionIndepProgID property (Default = $component.$class). |
|
|
The name of the virtual function table for the object, specified by the ReactiveVtblName property. |
The following table lists the predefined Rational Rhapsody macros used in the framework files and makefiles.
| Macro | Description |
|---|---|
|
The command to build a library. |
|
The flags used to build a library. |
|
Environment-specific copy command. |
|
Environment-specific extension for C++ implementation files (for example, .cpp). |
|
Expands to the DLL link command that initiates the DLL link phase of a build |
|
Expands to the switches applied to the DLL link command |
|
Environment-specific extension for C++ implementation files (for example, .h). |
|
The qualifier used in a given environment to designate an include file in the compiler or link switches. |
|
The command to build a library. |
|
Environment-specific extension for library files (for example, .lib). |
|
The flags used to build a library. |
|
The name of a library. |
|
The postfix added between the main file name and the extension.
The possible values are as follows:
This macro is not used for DLLs. |
|
The prefix added to the beginning of a file name. For example,
the prefix "Vx" is added to VxWorks libraries. This macro is not used for DLLs. |
|
Expands to the link command that initiates the link phase of a build |
|
Expands to the link switches applied to the link command |
|
The environment-specific extension for object files (for example, .o or .obj). |
|
The intermediate object files to be built (for example, aombrk.obj). |
|
The environment-specific extension for PDB debug files (for example, .pdb). |
|
The environment-specific remove command for deleting files. |
|
The environment-specific remove command for deleting directories. This is used in the clean rules when you set the <lang>_CG::<Environment>::ObjectsDirectory property. |