DCSimpleParameter

class DCSimpleParameter

Bases: DCParameter

This is the most fundamental kind of parameter type: a single number or string, one of the DCSubatomicType elements. It may also optionally have a divisor, which is meaningful only for the numeric type elements (and represents a fixed-point numeric convention).

Inheritance diagram

int get_divisor(void) const

Returns the divisor associated with this type. This is 1 by default, but if this is other than one it represents the scale to apply when packing and unpacking numeric values (to store fixed-point values in an integer field). It is only meaningful for numeric-type fields.

double get_modulus(void) const

Returns the modulus associated with this type, if any. It is an error to call this if has_modulus() returned false.

If present, this is the modulus that is used to constrain the numeric value of the field before it is packed (and range-checked).

DCSubatomicType get_type(void) const

Returns the particular subatomic type represented by this instance.

bool has_modulus(void) const

Returns true if there is a modulus associated, false otherwise.,