Rules and Standards

Checklist for CAA V5 C++ Naming Rules

Standard name checklist for public CAA V5 C++ entities

Authorized Characters and Name Length

Entity name	Automatic Test Tool	Results
Authorized Characters	mkchecksource (deactivated in 5.5)
Name length	mkchecksource (deactivated in 5.5)

Entities Associated with a Directory

Note: CAT can be replaced by other valid prefixes (such as CAA, VPM, ENOV, and DNB) in the patterns below.

Entity Name	Entity Nature	Directory Naming Rule	Automatic Test Tool	Results
Code Framework	Physical grouping of classes, interfaces, macros, functions dedicated to some specific task or domain.	CAT<FWName>	mkchecksource (deactivated in 5.5)
Test Framework	Physical grouping of classes, interfaces, macros, functions dedicated to some specific task or domain.	CAT<FWName>.tst	mkchecksource (deactivated in 5.5)
CAA Frameworks	Special kinds of frameworks that contain sample code and documentation that is intended for delivery to final customer as CAA products	CAA<FWName>.edu CAA<FWName>Doc.edu CAA<FWName>.tst	no
Code Module	Physical grouping of interrelated objects within a framework, which defines the unit of code loading into main memory.	CAT<FWAlias><ModuleName>.m	mkchecksource (deactivated in 5.5)
Code Module (in test FW)	Physical grouping of interrelated objects within a framework, which defines the unit of code loading into main memory. Used for testing the code delivered by a FW	CAT<FWAlias><Tst><ModuleName>.m	no
Code main module	Utility code module, unique to a FW, that act as the union of all the FW's modules when link editing other FWs modules.	CAT<FWName><number>.m	no
Doc Module in CAA Fws	Logical grouping of related documents about a CAA framework.	CAA<FWAlias>TechArticles.doc CAA<FWAlias>UseCase.doc CAA<FWAlias>QuickRefs.doc CAA<FWAlias>Base.doc	.no

Entities Associated with a File

Entity Name	Entity Nature	Entity and File Naming Rule	Automatic Test Tool	Results
Simple Classes	Standard C++ objects.	Class: CAT<FWAlias><ClassName> File: CAT<FWAlias><ClassName>.h File: CAT<FWAlias><ClassName>.cpp	mkchecksource except fwalias(deactivated in 5.5)
Extension Classes	Special implementation classes that extent another class or a late type.	Class: CATE<FWAlias><ClassName> File: CATE<FWAlias><ClassName>.h File: CATE<FWAlias><ClassName>.cpp	mkchecksource except fwalias(deactivated in 5.5)
Interfaces	Object Modeler special classes that model an abstract behavior that many classes may implement.	Interface :CATI<FWAlias><InterfaceName> File: CATI<FWAlias><InterfaceName>.h File: CATI<FWAlias><InterfaceName>.cpp	mkchecksource except fwalias(deactivated in 5.5)
Automation Interfaces	Special type of interfaces that allows CATIA programmation from scripting environments.	Interface: CATIA<FWAlias><InterfaceName> File: CATIA<FWAlias><InterfaceName>.idl File: CATIA<FWAlias><InterfaceName>.h File: CATIA<FWAlias><InterfaceName>.cpp	mkchecksource except fwalias et idl (deactivated in 5.5)
Interface Dictionaries	File containing a correspondence table between implementation classes or late types and the interfaces they implement.	File: CAT<FWName>.dico for CAA customers File: CAT<FWName>.dic for DS	mkcheckarchi
Factory Dictionaries	File containing a correspondence table between a class, and the factory interface that creates it.	File: CAT<FWName>.fact	no
Global Functions and Variables	C++ functions defined outside any class	Function/variable: CAT<FWAlias><FunctionName> File: CAT<FWAlias><FunctionName>.h File: CAT<FWAlias><FunctionName>.cpp	no
Global Enumerated Types	Programmer-defined type with value limited to a predefined list of named items.	Type: CAT<FWAlias><EnumName> Value: Cat<FWAlias><EnumItemName> File: CAT<FWAlias><EnumName>.h	no
Macros	Piece of C++ code that is referenced by name is some other code and expanded by compiler at buildl time.	Macro: CAT<FWAlias><MacroName> File: CAT<FWAlias><MacroName>.h	no
Typedef	C++ alias that defines a name as a substitute for another name	Same as substituted name	no
NLS resources	File containing texts used as resources by code, and subject to translation in foreign language	File: CAT<FWAlias>Name.CATNls	no
Resource catalogs	Files containing non translatable resources	File: CAT<FWAlias>Name.CATRsc	no
Icon files	File containing the graphical definition of an icon.	File: CAT<FWAlias><IconName>.<ext>	no
Feature catalogs	File containing predefined feature definitions.	File: CAT<FWAlias><CatalogName>.CATFct for CAA customers File: CAT<FWAlias><CatalogName>.feat for DS	no

User Interface Entities

Entity Name	Entity Nature	Naming Rule	Automatic Test Tool	Results
Command Header	Proxy for a command in the application frame	CAT<FWAlias><Name>Hdr	no
Workshop	Set of workbenches associated with a document	CAT<FWAlias><Name>Wks	.no	.
Workbench	A grouping of process-related commands	CAT<FWAlias><Name>Wkb	no
Toolbar	A (sub) grouping of related commands	CAT<FWAlias><Name>Tlb	no
Command Starter	A command starter	CAT<FWAlias><Name>Str	no
Separator	A separator between two commands in a menu or a toolbar	CAT<FWAlias><Name>Sep	no
Icon Box	A grouping of icons	CAT<FWAlias><Name>Icb	no
MenuBar	A list of menu accessors	CAT<FWAlias><Name>Mbr	no
Menu	A list of command accessible by name	CAT<FWAlias><Name>Mnu	no
SubMenu	A (sub) list of command accessible by name	CAT<FWAlias><Name>Snu	no

Other Entities

Entity Name	Entity Nature	Naming Rule	Automatic Test Tool	Results
Features and Late Types	Name that federates a number of interfaces as characteristic of a type.	CAT<FWAlias><FeatureName> CAT<FWAlias><LateTypeName>	no
Data Members	Data associated to a class.	_<DataName>	no
Method or Function Arguments	Arguments in function and method signatures.	Use: The i prefix for input parameters The o prefix for output parameters The io prefix for input/output parameters	mkchecksource (deactivated in 5.5)

History

Version: 1.0 [Sep 2000]	Document created
[Top]

Copyright © 2000, Dassault Systèmes. All rights reserved.