預先定義的關鍵字變數

下表列出在 IBM® Rational® Rhapsody® 中使用的預先定義關鍵字變數。

表 1. 預先定義的關鍵字變數
關鍵字 使用位置 說明
$archive
ConfigurationManagement
您在「連接以保存」視窗中所選之保存檔的檔名(包括完整路徑)。 此名稱可以是檔案或目錄。
$archiveddirectory
ConfigurationManagement
$archive 的目錄部分。如果 $archive 是目錄,則 $archive$archiveddirectory 相同。
$arguments
ATL
作業的引數。
$Arguments
<lang>_CG
DescriptionTemplate 內容所使用之事件或作業引數的說明。
$attribute
CG
屬性上作業的物件。

限定元 :c 會將屬性名稱大寫。

$base
<lang>_CG
回應物件的名稱。
$CheckOut
ConfigurationManagement
使用主要「配置項目」視窗,檢查保存檔中配置項目所執行的指令。
$class
ATL
ATL 類別的名稱。
$ClassClean
Make 檔
在建置中使用之類別檔的清單。
$cname
CG, <Container Types>, 
<lang>_CG
用於保留關係的儲存器名稱。一般儲存器有陣列、清單、堆疊、資料堆及對映。
$coclass
ATL
公開 COM 介面的 coclass 名稱。
$CodeGeneratedDate
CG, <lang>_CG
產生程式碼的日期。此資訊會列印在所產生檔案的頁首及頁尾。
$component
ATL
元件的名稱。
$ComponentName
CG
導致產生程式碼的元件名稱。 此資訊會列印在所產生檔案的頁首及頁尾。
$ConfigurationName
CG, <lang>_CG
導致產生檔案中所找到之模型元素的配置名稱。 此資訊會列印在所產生檔案的頁首及頁尾。
$datamem
ATL
資料成員。
$DeclarationModifier
ATL
宣告修飾元。
$Description
<lang>_CG
DescriptionTemplate 內容所使用的元素說明。
$Direction
<lang>_CG
DescriptionTemplate 內容所使用的引數方向(inout 等)。
$dupinterface
ATL
重複介面的名稱。
$executable
<lang>_CG
Rational Rhapsody 程式碼產生器所產生之可執行二進位檔的路徑。
$FILENAME
CPP_CG
所使用檔案的名稱:
  • 針對個別類別,將原始碼產生至使用者指定的目錄
  • 指定在反向工程期間不匯入陳述式(保護 h 檔案免受多次併入的 #ifndef)
$Fork
架構:start 方法 用於指定 OMMainThread 單態事件迴圈是在應用程式主要執行緒上執行,還是在個別執行緒上執行。
$FullCodeGeneratedFileName
CG, <lang>_CG
檔案的完整路徑名稱。此資訊會列印在所產生檔案的頁首及頁尾。
$FULLFILENAME
CG
所用之檔案的完整名稱:
  • 針對個別類別,將原始碼產生至使用者指定的目錄
  • 指定在反向工程期間不匯入陳述式(保護 h 檔案免受多次併入的 #ifndef
$FullModelElementName
CG, <lang>_CG
<package>::<class> 格式的模型元素完整名稱。 此資訊會列印在所產生檔案的頁首及頁尾。 例如,對於在名為 Radar 的套件中找到的名為 Engine 的類別,名稱為 Radar::Engine
$FullName
<lang>_CG
DescriptionTemplate 內容所使用之元素的完整路徑 (P1::P2::C.a)
$id
ATL
ID。
$IDInterface
ATL
COM 介面的介面 ID。
$index
<Container Types>
用於隨機存取儲存器中項目的索引。
$instance
內容:CORBA::TAO::InitialInstance 參照 TAO ORB 的預設起始實例。
$interface
ATL
介面的名稱。
$interfaceSeq
內容:CORBA::Class::IDLSequence 代表 CORBA 介面的名稱,術語結尾新增字串 Seq
$item
CG, <Container Types>
其行為由儲存器實作的類別或實例。Rational Rhapsody 會產生各種 addremovefindget 作業,以操作儲存器中的項目。
$iterator
<Container Types>
反覆運算子用於遍訪儲存器的名稱。
$keyname
<Container Types>
用於存取對映中項目的索引鍵名稱。索引鍵通常是對映至用於尋找項目之目錄的字串。
$label
ConfigurationManagement
配置項目的選用修訂標籤,在「移入/移出」視窗中提供。
$log
ConfigurationManagement
在「移入」視窗中提供的選用註解。
$LogPart
ConfigurationManagement
CM 作業的使用者指定註解。
$Login
CG, <lang>_CG
產生檔案之使用者的登入名稱。此資訊會列印在所產生檔案的頁首及頁尾。
$makefile
<lang>_CG
Rational Rhapsody 程式碼產生器所產生之 make 檔的名稱。
$maketarget
<lang>_CG
根據在「程式碼」功能表中所選取選項,此選項會擴展下列其中一個作業:
  • 建置
  • 清除
  • 重建(I)
$member
<lang>_CG
物件之回應成員(相等於基本類別)的名稱。
$mePtr
<lang>_CG
使用者物件的名稱(Me 內容的值)。 如果使用者物件處於作用中,則 membermePtr 物件不相等。
$mode
ConfigurationManagement
指出鎖定模式的旗標,在「移入/移出」視窗中提供。如果已鎖定項目,則 $mode 會取代為 CM 內容 ReadWrite 的內容。如果解除鎖定,則 $mode 會取代為 ReadOnly 內容的內容。
$ModePart
ConfigurationManagement
CM 作業的鎖定模式。

例如,您可以從保存檔中移出已鎖定或解除鎖定的檔案。

$Name
<lang>_CG
DescriptionTemplate 內容所使用的元素名稱。
$noOfArgs
ATL
作業的引數數目。
$OMAdditionalObjs
Make 檔
要併入執行檔的檔案清單。
$OMAllDependencyRule
Make 檔
特定原始檔 (A.cpp: A.h B.h C.idl) 的相依關係規則。
$OMBuildSet
Make 檔 「除錯」與「釋放」模式的編譯器開關,在作用中配置的「設定」視窗中指定。
$OMCleanOBJS
Make 檔 make 檔中每個物件檔的刪除指令清單。 清單中的每個項目都是從 ObjCleanCommand 內容的值建立而來的。
$OMCOM
Make 檔
指定要鏈結的 COM 應用程式是視窗應用程式而非主控台應用程式。 根據 <lang>_CG::
<Environment>::COM
內容的值,來解析此關鍵字。
$OMConfigurationCPPCompile
交換器
Make 檔
CompileSwitches 內容所指定的配置編譯器開關。
$OMConfigurationLink
交換器
Make 檔
配置的鏈結開關,在配置的設定標籤中設定。
$OMContextDependencies
Make 檔
相依關係及每個模型檔(建置為元件的一部分)之編譯指令的清單。每一個項目都由 DependencyRule 內容值後接 CPPCompileCommand 內容值組成。
$OMContextMacros
Make 檔
一組所產生的巨集,包括:
  • OMROOT
  • CPP_EXT/C_EXT
  • H_EXT
  • OBJ_EXT
  • LIB_EXT
  • INSTRUMENTATION
  • TIME_MODEL
  • TARGET_TYPE
  • TARGET_NAME
  • "all" 規則
  • TARGET_MAIN
  • LIBS
  • INCLUDE_PATH
  • ADDITIONAL_OBJS
  • OBJS

如需相關資訊,請參閱 MakeFileContent

$OMCPPCompileCommandSet
Make 檔
CPPCompileDebug/CPPCompileRelease 內容相關的編譯開關。 要使用的內容基於 BuildCommandSet 內容的值。 使用瀏覽器中的配置設定標籤,設定 BuildCommandSet 的值。
$OMCPPCompileDebug
Make 檔
在給定環境中建立元件「除錯」版所需的編譯開關,如 CPPCompileDebug 內容所指定。
$OMCPPCompileRelease
Make 檔 在給定環境中建立元件「發行」版所需的編譯開關,如 CPPCompileRelease 內容所指定。
$OMFileCPPCompileSwitches
Make 檔 CPPCompileCommand 內容中用來提供其他 GUI 定義的設定。Rational Rhapsody 會產生內容(基於欄位的內容或基於內部規則)。

它是其中一個預先定義關鍵字,包括但不限於:

  • $OMCPPCompileDebug
  • $OMCPPCompileRelease
  • $OMLinkDebug
  • $OMLinkRelease
  • $OMBuildSet
  • $OMContextMacros
$OMDefaultSpecification
目錄
Make 檔 支援預設規格/實作來源目錄功能。

若要設定配置的預設目錄,請設定 <lang>_CG::
Configuration::
DefaultSpecification-Directory 及 <lang>_CG::
Configuration::
DefaultImplementation-Directory
內容

$OMDEFExtension
Make 檔 定義檔的副檔名 (.def)。 此關鍵字適用於 MicrosoftDLL/COM 環境。
$OMDllExtension
Make 檔 動態鏈結程式庫檔案的副檔名 (.dll)。 此關鍵字適用於 MicrosoftDLL/COM 環境。
$OMExeExt
Make 檔
已編譯執行檔的副檔名。
$OMFileDependencies
Make 檔
用作原始檔相依關係行的一部分。它是原始檔所依據之檔案的計算清單。
$OMFileImpPath
Make 檔
實作檔的相對名稱及路徑。它用在原始檔相依關係及編譯指令中。
$OMFileObjPath
Make 檔
與給定實作檔及規格檔相關之物件檔的相對路徑及名稱。 它用作檔案編譯指令的一部分。
$OMFileSpecPath
Make 檔
規格檔的相對路徑及名稱。它用在原始檔相依關係行中。
$OMFlagsFile
Make 檔 維護以實現舊版相容性。
$OMImpIncludeInElements
Make 檔
相關實作檔中完成之所有 #includes 的清單。 它用作原始檔相依關係行的一部分。
$OMImplExt
Make 檔
針對模型元素產生之實作檔的副檔名。
$OMIncludePath
Make 檔
併入路徑。該路徑從元件之間的相依關係及作用中元件/配置功能視窗中併入路徑設定來進行計算。
$OMInstrumentation
Make 檔
作用中配置設備測試模式(無、追蹤或動畫)。
$OMInstrumentationFlags
Make 檔
代表所選設備測試類型(動畫、追蹤或無)所需的前處理器指引。
$OMInstrumentationLibs
Make 檔
代表所選設備測試類型(動畫、追蹤或無)所需的程式庫。
$OMLibExt
Make 檔
程式庫檔案的副檔名。
$OMLibs
Make 檔
建置元件時鏈結的其他程式庫(除了架構程式庫之外)名稱。 該名稱從元件之間的相依關係及作用中元件/配置功能視窗中程式庫清單進行計算。
$OMLibSuffix
程式碼產生作業
代表要用於程式庫名稱的字尾。根據建置,該關鍵字由 DebugLibSuffix 內容的值或 ReleaseLibSuffix 內容的值取代。
$OMLinkCommandSet
Make 檔
LinkDebug/LinkRelease 內容相關的鏈結開關。 要使用的內容基於 BuildCommandSet 內容的值。 使用瀏覽器中的配置設定標籤,設定 BuildCommandSet 的值。
$OMLinkDebug
Make 檔
用於建置「除錯」版元件的環境特定鏈結開關。此開關是 LinkDebug 內容的值。
$OMLinkRelease
Make 檔
LinkRelease 內容的值。
$OMMainImplementationFile
Make 檔
主要檔名稱及路徑:

[<imp dir>/]$TARGET_
MAIN)$(CPP_EXT)

$OMMakefileName
Make 檔
make 檔的名稱。
$OMModelLibs
Make 檔
模型所基於的檔案庫元件。

例如,如果執行檔元件 A 依賴於檔案庫元件 L,則此關鍵字會取代為字串 <filepath>\L.lib

$OMObjExt
Make 檔
給定環境之物件檔(暫存編譯器檔案)的副檔名。 這是 ObjExtension 內容的值。
$OMObjs
Make 檔
依 make 檔,鏈結至建置的物件檔清單。
$OMObjectsDir
Make 檔
計算的關鍵字,基於 <lang>_CG::
<Environment>::
ObjectsDirectory
內容。
$OMRoot
ConfigurationManagement, 
General, <lang>_CG, 
<lang>_Roundtrip, makefiles
Rational Rhapsody 安裝中的 \Share 子目錄位置。 這在 rhapsody.ini 檔案中設定。
$OMRPFrameWorkDll
Make 檔
將 COM 應用程式與架構的 DLL 版本而非預設靜態程式庫相鏈結。 此關鍵字根據 <lang>_CG::
<Environment>::
RPFrameWorkDll
內容的值解析。
$OMRulesFile
  維護以實現舊版相容性。
$OMSourceFileList
Make 檔
(J 中的 Rational Rhapsody)列出在建置中使用的原始檔 (*.java)。
$OMSpecExt
Make 檔
針對模型元素產生之規格檔的副檔名。
$OMSpecIncludeInElements
Make 檔
列出相關規格檔中完成的所有 #includes
$OMSubSystem
Make 檔
Microsoft 鏈結器的程式類型(例如,Windows)。
$OMTargetMain
Make 檔
包含執行檔元件 main() 函數的檔案名稱。
$OMTargetName
Make 檔
元件已編譯版本的名稱。
$OMTargetType
Make 檔
要建置的元件類型(程式庫或執行檔)。
$OMTimeModel
Make 檔
配置的時間模型設定(模擬時間或即時)。
$OMUserIncludePath
INTEGRITY 建置檔 (.gpj) 代表配置「特性」視窗「設定」標籤上找到之「併入路徑」欄位的內容。 對於使用 .gpj 檔案的環境(例如,NTEGRITY5),此內容會包含在產生的 .gpj 檔案中。
$operations
ATL
作業的清單。
$opname
ATL 作業的名稱。
$opRetType
ATL 作業的傳回類型。
$package
ATL 套件的名稱。
$PackageLib
ATL 套件程式庫。
$ProgID
ATL ProgID 內容的值(預設值 = $component.$class.1)。
$projectname
ConfigurationManagement
專案名稱。
$<Property>
<lang>_CG
具有指定名稱之元素內容的值(在 CCPP_CG::CG::
<metatype>
下)。 此關鍵字由 DescriptionTemplate 內容使用。
$RegTlb
ATL
指定 COM 伺服器是否需要登錄其類型程式庫。 依據包括類型程式庫的 COM ATL 伺服器,自動展開 TRUE/FALSE。
$RhapsodyVersion
CG, <lang>_CG
Rational Rhapsody 的現行版本,不包括建置號碼。 此資訊會列印在所產生檔案的頁首及頁尾。
$rhpdirectory
ConfigurationManagement
_rpy 目錄的路徑,其包含專案儲存庫。 儲存庫包含專案的所有配置項目。
$Signature
<lang>_CG
DescriptionTemplate 內容所使用的作業簽章。
$state
Properties
CPP_CG::Framework::IsInCall
CPP_CG::Framework::IsComple
tedCall
Rational Rhapsody 產生用來檢查應用程式是否處於給定狀態的程式碼中,此關鍵字會由狀態名稱取代。
$target
<Container Types>, <lang>_CG
關係上的作業目標。此通常是角色名稱。

例如,在具有名為 myServer 關係的類別中,當擴展涉及該關係的內容時,角色名稱 myServer 會取代變數 $target。 值 add$target:c 會變為:

addMyServer()

限定元 :c 會將角色名稱大寫。

$Target
<lang>_CG
DescriptionTemplate 內容所使用之關聯的另一端。
$targetDir
ConfigurationManagement
目標目錄。
$ThreadModel
ATL
ThreadingModel 內容的值(預設值 = Apartment)。
$tlbPath
ATL
COM 類型程式庫檔案的完整路徑。
$type
CG, <lang>_CG
類型的名稱。

例如,如果您建立名為 MyType 的類型,並將其 in 內容設為 "const $type&",則 in 引數的產生會如下所示:

"const MyType& <argname>"

$Type
<lang>_CG
DescriptionTemplate 內容所使用的引數類型。
$TypeName
ATL
TypeName 內容的值,其會指定要登錄之類別類型的宣告(預設值 = $class)。
$unit
ConfigurationManagement
協同作業的單位。這是對應於配置項目(套件、配置或圖表)的檔案名稱,CM 指令會在其上進行作業。 如果提供多個單位,則指令會在 for each 迴圈中反覆地執行。
$VersionIndepProgID
ATL
取代為 VersionIndepProgID 內容的值(預設值 = $component.$class)。
$VtblName
<lang>_CG
物件之虛擬函數表格的名稱,由 ReactiveVtblName 內容指定。

下表列出用於架構檔案及 Make 檔的預先定義 Rational Rhapsody 巨集。

巨集 說明
AR
用於建置程式庫的指令。
ARFLAGS
用於建置程式庫的旗標。
CP
環境特定複製指令。
CPP_EXT
C++ 實作檔案的環境特定延伸(例如,.cpp)。
DLL_CMD
擴展至 DLL 鏈結指令,起始建置的 DLL 鏈結階段
DLL_FLAGS
擴展至適用於 DLL 鏈結指令的開關
H_EXT
C++ 實作檔案的環境特定延伸(例如,.h)。
INCLUDE_QUALIFIER
在給定環境中用來在編譯器或鏈結開關中指定併入檔的限定元。
LIB_CMD
用於建置程式庫的指令。
LIB_EXT
程式庫檔案(例如,.lib)的環境特定副檔名。
LIB_FLAGS
用於建置程式庫的旗標。
LIB_NAME
程式庫的名稱。
LIB_POSTFIX
在主要檔與副檔名之間新增的字尾。 可能的值如下:
  • 若為模擬時間,則為 sim(例如,oxfsim.lib
  • 若為設備測試,則為 inst(例如,oxfinst.lib
  • 若為模擬時間及設備測試,則為 siminst(例如,oxfsiminst.lib

此巨集不用於 DLL。

LIB_PREFIX
新增至檔名開頭的字首。例如,字首 "Vx" 會新增至 VxWorks 程式庫。

此巨集不用於 DLL。

LINK_CMD
擴展至鏈結指令,起始建置的鏈結階段
LINK_FLAGS
擴展至適用於鏈結指令的鏈結開關
OBJ_EXT
物件檔的環境特定副檔名(例如,.o.obj)。
OBJS
要建置的中間物件檔(例如,aombrk.obj)。
PDB_EXT
PDB 除錯檔案的環境特定副檔名(例如,.pdb)。
RM
環境特定移除指令,用於刪除檔案。
RMDIR
環境特定移除指令,用於刪除目錄。當您設定 <lang>_CG::<Environment>::ObjectsDirectory 內容時,用於清除規則。

意見回饋