Naming Conventions

A strict set of naming rules has been adopted for use with NuGraf which greatly aid in the recognition of an identifier name as either a function, datatype or constant.

All NuGraf-related identifiers begin with the letter 'N'. The next letter indicates whether the identifier is a function, abstract datatype or a constant. This is then followed by an underscore and the identifier label. The label itself begins with an uppercase letter and can have underscores in it. Each letter after an underscore should be capitalized. The following table lists all of the naming conventions currently in use.

As a recommended programming practice, all variables names (that are related to NuGraf usage) should be prefixed with 'Nv_'.

 

Prefix	Example	Explanation
Na_	Na_RED	Array offset constant
Nc_	Nc_TRUE	Predefined constant
Nd_	Nd_Float	Abstract data type
NG_	NG_CWD	Environment variable name
Ni_()	Ni_Camera()	A NuGraf-interface command function
Nm_()	Nm_MAX()	Macro definition
Nt_	Nt_WIREFRAME	A NuGraf-interface token
Nv_	Nv_Error_Name	A NuGraf-related variable