next up previous contents
Next: Creating a Bank Up: Bank Classes Previous: Bank Classes

Bank Class Naming Conventions

Specific Bank classes are labelled by their bank name, as is the associated header filename. The LRID bank, for instance, is encapsulated by the class LRID_Bank which is defined in the file LRID_Bank.hh. If any compiled source code were required to implement the LRID bank class, then it would go into a file named LRID_Bank.cc.

Many bank class implementors will choose to use a significant number of constants to be describe the data layout. These should be put into a file named XXXX_Bank_format.hh for bank class XXXX_Bank and included near the top of the XXXX_Bank.hh class header. LRID_Bank, for instance, has many bitfields defined in its data members which are described in LRID_Bank_format.hh.

Banks with names containing non-alphanumeric characters, such as `$', are an exception to this naming convention. Some legal bank Trybos bank names with non-alphanumeric characters cannot be used as a legal C++ class names. Also, RCS cannot now handle the `$' character at the beginning of a filename. If a character in the bank name is non-alphanumeric, the common name for that character is spelled out with the first character capitalized. The bank class and header filename associated with the $TRK bank, for example, are written as ``DollarTRK_Bank'' and ``DollarTRK_Bank.hh'' respectively. The only other non-alphanumeric character currently treated is +, which is replaced by the name ``Plus''.



Robert Kennedy
Mon Jul 28 13:23:28 CDT 1997