HopRateSettings-Py

Proxy values for underlying C values from HopRateSettings. More...

Variables
	HopRate = ct.c_int
tuple	HOP_UNDEFINED = HopRate.in_dll(dll, "HOP_UNDEFINED")
	Hop rate not set yet.
tuple	HOP_45K = HopRate.in_dll(dll, "HOP_45K")
	Hop rate of 45K points/second.
tuple	HOP_30K = HopRate.in_dll(dll, "HOP_30K")
	Hop rate of 30K points/second.
tuple	HOP_15K = HopRate.in_dll(dll, "HOP_15K")
	Hop rate of 15K points/second.
tuple	HOP_7K = HopRate.in_dll(dll, "HOP_7K")
	Hop rate of 7K points/second.
tuple	HOP_3K = HopRate.in_dll(dll, "HOP_3K")
	Hop rate of 3K points/second.
tuple	HOP_2K = HopRate.in_dll(dll, "HOP_2K")
	Hop rate of 2K points/second.
tuple	HOP_1K = HopRate.in_dll(dll, "HOP_1K")
	Hop rate of 1K points/second.
tuple	HOP_550 = HopRate.in_dll(dll, "HOP_550")
	Hop rate of 550 points/second.
tuple	HOP_312 = HopRate.in_dll(dll, "HOP_312")
	Hop rate of 312 points/second.
tuple	HOP_156 = HopRate.in_dll(dll, "HOP_156")
	Hop rate of 156 points/second.
tuple	HOP_78 = HopRate.in_dll(dll, "HOP_78")
	Hop rate of 78 points/second.
tuple	HOP_39 = HopRate.in_dll(dll, "HOP_39")
	Hop rate of 39 points/second.
tuple	HOP_20 = HopRate.in_dll(dll, "HOP_20")
	Hop rate of 20 points/second.
dictionary	HopRateBOOK
	Dictionary for mapping hop-rate values to human-readable string representations of the value. More...

Detailed Description

Proxy values for underlying C values from HopRateSettings.

Values should be treated as immutable, and only used as parameters to pass into DLL cals.

While the underlying type is numeric, no assumptions can or should be made about the actual integer value, as it may change with DLL updates. Only equality operations should be assumed to be valid for any comparisons or value checks.

Note that Doxygen incorrectly identifies the type of these values as tuple, as the ctypes library does some runtime type munging that doxygen doesn't understand.

Variable Documentation

dictionary HopRateBOOK

Initial value:

= {
                HOP_UNDEFINED : 'HOP_UNDEFINED',
                #HOP_90K       : 'HOP_90K',
                HOP_45K       :  'HOP_45K',
                HOP_30K       :  'HOP_30K',
                HOP_15K       :  'HOP_15K',
                HOP_7K        :  'HOP_7K',
                HOP_3K        :  'HOP_3K',
                HOP_2K        :  'HOP_2K',
                HOP_1K        :  'HOP_1K',
                HOP_550       :  'HOP_550',
                HOP_312       :  'HOP_312',
                HOP_156       :  'HOP_156',
                HOP_78        :  'HOP_78',
                HOP_39        :  'HOP_39',
                HOP_20        :  'HOP_20'
            }

Dictionary for mapping hop-rate values to human-readable string representations of the value.