Enums

Enumerations are important in the CopperLan SDK because they contain most of the predefined values, arranged in different enum definitions depending on their aim.

All enums are declared in the CPNS::Enums class .

There is a strong relationship between the enum name and its associated values. Value's names are always prefixed with uppercase letters taken from the enum name. In some cases (when there are too few uppercase characters available) the prefix is chosen to refer to the enum name in a safe way.

Examples:

• CPNS::Enums::DeviceCapabilities has values DC_Performance, DC_Hidden,...
• CPNS::Enums::DuplicateModes has values DM_Fixed, DM_Auto
• CPNS::Enums::GlobalTimerNotificationFlags has values GTNF_None, GTNF_5s,...
• CPNS::Enums::Modifiers has values MOD_FootControl, MOD_Pan, MOD_LFOSpeed,...

A special class exists allowing a combination of enum values to be passed as an argument without converting them into a number format, such as to keep an explicit naming.

For example, the following argument :

IN CPNS::CombinedDeviceCapabilities const devCaps

accepts the following value:

CPNS::Enums::DC_Performance | CPNS::Enums:: DC_HasNonVolatileMemory

meaning that the passed value is a OR combination of both values.