Namespace containing units conversion operations. More...

Detailed Description

Namespace containing units conversion operations.

The supported units categories are:

Functions
template<typename TRet , typename TField >
TRet	getAmps (const TField &field)
	Retrieve field's value as amps.

template<typename TRet , typename TField >
TRet	getBytes (const TField &field)
	Retrieve field's value as bytes.

template<typename TRet , typename TField >
TRet	getCentimeters (const TField &field)
	Retrieve field's value as centimeters.

template<typename TRet , typename TField >
TRet	getCentimetersPerSecond (const TField &field)
	Retrieve field's value as centimeters per second.

template<typename TRet , typename TField >
TRet	getDays (const TField &field)
	Retrieve field's value as days.

template<typename TRet , typename TField >
TRet	getDegrees (const TField &field)
	Retrieve field's value as degrees.

template<typename TRet , typename TField >
TRet	getGigabytes (const TField &field)
	Retrieve field's value as gigabytes.

template<typename TRet , typename TField >
TRet	getGigahertz (const TField &field)
	Retrieve field's value as gigahertz.

template<typename TRet , typename TField >
TRet	getHertz (const TField &field)
	Retrieve field's value as hertz.

template<typename TRet , typename TField >
TRet	getHours (const TField &field)
	Retrieve field's value as hours.

template<typename TRet , typename TField >
TRet	getKiloamps (const TField &field)
	Retrieve field's value as kiloamps.

template<typename TRet , typename TField >
TRet	getKilobytes (const TField &field)
	Retrieve field's value as kilobytes.

template<typename TRet , typename TField >
TRet	getKilohertz (const TField &field)
	Retrieve field's value as kilohertz.

template<typename TRet , typename TField >
TRet	getKilometers (const TField &field)
	Retrieve field's value as kilometers.

template<typename TRet , typename TField >
TRet	getKilometersPerHour (const TField &field)
	Retrieve field's value as kilometers per hour.

template<typename TRet , typename TField >
TRet	getKilometersPerSecond (const TField &field)
	Retrieve field's value as kilometers per second.

template<typename TRet , typename TField >
TRet	getKilovolts (const TField &field)
	Retrieve field's value as kilovolts.

template<typename TRet , typename TField >
TRet	getMegabytes (const TField &field)
	Retrieve field's value as megabytes.

template<typename TRet , typename TField >
TRet	getMegahertz (const TField &field)
	Retrieve field's value as megahertz.

template<typename TRet , typename TField >
TRet	getMeters (const TField &field)
	Retrieve field's value as meters.

template<typename TRet , typename TField >
TRet	getMetersPerSecond (const TField &field)
	Retrieve field's value as meters per second.

template<typename TRet , typename TField >
TRet	getMicroamps (const TField &field)
	Retrieve field's value as microamps.

template<typename TRet , typename TField >
TRet	getMicrometers (const TField &field)
	Retrieve field's value as micrometers.

template<typename TRet , typename TField >
TRet	getMicrometersPerSecond (const TField &field)
	Retrieve field's value as micrometers per second.

template<typename TRet , typename TField >
TRet	getMicroseconds (const TField &field)
	Retrieve field's value as microseconds.

template<typename TRet , typename TField >
TRet	getMicrovolts (const TField &field)
	Retrieve field's value as microvolts.

template<typename TRet , typename TField >
TRet	getMilliamps (const TField &field)
	Retrieve field's value as milliamps.

template<typename TRet , typename TField >
TRet	getMillimeters (const TField &field)
	Retrieve field's value as millimeters.

template<typename TRet , typename TField >
TRet	getMillimetersPerSecond (const TField &field)
	Retrieve field's value as millimeters per second.

template<typename TRet , typename TField >
TRet	getMilliseconds (const TField &field)
	Retrieve field's value as milliseconds.

template<typename TRet , typename TField >
TRet	getMillivolts (const TField &field)
	Retrieve field's value as millivolts.

template<typename TRet , typename TField >
TRet	getMinutes (const TField &field)
	Retrieve field's value as minutes.

template<typename TRet , typename TField >
TRet	getNanoamps (const TField &field)
	Retrieve field's value as nanoamps.

template<typename TRet , typename TField >
TRet	getNanometers (const TField &field)
	Retrieve field's value as nanometers.

template<typename TRet , typename TField >
TRet	getNanometersPerSecond (const TField &field)
	Retrieve field's value as nanometers per second.

template<typename TRet , typename TField >
TRet	getNanoseconds (const TField &field)
	Retrieve field's value as nanoseconds.

template<typename TRet , typename TField >
TRet	getNanovolts (const TField &field)
	Retrieve field's value as nanovolts.

template<typename TRet , typename TField >
TRet	getRadians (const TField &field)
	Retrieve field's value as radians.

template<typename TRet , typename TField >
TRet	getSeconds (const TField &field)
	Retrieve field's value as seconds.

template<typename TRet , typename TField >
TRet	getTerabytes (const TField &field)
	Retrieve field's value as terabytes.

template<typename TRet , typename TField >
TRet	getVolts (const TField &field)
	Retrieve field's value as volts.

template<typename TRet , typename TField >
TRet	getWeeks (const TField &field)
	Retrieve field's value as weeks.

template<typename TField >
constexpr bool	isAmps ()
	Compile time check whether the field type holds amps.

template<typename TField >
constexpr bool	isAmps (const TField &field)
	Compile time check whether the field type holds amps.

template<typename TField >
constexpr bool	isBytes ()
	Compile time check whether the field type holds bytes.

template<typename TField >
constexpr bool	isBytes (const TField &field)
	Compile time check whether the field type holds bytes.

template<typename TField >
constexpr bool	isCentimeters ()
	Compile time check whether the field type holds centimeters.

template<typename TField >
constexpr bool	isCentimeters (const TField &field)
	Compile time check whether the field type holds centimeters.

template<typename TField >
constexpr bool	isCentimetersPerSecond ()
	Compile time check whether the field type holds centimeters per second.

template<typename TField >
constexpr bool	isCentimetersPerSecond (const TField &field)
	Compile time check whether the field type holds centimeters per second.

template<typename TField >
constexpr bool	isDays ()
	Compile time check whether the field type holds days.

template<typename TField >
constexpr bool	isDays (const TField &field)
	Compile time check whether the field type holds days.

template<typename TField >
constexpr bool	isDegrees ()
	Compile time check whether the field type holds degrees.

template<typename TField >
constexpr bool	isDegrees (const TField &field)
	Compile time check whether the field type holds degrees.

template<typename TField >
constexpr bool	isGigabytes ()
	Compile time check whether the field type holds gigabytes.

template<typename TField >
constexpr bool	isGigabytes (const TField &field)
	Compile time check whether the field type holds gigabytes.

template<typename TField >
constexpr bool	isGigahertz ()
	Compile time check whether the field type holds gigahertz.

template<typename TField >
constexpr bool	isGigahertz (const TField &field)
	Compile time check whether the field type holds gigahertz.

template<typename TField >
constexpr bool	isHertz ()
	Compile time check whether the field type holds hertz.

template<typename TField >
constexpr bool	isHertz (const TField &field)
	Compile time check whether the field type holds hertz.

template<typename TField >
constexpr bool	isHours ()
	Compile time check whether the field type holds hours.

template<typename TField >
constexpr bool	isHours (const TField &field)
	Compile time check whether the field type holds hours.

template<typename TField >
constexpr bool	isKiloamps ()
	Compile time check whether the field type holds kiloamps.

template<typename TField >
constexpr bool	isKiloamps (const TField &field)
	Compile time check whether the field type holds kiloamps.

template<typename TField >
constexpr bool	isKilobytes ()
	Compile time check whether the field type holds kilobytes.

template<typename TField >
constexpr bool	isKilobytes (const TField &field)
	Compile time check whether the field type holds kilobytes.

template<typename TField >
constexpr bool	isKilohertz ()
	Compile time check whether the field type holds kilohertz.

template<typename TField >
constexpr bool	isKilohertz (const TField &field)
	Compile time check whether the field type holds kilohertz.

template<typename TField >
constexpr bool	isKilometers ()
	Compile time check whether the field type holds kilometers.

template<typename TField >
constexpr bool	isKilometers (const TField &field)
	Compile time check whether the field type holds kilometers.

template<typename TField >
constexpr bool	isKilometersPerHour ()
	Compile time check whether the field type holds kilometers per hour.

template<typename TField >
constexpr bool	isKilometersPerHour (const TField &field)
	Compile time check whether the field type holds kilometers per hour.

template<typename TField >
constexpr bool	isKilometersPerSecond ()
	Compile time check whether the field type holds kilometers per second.

template<typename TField >
constexpr bool	isKilometersPerSecond (const TField &field)
	Compile time check whether the field type holds kilometers per second.

template<typename TField >
constexpr bool	isKilovolts ()
	Compile time check whether the field type holds kilovolts.

template<typename TField >
constexpr bool	isKilovolts (const TField &field)
	Compile time check whether the field type holds kilovolts.

template<typename TField >
constexpr bool	isMegabytes ()
	Compile time check whether the field type holds megabytes.

template<typename TField >
constexpr bool	isMegabytes (const TField &field)
	Compile time check whether the field type holds megabytes.

template<typename TField >
constexpr bool	isMegahertz ()
	Compile time check whether the field type holds megahertz.

template<typename TField >
constexpr bool	isMegahertz (const TField &field)
	Compile time check whether the field type holds megahertz.

template<typename TField >
constexpr bool	isMeters ()
	Compile time check whether the field type holds meters.

template<typename TField >
constexpr bool	isMeters (const TField &field)
	Compile time check whether the field type holds meters.

template<typename TField >
constexpr bool	isMetersPerSecond ()
	Compile time check whether the field type holds meters per second.

template<typename TField >
constexpr bool	isMetersPerSecond (const TField &field)
	Compile time check whether the field type holds meters per second.

template<typename TField >
constexpr bool	isMicroamps ()
	Compile time check whether the field type holds microamps.

template<typename TField >
constexpr bool	isMicroamps (const TField &field)
	Compile time check whether the field type holds microamps.

template<typename TField >
constexpr bool	isMicrometers ()
	Compile time check whether the field type holds micrometers.

template<typename TField >
constexpr bool	isMicrometers (const TField &field)
	Compile time check whether the field type holds micrometers.

template<typename TField >
constexpr bool	isMicrometersPerSecond ()
	Compile time check whether the field type holds micrometers per second.

template<typename TField >
constexpr bool	isMicrometersPerSecond (const TField &field)
	Compile time check whether the field type holds micrometers per second.

template<typename TField >
constexpr bool	isMicroseconds ()
	Compile time check whether the field type holds microseconds.

template<typename TField >
constexpr bool	isMicroseconds (const TField &field)
	Compile time check whether the field type holds microseconds.

template<typename TField >
constexpr bool	isMicrovolts ()
	Compile time check whether the field type holds microvolts.

template<typename TField >
constexpr bool	isMicrovolts (const TField &field)
	Compile time check whether the field type holds microvolts.

template<typename TField >
constexpr bool	isMilliamps ()
	Compile time check whether the field type holds milliamps.

template<typename TField >
constexpr bool	isMilliamps (const TField &field)
	Compile time check whether the field type holds milliamps.

template<typename TField >
constexpr bool	isMillimeters ()
	Compile time check whether the field type holds millimeters.

template<typename TField >
constexpr bool	isMillimeters (const TField &field)
	Compile time check whether the field type holds millimeters.

template<typename TField >
constexpr bool	isMillimetersPerSecond ()
	Compile time check whether the field type holds millimeters per second.

template<typename TField >
constexpr bool	isMillimetersPerSecond (const TField &field)
	Compile time check whether the field type holds millimeters per second.

template<typename TField >
constexpr bool	isMilliseconds ()
	Compile time check whether the field type holds milliseconds.

template<typename TField >
constexpr bool	isMilliseconds (const TField &field)
	Compile time check whether the field type holds milliseconds.

template<typename TField >
constexpr bool	isMillivolts ()
	Compile time check whether the field type holds millivolts.

template<typename TField >
constexpr bool	isMillivolts (const TField &field)
	Compile time check whether the field type holds millivolts.

template<typename TField >
constexpr bool	isMinutes ()
	Compile time check whether the field type holds minutes.

template<typename TField >
constexpr bool	isMinutes (const TField &field)
	Compile time check whether the field type holds minutes.

template<typename TField >
constexpr bool	isNanoamps ()
	Compile time check whether the field type holds nanoamps.

template<typename TField >
constexpr bool	isNanoamps (const TField &field)
	Compile time check whether the field type holds nanoamps.

template<typename TField >
constexpr bool	isNanometers ()
	Compile time check whether the field type holds nanometers.

template<typename TField >
constexpr bool	isNanometers (const TField &field)
	Compile time check whether the field type holds nanometers.

template<typename TField >
constexpr bool	isNanometersPerSecond ()
	Compile time check whether the field type holds nanometers per second.

template<typename TField >
constexpr bool	isNanometersPerSecond (const TField &field)
	Compile time check whether the field type holds nanometers per second.

template<typename TField >
constexpr bool	isNanoseconds ()
	Compile time check whether the field type holds nanoseconds.

template<typename TField >
constexpr bool	isNanoseconds (const TField &field)
	Compile time check whether the field type holds nanoseconds.

template<typename TField >
constexpr bool	isNanovolts ()
	Compile time check whether the field type holds nanovolts.

template<typename TField >
constexpr bool	isNanovolts (const TField &field)
	Compile time check whether the field type holds nanovolts.

template<typename TField >
constexpr bool	isRadians ()
	Compile time check whether the field type holds radians.

template<typename TField >
constexpr bool	isRadians (const TField &field)
	Compile time check whether the field type holds radia s.

template<typename TField >
constexpr bool	isSeconds ()
	Compile time check whether the field type holds seconds.

template<typename TField >
constexpr bool	isSeconds (const TField &field)
	Compile time check whether the field type holds seconds.

template<typename TField >
constexpr bool	isTerabytes ()
	Compile time check whether the field type holds terabytes.

template<typename TField >
constexpr bool	isTerabytes (const TField &field)
	Compile time check whether the field type holds terabytes.

template<typename TField >
constexpr bool	isVolts ()
	Compile time check whether the field type holds volts.

template<typename TField >
constexpr bool	isVolts (const TField &field)
	Compile time check whether the field type holds volts.

template<typename TField >
constexpr bool	isWeeks ()
	Compile time check whether the field type holds weeks.

template<typename TField >
constexpr bool	isWeeks (const TField &field)
	Compile time check whether the field type holds weeks.

template<typename TField , typename TVal >
void	setAmps (TField &field, TVal &&val)
	Update field's value accordingly, while providing amps value.

template<typename TField , typename TVal >
void	setBytes (TField &field, TVal &&val)
	Update field's value accordingly, while providing bytes value.

template<typename TField , typename TVal >
void	setCentimeters (TField &field, TVal &&val)
	Update field's value accordingly, while providing centimeters value.

template<typename TField , typename TVal >
void	setCentimetersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing centimeters per second value.

template<typename TField , typename TVal >
void	setDays (TField &field, TVal &&val)
	Update field's value accordingly, while providing days value.

template<typename TField , typename TVal >
void	setDegrees (TField &field, TVal &&val)
	Update field's value accordingly, while providing degrees value.

template<typename TField , typename TVal >
void	setGigabytes (TField &field, TVal &&val)
	Update field's value accordingly, while providing gigabytes value.

template<typename TField , typename TVal >
void	setGigahertz (TField &field, TVal &&val)
	Update field's value accordingly, while providing gigahertz value.

template<typename TField , typename TVal >
void	setHertz (TField &field, TVal &&val)
	Update field's value accordingly, while providing hertz value.

template<typename TField , typename TVal >
void	setHours (TField &field, TVal &&val)
	Update field's value accordingly, while providing hours value.

template<typename TField , typename TVal >
void	setKiloamps (TField &field, TVal &&val)
	Update field's value accordingly, while providing kiloamps value.

template<typename TField , typename TVal >
void	setKilobytes (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilobytes value.

template<typename TField , typename TVal >
void	setKilohertz (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilohertz value.

template<typename TField , typename TVal >
void	setKilometers (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilometers value.

template<typename TField , typename TVal >
void	setKilometersPerHour (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilometers per hour value.

template<typename TField , typename TVal >
void	setKilometersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilometers per second value.

template<typename TField , typename TVal >
void	setKilovolts (TField &field, TVal &&val)
	Update field's value accordingly, while providing kilovolts value.

template<typename TField , typename TVal >
void	setMegabytes (TField &field, TVal &&val)
	Update field's value accordingly, while providing megabytes value.

template<typename TField , typename TVal >
void	setMegahertz (TField &field, TVal &&val)
	Update field's value accordingly, while providing megahertz value.

template<typename TField , typename TVal >
void	setMeters (TField &field, TVal &&val)
	Update field's value accordingly, while providing meters value.

template<typename TField , typename TVal >
void	setMetersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing meters per second value.

template<typename TField , typename TVal >
void	setMicroamps (TField &field, TVal &&val)
	Update field's value accordingly, while providing microamps value.

template<typename TField , typename TVal >
void	setMicrometers (TField &field, TVal &&val)
	Update field's value accordingly, while providing micrometers value.

template<typename TField , typename TVal >
void	setMicrometersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing micrometers per second value.

template<typename TField , typename TVal >
void	setMicroseconds (TField &field, TVal &&val)
	Update field's value accordingly, while providing microseconds value.

template<typename TField , typename TVal >
void	setMicrovolts (TField &field, TVal &&val)
	Update field's value accordingly, while providing microvolts value.

template<typename TField , typename TVal >
void	setMilliamps (TField &field, TVal &&val)
	Update field's value accordingly, while providing milliamps value.

template<typename TField , typename TVal >
void	setMillimeters (TField &field, TVal &&val)
	Update field's value accordingly, while providing millimeters value.

template<typename TField , typename TVal >
void	setMillimetersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing millimeters per second value.

template<typename TField , typename TVal >
void	setMilliseconds (TField &field, TVal &&val)
	Update field's value accordingly, while providing milliseconds value.

template<typename TField , typename TVal >
void	setMillivolts (TField &field, TVal &&val)
	Update field's value accordingly, while providing millivolts value.

template<typename TField , typename TVal >
void	setMinutes (TField &field, TVal &&val)
	Update field's value accordingly, while providing minutes value.

template<typename TField , typename TVal >
void	setNanoamps (TField &field, TVal &&val)
	Update field's value accordingly, while providing nanoamps value.

template<typename TField , typename TVal >
void	setNanometers (TField &field, TVal &&val)
	Update field's value accordingly, while providing nanometers value.

template<typename TField , typename TVal >
void	setNanometersPerSecond (TField &field, TVal &&val)
	Update field's value accordingly, while providing nanometers per second value.

template<typename TField , typename TVal >
void	setNanoseconds (TField &field, TVal &&val)
	Update field's value accordingly, while providing nanoseconds value.

template<typename TField , typename TVal >
void	setNanovolts (TField &field, TVal &&val)
	Update field's value accordingly, while providing nanovolts value.

template<typename TField , typename TVal >
void	setRadians (TField &field, TVal &&val)
	Update field's value accordingly, while providing radians value.

template<typename TField , typename TVal >
void	setSeconds (TField &field, TVal &&val)
	Update field's value accordingly, while providing seconds value.

template<typename TField , typename TVal >
void	setTerabytes (TField &field, TVal &&val)
	Update field's value accordingly, while providing terabytes value.

template<typename TField , typename TVal >
void	setVolts (TField &field, TVal &&val)
	Update field's value accordingly, while providing volts value.

template<typename TField , typename TVal >
void	setWeeks (TField &field, TVal &&val)
	Update field's value accordingly, while providing weeks value.

Function Documentation

◆ getAmps()

template<typename TRet , typename TField >

TRet comms::units::getAmps ( const TField & field )

Retrieve field's value as amps.

The function will do all the necessary math operations to convert stored value to amps and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ getBytes()

template<typename TRet , typename TField >

TRet comms::units::getBytes ( const TField & field )

Retrieve field's value as bytes.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ getCentimeters()

template<typename TRet , typename TField >

TRet comms::units::getCentimeters ( const TField & field )

Retrieve field's value as centimeters.

The function will do all the necessary math operations to convert stored value to centimeters and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getCentimetersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getCentimetersPerSecond ( const TField & field )

Retrieve field's value as centimeters per second.

The function will do all the necessary math operations to convert stored value to cm/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getDays()

template<typename TRet , typename TField >

TRet comms::units::getDays ( const TField & field )

Retrieve field's value as days.

The function will do all the necessary math operations to convert stored value to days and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getDegrees()

template<typename TRet , typename TField >

TRet comms::units::getDegrees ( const TField & field )

Retrieve field's value as degrees.

The function will do all the necessary math operations to convert stored value to degrees and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any angle measurement value, using any of the relevant options: comms::option::def::UnitsDegrees or comms::option::def::UnitsRadians

◆ getGigabytes()

template<typename TRet , typename TField >

TRet comms::units::getGigabytes ( const TField & field )

Retrieve field's value as gigabytes.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ getGigahertz()

template<typename TRet , typename TField >

TRet comms::units::getGigahertz ( const TField & field )

Retrieve field's value as gigahertz.

The function will do all the necessary math operations to convert stored value to gigahertz and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ getHertz()

template<typename TRet , typename TField >

TRet comms::units::getHertz ( const TField & field )

Retrieve field's value as hertz.

The function will do all the necessary math operations to convert stored value to hertz and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ getHours()

template<typename TRet , typename TField >

TRet comms::units::getHours ( const TField & field )

Retrieve field's value as hours.

The function will do all the necessary math operations to convert stored value to hours and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getKiloamps()

template<typename TRet , typename TField >

TRet comms::units::getKiloamps ( const TField & field )

Retrieve field's value as kiloamps.

The function will do all the necessary math operations to convert stored value to kiloamps and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ getKilobytes()

template<typename TRet , typename TField >

TRet comms::units::getKilobytes ( const TField & field )

Retrieve field's value as kilobytes.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ getKilohertz()

template<typename TRet , typename TField >

TRet comms::units::getKilohertz ( const TField & field )

Retrieve field's value as kilohertz.

The function will do all the necessary math operations to convert stored value to kilohertz and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ getKilometers()

template<typename TRet , typename TField >

TRet comms::units::getKilometers ( const TField & field )

Retrieve field's value as kilometers.

The function will do all the necessary math operations to convert stored value to kilometers and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getKilometersPerHour()

template<typename TRet , typename TField >

TRet comms::units::getKilometersPerHour ( const TField & field )

Retrieve field's value as kilometers per hour.

The function will do all the necessary math operations to convert stored value to km/h and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getKilometersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getKilometersPerSecond ( const TField & field )

Retrieve field's value as kilometers per second.

The function will do all the necessary math operations to convert stored value to km/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getKilovolts()

template<typename TRet , typename TField >

TRet comms::units::getKilovolts ( const TField & field )

Retrieve field's value as kilovolts.

The function will do all the necessary math operations to convert stored value to kilovolts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ getMegabytes()

template<typename TRet , typename TField >

TRet comms::units::getMegabytes ( const TField & field )

Retrieve field's value as megabytes.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ getMegahertz()

template<typename TRet , typename TField >

TRet comms::units::getMegahertz ( const TField & field )

Retrieve field's value as megahertz.

The function will do all the necessary math operations to convert stored value to megahertz and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ getMeters()

template<typename TRet , typename TField >

TRet comms::units::getMeters ( const TField & field )

Retrieve field's value as meters.

The function will do all the necessary math operations to convert stored value to meters and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getMetersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getMetersPerSecond ( const TField & field )

Retrieve field's value as meters per second.

The function will do all the necessary math operations to convert stored value to m/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getMicroamps()

template<typename TRet , typename TField >

TRet comms::units::getMicroamps ( const TField & field )

Retrieve field's value as microamps.

The function will do all the necessary math operations to convert stored value to microamps and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ getMicrometers()

template<typename TRet , typename TField >

TRet comms::units::getMicrometers ( const TField & field )

Retrieve field's value as micrometers.

The function will do all the necessary math operations to convert stored value to micrometers and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getMicrometersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getMicrometersPerSecond ( const TField & field )

Retrieve field's value as micrometers per second.

The function will do all the necessary math operations to convert stored value to um/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getMicroseconds()

template<typename TRet , typename TField >

TRet comms::units::getMicroseconds ( const TField & field )

Retrieve field's value as microseconds.

The function will do all the necessary math operations to convert stored value to microseconds and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getMicrovolts()

template<typename TRet , typename TField >

TRet comms::units::getMicrovolts ( const TField & field )

Retrieve field's value as microvolts.

The function will do all the necessary math operations to convert stored value to microvolts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ getMilliamps()

template<typename TRet , typename TField >

TRet comms::units::getMilliamps ( const TField & field )

Retrieve field's value as milliamps.

The function will do all the necessary math operations to convert stored value to milliamps and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ getMillimeters()

template<typename TRet , typename TField >

TRet comms::units::getMillimeters ( const TField & field )

Retrieve field's value as millimeters.

The function will do all the necessary math operations to convert stored value to millimeters and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getMillimetersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getMillimetersPerSecond ( const TField & field )

Retrieve field's value as millimeters per second.

The function will do all the necessary math operations to convert stored value to mm/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getMilliseconds()

template<typename TRet , typename TField >

TRet comms::units::getMilliseconds ( const TField & field )

Retrieve field's value as milliseconds.

The function will do all the necessary math operations to convert stored value to milliseconds and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getMillivolts()

template<typename TRet , typename TField >

TRet comms::units::getMillivolts ( const TField & field )

Retrieve field's value as millivolts.

The function will do all the necessary math operations to convert stored value to millivolts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ getMinutes()

template<typename TRet , typename TField >

TRet comms::units::getMinutes ( const TField & field )

Retrieve field's value as minutes.

The function will do all the necessary math operations to convert stored value to minutes and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getNanoamps()

template<typename TRet , typename TField >

TRet comms::units::getNanoamps ( const TField & field )

Retrieve field's value as nanoamps.

The function will do all the necessary math operations to convert stored value to nanoamps and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ getNanometers()

template<typename TRet , typename TField >

TRet comms::units::getNanometers ( const TField & field )

Retrieve field's value as nanometers.

The function will do all the necessary math operations to convert stored value to nanometers and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ getNanometersPerSecond()

template<typename TRet , typename TField >

TRet comms::units::getNanometersPerSecond ( const TField & field )

Retrieve field's value as nanometers per second.

The function will do all the necessary math operations to convert stored value to nm/s and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ getNanoseconds()

template<typename TRet , typename TField >

TRet comms::units::getNanoseconds ( const TField & field )

Retrieve field's value as nanoseconds.

The function will do all the necessary math operations to convert stored value to nanoseconds and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getNanovolts()

template<typename TRet , typename TField >

TRet comms::units::getNanovolts ( const TField & field )

Retrieve field's value as nanovolts.

The function will do all the necessary math operations to convert stored value to nanovolts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ getRadians()

template<typename TRet , typename TField >

TRet comms::units::getRadians ( const TField & field )

Retrieve field's value as radians.

The function will do all the necessary math operations to convert stored value to radians and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any angle measurement value, using any of the relevant options: comms::option::def::UnitsDegrees or comms::option::def::UnitsRadians

◆ getSeconds()

template<typename TRet , typename TField >

TRet comms::units::getSeconds ( const TField & field )

Retrieve field's value as seconds.

The function will do all the necessary math operations to convert stored value to seconds and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ getTerabytes()

template<typename TRet , typename TField >

TRet comms::units::getTerabytes ( const TField & field )

Retrieve field's value as terabytes.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ getVolts()

template<typename TRet , typename TField >

TRet comms::units::getVolts ( const TField & field )

Retrieve field's value as volts.

The function will do all the necessary math operations to convert stored value to volts and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ getWeeks()

template<typename TRet , typename TField >

TRet comms::units::getWeeks ( const TField & field )

Retrieve field's value as weeks.

The function will do all the necessary math operations to convert stored value to weeks and return the result in specified return type.

Template Parameters

TRet	Return type
TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ isAmps() [1/2]

template<typename TField >

constexpr bool comms::units::isAmps ( )

constexpr

Compile time check whether the field type holds amps.

Template Parameters

TField Type of field.

◆ isAmps() [2/2]

template<typename TField >

constexpr bool comms::units::isAmps ( const TField & field )

constexpr

Compile time check whether the field type holds amps.

Similar to other isAmps(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isBytes() [1/2]

template<typename TField >

constexpr bool comms::units::isBytes ( )

constexpr

Compile time check whether the field type holds bytes.

Template Parameters

TField Type of field.

◆ isBytes() [2/2]

template<typename TField >

constexpr bool comms::units::isBytes ( const TField & field )

constexpr

Compile time check whether the field type holds bytes.

Similar to other isBytes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isCentimeters() [1/2]

template<typename TField >

constexpr bool comms::units::isCentimeters ( )

constexpr

Compile time check whether the field type holds centimeters.

Template Parameters

TField Type of field.

◆ isCentimeters() [2/2]

template<typename TField >

constexpr bool comms::units::isCentimeters ( const TField & field )

constexpr

Compile time check whether the field type holds centimeters.

Similar to other isCentimeters(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isCentimetersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isCentimetersPerSecond ( )

constexpr

Compile time check whether the field type holds centimeters per second.

Template Parameters

TField Type of field.

◆ isCentimetersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isCentimetersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds centimeters per second.

Similar to other isCentimetersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isDays() [1/2]

template<typename TField >

constexpr bool comms::units::isDays ( )

constexpr

Compile time check whether the field type holds days.

Template Parameters

TField Type of field.

◆ isDays() [2/2]

template<typename TField >

constexpr bool comms::units::isDays ( const TField & field )

constexpr

Compile time check whether the field type holds days.

Similar to other isDays(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isDegrees() [1/2]

template<typename TField >

constexpr bool comms::units::isDegrees ( )

constexpr

Compile time check whether the field type holds degrees.

Template Parameters

TField Type of field.

◆ isDegrees() [2/2]

template<typename TField >

constexpr bool comms::units::isDegrees ( const TField & field )

constexpr

Compile time check whether the field type holds degrees.

Similar to other isDegrees(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isGigabytes() [1/2]

template<typename TField >

constexpr bool comms::units::isGigabytes ( )

constexpr

Compile time check whether the field type holds gigabytes.

Template Parameters

TField Type of field.

◆ isGigabytes() [2/2]

template<typename TField >

constexpr bool comms::units::isGigabytes ( const TField & field )

constexpr

Compile time check whether the field type holds gigabytes.

Similar to other isGigabytes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isGigahertz() [1/2]

template<typename TField >

constexpr bool comms::units::isGigahertz ( )

constexpr

Compile time check whether the field type holds gigahertz.

Template Parameters

TField Type of field.

◆ isGigahertz() [2/2]

template<typename TField >

constexpr bool comms::units::isGigahertz ( const TField & field )

constexpr

Compile time check whether the field type holds gigahertz.

Similar to other isGigahertz(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isHertz() [1/2]

template<typename TField >

constexpr bool comms::units::isHertz ( )

constexpr

Compile time check whether the field type holds hertz.

Template Parameters

TField Type of field.

◆ isHertz() [2/2]

template<typename TField >

constexpr bool comms::units::isHertz ( const TField & field )

constexpr

Compile time check whether the field type holds hertz.

Similar to other isHertz(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isHours() [1/2]

template<typename TField >

constexpr bool comms::units::isHours ( )

constexpr

Compile time check whether the field type holds hours.

Template Parameters

TField Type of field.

◆ isHours() [2/2]

template<typename TField >

constexpr bool comms::units::isHours ( const TField & field )

constexpr

Compile time check whether the field type holds hours.

Similar to other isHours(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKiloamps() [1/2]

template<typename TField >

constexpr bool comms::units::isKiloamps ( )

constexpr

Compile time check whether the field type holds kiloamps.

Template Parameters

TField Type of field.

◆ isKiloamps() [2/2]

template<typename TField >

constexpr bool comms::units::isKiloamps ( const TField & field )

constexpr

Compile time check whether the field type holds kiloamps.

Similar to other isKiloamps(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilobytes() [1/2]

template<typename TField >

constexpr bool comms::units::isKilobytes ( )

constexpr

Compile time check whether the field type holds kilobytes.

Template Parameters

TField Type of field.

◆ isKilobytes() [2/2]

template<typename TField >

constexpr bool comms::units::isKilobytes ( const TField & field )

constexpr

Compile time check whether the field type holds kilobytes.

Similar to other isKilobytes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilohertz() [1/2]

template<typename TField >

constexpr bool comms::units::isKilohertz ( )

constexpr

Compile time check whether the field type holds kilohertz.

Template Parameters

TField Type of field.

◆ isKilohertz() [2/2]

template<typename TField >

constexpr bool comms::units::isKilohertz ( const TField & field )

constexpr

Compile time check whether the field type holds kilohertz.

Similar to other isKilohertz(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilometers() [1/2]

template<typename TField >

constexpr bool comms::units::isKilometers ( )

constexpr

Compile time check whether the field type holds kilometers.

Template Parameters

TField Type of field.

◆ isKilometers() [2/2]

template<typename TField >

constexpr bool comms::units::isKilometers ( const TField & field )

constexpr

Compile time check whether the field type holds kilometers.

Similar to other isKilometers(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilometersPerHour() [1/2]

template<typename TField >

constexpr bool comms::units::isKilometersPerHour ( )

constexpr

Compile time check whether the field type holds kilometers per hour.

Template Parameters

TField Type of field.

◆ isKilometersPerHour() [2/2]

template<typename TField >

constexpr bool comms::units::isKilometersPerHour ( const TField & field )

constexpr

Compile time check whether the field type holds kilometers per hour.

Similar to other isKilometersPerHour(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilometersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isKilometersPerSecond ( )

constexpr

Compile time check whether the field type holds kilometers per second.

Template Parameters

TField Type of field.

◆ isKilometersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isKilometersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds kilometers per second.

Similar to other isKilometersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isKilovolts() [1/2]

template<typename TField >

constexpr bool comms::units::isKilovolts ( )

constexpr

Compile time check whether the field type holds kilovolts.

Template Parameters

TField Type of field.

◆ isKilovolts() [2/2]

template<typename TField >

constexpr bool comms::units::isKilovolts ( const TField & field )

constexpr

Compile time check whether the field type holds kilovolts.

Similar to other isKilovolts(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMegabytes() [1/2]

template<typename TField >

constexpr bool comms::units::isMegabytes ( )

constexpr

Compile time check whether the field type holds megabytes.

Template Parameters

TField Type of field.

◆ isMegabytes() [2/2]

template<typename TField >

constexpr bool comms::units::isMegabytes ( const TField & field )

constexpr

Compile time check whether the field type holds megabytes.

Similar to other isMegabytes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMegahertz() [1/2]

template<typename TField >

constexpr bool comms::units::isMegahertz ( )

constexpr

Compile time check whether the field type holds megahertz.

Template Parameters

TField Type of field.

◆ isMegahertz() [2/2]

template<typename TField >

constexpr bool comms::units::isMegahertz ( const TField & field )

constexpr

Compile time check whether the field type holds megahertz.

Similar to other isMegahertz(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMeters() [1/2]

template<typename TField >

constexpr bool comms::units::isMeters ( )

constexpr

Compile time check whether the field type holds meters.

Template Parameters

TField Type of field.

◆ isMeters() [2/2]

template<typename TField >

constexpr bool comms::units::isMeters ( const TField & field )

constexpr

Compile time check whether the field type holds meters.

Similar to other isMeters(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMetersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isMetersPerSecond ( )

constexpr

Compile time check whether the field type holds meters per second.

Template Parameters

TField Type of field.

◆ isMetersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isMetersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds meters per second.

Similar to other isMetersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMicroamps() [1/2]

template<typename TField >

constexpr bool comms::units::isMicroamps ( )

constexpr

Compile time check whether the field type holds microamps.

Template Parameters

TField Type of field.

◆ isMicroamps() [2/2]

template<typename TField >

constexpr bool comms::units::isMicroamps ( const TField & field )

constexpr

Compile time check whether the field type holds microamps.

Similar to other isMicroamps(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMicrometers() [1/2]

template<typename TField >

constexpr bool comms::units::isMicrometers ( )

constexpr

Compile time check whether the field type holds micrometers.

Template Parameters

TField Type of field.

◆ isMicrometers() [2/2]

template<typename TField >

constexpr bool comms::units::isMicrometers ( const TField & field )

constexpr

Compile time check whether the field type holds micrometers.

Similar to other isMicrometers(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMicrometersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isMicrometersPerSecond ( )

constexpr

Compile time check whether the field type holds micrometers per second.

Template Parameters

TField Type of field.

◆ isMicrometersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isMicrometersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds micrometers per second.

Similar to other isMicrometersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMicroseconds() [1/2]

template<typename TField >

constexpr bool comms::units::isMicroseconds ( )

constexpr

Compile time check whether the field type holds microseconds.

Template Parameters

TField Type of field.

◆ isMicroseconds() [2/2]

template<typename TField >

constexpr bool comms::units::isMicroseconds ( const TField & field )

constexpr

Compile time check whether the field type holds microseconds.

Similar to other isMicroseconds(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMicrovolts() [1/2]

template<typename TField >

constexpr bool comms::units::isMicrovolts ( )

constexpr

Compile time check whether the field type holds microvolts.

Template Parameters

TField Type of field.

◆ isMicrovolts() [2/2]

template<typename TField >

constexpr bool comms::units::isMicrovolts ( const TField & field )

constexpr

Compile time check whether the field type holds microvolts.

Similar to other isMicrovolts(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMilliamps() [1/2]

template<typename TField >

constexpr bool comms::units::isMilliamps ( )

constexpr

Compile time check whether the field type holds milliamps.

Template Parameters

TField Type of field.

◆ isMilliamps() [2/2]

template<typename TField >

constexpr bool comms::units::isMilliamps ( const TField & field )

constexpr

Compile time check whether the field type holds milliamps.

Similar to other isMilliamps(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMillimeters() [1/2]

template<typename TField >

constexpr bool comms::units::isMillimeters ( )

constexpr

Compile time check whether the field type holds millimeters.

Template Parameters

TField Type of field.

◆ isMillimeters() [2/2]

template<typename TField >

constexpr bool comms::units::isMillimeters ( const TField & field )

constexpr

Compile time check whether the field type holds millimeters.

Similar to other isMillimeters(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMillimetersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isMillimetersPerSecond ( )

constexpr

Compile time check whether the field type holds millimeters per second.

Template Parameters

TField Type of field.

◆ isMillimetersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isMillimetersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds millimeters per second.

Similar to other isMillimetersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMilliseconds() [1/2]

template<typename TField >

constexpr bool comms::units::isMilliseconds ( )

constexpr

Compile time check whether the field type holds milliseconds.

Template Parameters

TField Type of field.

◆ isMilliseconds() [2/2]

template<typename TField >

constexpr bool comms::units::isMilliseconds ( const TField & field )

constexpr

Compile time check whether the field type holds milliseconds.

Similar to other isMilliseconds(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMillivolts() [1/2]

template<typename TField >

constexpr bool comms::units::isMillivolts ( )

constexpr

Compile time check whether the field type holds millivolts.

Template Parameters

TField Type of field.

◆ isMillivolts() [2/2]

template<typename TField >

constexpr bool comms::units::isMillivolts ( const TField & field )

constexpr

Compile time check whether the field type holds millivolts.

Similar to other isMillivolts(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isMinutes() [1/2]

template<typename TField >

constexpr bool comms::units::isMinutes ( )

constexpr

Compile time check whether the field type holds minutes.

Template Parameters

TField Type of field.

◆ isMinutes() [2/2]

template<typename TField >

constexpr bool comms::units::isMinutes ( const TField & field )

constexpr

Compile time check whether the field type holds minutes.

Similar to other isMinutes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isNanoamps() [1/2]

template<typename TField >

constexpr bool comms::units::isNanoamps ( )

constexpr

Compile time check whether the field type holds nanoamps.

Template Parameters

TField Type of field.

◆ isNanoamps() [2/2]

template<typename TField >

constexpr bool comms::units::isNanoamps ( const TField & field )

constexpr

Compile time check whether the field type holds nanoamps.

Similar to other isNanoamps(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isNanometers() [1/2]

template<typename TField >

constexpr bool comms::units::isNanometers ( )

constexpr

Compile time check whether the field type holds nanometers.

Template Parameters

TField Type of field.

◆ isNanometers() [2/2]

template<typename TField >

constexpr bool comms::units::isNanometers ( const TField & field )

constexpr

Compile time check whether the field type holds nanometers.

Similar to other isNanometers(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isNanometersPerSecond() [1/2]

template<typename TField >

constexpr bool comms::units::isNanometersPerSecond ( )

constexpr

Compile time check whether the field type holds nanometers per second.

Template Parameters

TField Type of field.

◆ isNanometersPerSecond() [2/2]

template<typename TField >

constexpr bool comms::units::isNanometersPerSecond ( const TField & field )

constexpr

Compile time check whether the field type holds nanometers per second.

Similar to other isNanometersPerSecond(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isNanoseconds() [1/2]

template<typename TField >

constexpr bool comms::units::isNanoseconds ( )

constexpr

Compile time check whether the field type holds nanoseconds.

Template Parameters

TField Type of field.

◆ isNanoseconds() [2/2]

template<typename TField >

constexpr bool comms::units::isNanoseconds ( const TField & field )

constexpr

Compile time check whether the field type holds nanoseconds.

Similar to other isNanoseconds(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isNanovolts() [1/2]

template<typename TField >

constexpr bool comms::units::isNanovolts ( )

constexpr

Compile time check whether the field type holds nanovolts.

Template Parameters

TField Type of field.

◆ isNanovolts() [2/2]

template<typename TField >

constexpr bool comms::units::isNanovolts ( const TField & field )

constexpr

Compile time check whether the field type holds nanovolts.

Similar to other isNanovolts(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isRadians() [1/2]

template<typename TField >

constexpr bool comms::units::isRadians ( )

constexpr

Compile time check whether the field type holds radians.

Template Parameters

TField Type of field.

◆ isRadians() [2/2]

template<typename TField >

constexpr bool comms::units::isRadians ( const TField & field )

constexpr

Compile time check whether the field type holds radia s.

Similar to other isRadians(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isSeconds() [1/2]

template<typename TField >

constexpr bool comms::units::isSeconds ( )

constexpr

Compile time check whether the field type holds seconds.

Template Parameters

TField Type of field.

◆ isSeconds() [2/2]

template<typename TField >

constexpr bool comms::units::isSeconds ( const TField & field )

constexpr

Compile time check whether the field type holds seconds.

Similar to other isSeconds(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isTerabytes() [1/2]

template<typename TField >

constexpr bool comms::units::isTerabytes ( )

constexpr

Compile time check whether the field type holds terabytes.

Template Parameters

TField Type of field.

◆ isTerabytes() [2/2]

template<typename TField >

constexpr bool comms::units::isTerabytes ( const TField & field )

constexpr

Compile time check whether the field type holds terabytes.

Similar to other isTerabytes(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isVolts() [1/2]

template<typename TField >

constexpr bool comms::units::isVolts ( )

constexpr

Compile time check whether the field type holds volts.

Template Parameters

TField Type of field.

◆ isVolts() [2/2]

template<typename TField >

constexpr bool comms::units::isVolts ( const TField & field )

constexpr

Compile time check whether the field type holds volts.

Similar to other isVolts(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ isWeeks() [1/2]

template<typename TField >

constexpr bool comms::units::isWeeks ( )

constexpr

Compile time check whether the field type holds weeks.

Template Parameters

TField Type of field.

◆ isWeeks() [2/2]

template<typename TField >

constexpr bool comms::units::isWeeks ( const TField & field )

constexpr

Compile time check whether the field type holds weeks.

Similar to other isWeeks(), but allows automatic deduction of the field type.

Parameters

[in] field Reference to field object, units of which need to be checked.

◆ setAmps()

template<typename TField , typename TVal >

void comms::units::setAmps	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing amps value.

The function will do all the necessary math operations to convert provided amps into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ setBytes()

template<typename TField , typename TVal >

void comms::units::setBytes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing bytes value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ setCentimeters()

template<typename TField , typename TVal >

void comms::units::setCentimeters	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing centimeters value.

The function will do all the necessary math operations to convert provided centimeters into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setCentimetersPerSecond()

template<typename TField , typename TVal >

void comms::units::setCentimetersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing centimeters per second value.

The function will do all the necessary math operations to convert provided cm/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setDays()

template<typename TField , typename TVal >

void comms::units::setDays	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing days value.

The function will do all the necessary math operations to convert provided days into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setDegrees()

template<typename TField , typename TVal >

void comms::units::setDegrees	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing degrees value.

The function will do all the necessary math operations to convert provided degrees into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any angle measurement value, using any of the relevant options: comms::option::def::UnitsDegrees or comms::option::def::UnitsRadians

◆ setGigabytes()

template<typename TField , typename TVal >

void comms::units::setGigabytes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing gigabytes value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ setGigahertz()

template<typename TField , typename TVal >

void comms::units::setGigahertz	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing gigahertz value.

The function will do all the necessary math operations to convert provided gigahertz into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ setHertz()

template<typename TField , typename TVal >

void comms::units::setHertz	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing hertz value.

The function will do all the necessary math operations to convert provided hertz into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ setHours()

template<typename TField , typename TVal >

void comms::units::setHours	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing hours value.

The function will do all the necessary math operations to convert provided hours into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setKiloamps()

template<typename TField , typename TVal >

void comms::units::setKiloamps	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kiloamps value.

The function will do all the necessary math operations to convert provided kiloamps into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ setKilobytes()

template<typename TField , typename TVal >

void comms::units::setKilobytes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilobytes value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ setKilohertz()

template<typename TField , typename TVal >

void comms::units::setKilohertz	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilohertz value.

The function will do all the necessary math operations to convert provided kilohertz into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ setKilometers()

template<typename TField , typename TVal >

void comms::units::setKilometers	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilometers value.

The function will do all the necessary math operations to convert provided kilometers into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setKilometersPerHour()

template<typename TField , typename TVal >

void comms::units::setKilometersPerHour	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilometers per hour value.

The function will do all the necessary math operations to convert provided km/h into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setKilometersPerSecond()

template<typename TField , typename TVal >

void comms::units::setKilometersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilometers per second value.

The function will do all the necessary math operations to convert provided km/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setKilovolts()

template<typename TField , typename TVal >

void comms::units::setKilovolts	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing kilovolts value.

The function will do all the necessary math operations to convert provided kilovolts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ setMegabytes()

template<typename TField , typename TVal >

void comms::units::setMegabytes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing megabytes value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ setMegahertz()

template<typename TField , typename TVal >

void comms::units::setMegahertz	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing megahertz value.

The function will do all the necessary math operations to convert provided megahertz into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any frequency value, using any of the relevant options: comms::option::def::UnitsHertz, comms::option::def::UnitsKilohertz, etc...

◆ setMeters()

template<typename TField , typename TVal >

void comms::units::setMeters	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing meters value.

The function will do all the necessary math operations to convert provided meters into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setMetersPerSecond()

template<typename TField , typename TVal >

void comms::units::setMetersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing meters per second value.

The function will do all the necessary math operations to convert provided m/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setMicroamps()

template<typename TField , typename TVal >

void comms::units::setMicroamps	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing microamps value.

The function will do all the necessary math operations to convert provided microamps into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ setMicrometers()

template<typename TField , typename TVal >

void comms::units::setMicrometers	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing micrometers value.

The function will do all the necessary math operations to convert provided micrometers into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setMicrometersPerSecond()

template<typename TField , typename TVal >

void comms::units::setMicrometersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing micrometers per second value.

The function will do all the necessary math operations to convert provided um/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setMicroseconds()

template<typename TField , typename TVal >

void comms::units::setMicroseconds	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing microseconds value.

The function will do all the necessary math operations to convert provided microseconds into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setMicrovolts()

template<typename TField , typename TVal >

void comms::units::setMicrovolts	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing microvolts value.

The function will do all the necessary math operations to convert provided microvolts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ setMilliamps()

template<typename TField , typename TVal >

void comms::units::setMilliamps	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing milliamps value.

The function will do all the necessary math operations to convert provided milliamps into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ setMillimeters()

template<typename TField , typename TVal >

void comms::units::setMillimeters	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing millimeters value.

The function will do all the necessary math operations to convert provided millimeters into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setMillimetersPerSecond()

template<typename TField , typename TVal >

void comms::units::setMillimetersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing millimeters per second value.

The function will do all the necessary math operations to convert provided mm/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setMilliseconds()

template<typename TField , typename TVal >

void comms::units::setMilliseconds	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing milliseconds value.

The function will do all the necessary math operations to convert provided milliseconds into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setMillivolts()

template<typename TField , typename TVal >

void comms::units::setMillivolts	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing millivolts value.

The function will do all the necessary math operations to convert provided millivolts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ setMinutes()

template<typename TField , typename TVal >

void comms::units::setMinutes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing minutes value.

The function will do all the necessary math operations to convert provided minutes into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setNanoamps()

template<typename TField , typename TVal >

void comms::units::setNanoamps	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing nanoamps value.

The function will do all the necessary math operations to convert provided nanoamps into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical current value, using any of the relevant options: comms::option::def::UnitsMilliamps, comms::option::def::UnitsAmps, etc...

◆ setNanometers()

template<typename TField , typename TVal >

void comms::units::setNanometers	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing nanometers value.

The function will do all the necessary math operations to convert provided nanometers into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any distance value, using any of the relevant options: comms::option::def::UnitsMillimeters, comms::option::def::UnitsMeters, etc...

◆ setNanometersPerSecond()

template<typename TField , typename TVal >

void comms::units::setNanometersPerSecond	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing nanometers per second value.

The function will do all the necessary math operations to convert provided nm/s into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any speed value, using any of the relevant options: comms::option::def::UnitsMillimetersPerSecond, comms::option::def::UnitsMetersPerSecond, etc...

◆ setNanoseconds()

template<typename TField , typename TVal >

void comms::units::setNanoseconds	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing nanoseconds value.

The function will do all the necessary math operations to convert provided nanoseconds into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setNanovolts()

template<typename TField , typename TVal >

void comms::units::setNanovolts	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing nanovolts value.

The function will do all the necessary math operations to convert provided nanovolts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ setRadians()

template<typename TField , typename TVal >

void comms::units::setRadians	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing radians value.

The function will do all the necessary math operations to convert provided radians into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any angle measurement value, using any of the relevant options: comms::option::def::UnitsDegrees or comms::option::def::UnitsRadians

◆ setSeconds()

template<typename TField , typename TVal >

void comms::units::setSeconds	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing seconds value.

The function will do all the necessary math operations to convert provided seconds into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

◆ setTerabytes()

template<typename TField , typename TVal >

void comms::units::setTerabytes	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing terabytes value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsBytes, comms::option::def::UnitsKilobytes, etc...

◆ setVolts()

template<typename TField , typename TVal >

void comms::units::setVolts	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing volts value.

The function will do all the necessary math operations to convert provided volts into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any electrical voltage value, using any of the relevant options: comms::option::def::UnitsMillivolts, comms::option::def::UnitsVolts, etc...

◆ setWeeks()

template<typename TField , typename TVal >

void comms::units::setWeeks	(	TField &	field,
		TVal &&	val
	)

Update field's value accordingly, while providing weeks value.

The function will do all the necessary math operations to convert provided weeks into the units stored by the field and update the internal value of the latter accordingly.

Template Parameters

TField	Type of the field, expected to be a field with integral internal value, such as a variant of comms::field::IntValue.
TVal	Type of value to assign.

Precondition: The TField type must be defined containing any time value, using any of the relevant options: comms::option::def::UnitsMilliseconds, comms::option::def::UnitsSeconds, etc...

Detailed Description

Functions

Function Documentation

◆ getAmps()

◆ getBytes()

◆ getCentimeters()

◆ getCentimetersPerSecond()

◆ getDays()

◆ getDegrees()

◆ getGigabytes()

◆ getGigahertz()

◆ getHertz()

◆ getHours()

◆ getKiloamps()

◆ getKilobytes()

◆ getKilohertz()

◆ getKilometers()

◆ getKilometersPerHour()

◆ getKilometersPerSecond()

◆ getKilovolts()

◆ getMegabytes()

◆ getMegahertz()

◆ getMeters()

◆ getMetersPerSecond()

◆ getMicroamps()

◆ getMicrometers()

◆ getMicrometersPerSecond()

◆ getMicroseconds()

◆ getMicrovolts()

◆ getMilliamps()

◆ getMillimeters()

◆ getMillimetersPerSecond()

◆ getMilliseconds()

◆ getMillivolts()

◆ getMinutes()

◆ getNanoamps()

◆ getNanometers()

◆ getNanometersPerSecond()

◆ getNanoseconds()

◆ getNanovolts()

◆ getRadians()

◆ getSeconds()

◆ getTerabytes()

◆ getVolts()

◆ getWeeks()

◆ isAmps() [1/2]

◆ isAmps() [2/2]

◆ isBytes() [1/2]

◆ isBytes() [2/2]

◆ isCentimeters() [1/2]

◆ isCentimeters() [2/2]

◆ isCentimetersPerSecond() [1/2]

◆ isCentimetersPerSecond() [2/2]

◆ isDays() [1/2]

◆ isDays() [2/2]

◆ isDegrees() [1/2]

◆ isDegrees() [2/2]

◆ isGigabytes() [1/2]

◆ isGigabytes() [2/2]

◆ isGigahertz() [1/2]

◆ isGigahertz() [2/2]

◆ isHertz() [1/2]

◆ isHertz() [2/2]

◆ isHours() [1/2]

◆ isHours() [2/2]

◆ isKiloamps() [1/2]

◆ isKiloamps() [2/2]

◆ isKilobytes() [1/2]

◆ isKilobytes() [2/2]

◆ isKilohertz() [1/2]

◆ isKilohertz() [2/2]

◆ isKilometers() [1/2]

◆ isKilometers() [2/2]

◆ isKilometersPerHour() [1/2]

◆ isKilometersPerHour() [2/2]

◆ isKilometersPerSecond() [1/2]

◆ isKilometersPerSecond() [2/2]

◆ isKilovolts() [1/2]

◆ isKilovolts() [2/2]

◆ isMegabytes() [1/2]