active::setting Namespace Reference

Classes
class	AngleValue
class	MeasuredValue
	Template specialisation of DoubleValue for values of measurement. More...
class	NullValue
class	Setting
	Base class for an identified setting for interprocess communication. More...
class	SettingList
	A list of settings. More...
class	Value
class	ValueBase
class	ValueSetting
	Setting containing any number of values, e.g. bool, string etc. More...

Typedefs
using	BoolValue = ValueBase<bool>
	A single boolean value.
using	DoubleValue = ValueBase<double>
	A double precision floating point value.
using	GuidValue = ValueBase<utility::Guid>
	A unique ID (guid) value.
using	Int32Value = ValueBase<int32_t>
	A single 32-bit integer value.
using	Int64Value = ValueBase<int64_t>
	A single 64-bit integer value.
using	AreaValue = MeasuredValue<active::measure::AreaUnit>
using	LengthValue = MeasuredValue<active::measure::LengthUnit>
using	MassValue = MeasuredValue<active::measure::MassUnit>
using	StringValue = ValueBase<utility::String>
	A single string value.
using	TimeValue = ValueBase<utility::Time>
	A single time value.
using	UInt32Value = ValueBase<uint32_t>
	A single unsigned 32-bit integer value.

Functions
bool	operator== (const Value::Unique &lhs, const Value::Unique &rhs)
bool	operator!= (const Value::Unique &lhs, const Value::Unique &rhs)
bool	operator< (const Value::Unique &lhs, const Value::Unique &rhs)
bool	operator== (const Value::Shared &lhs, const Value::Shared &rhs)
bool	operator!= (const Value::Shared &lhs, const Value::Shared &rhs)
bool	operator< (const Value::Shared &lhs, const Value::Shared &rhs)

Detailed Description

Copyright 2024 Ralph Wessel and Hugh Wessel Distributed under the MIT License (See accompanying file LICENSE.txt or copy at https://opensource.org/license/mit/)

Typedef Documentation

AreaValue

using active::setting::AreaValue = MeasuredValue<active::measure::AreaUnit>

An area measurement value

Areas are always stored in square metres, but formatting determines how this is displayed/edited in the UI. Refer to the Unit template for more detailed information about the presentation of measured values.

Refer to MeasuredValue for more detailed information and examples for using AreaValue.

LengthValue

using active::setting::LengthValue = MeasuredValue<active::measure::LengthUnit>

A length measurement value

Lengths are always stored in metres, but formatting determines how this is displayed/edited in the UI. Refer to the Unit template for more detailed information about the presentation of measured values.

Refer to MeasuredValue for more detailed information and examples for using LengthValue.

MassValue

using active::setting::MassValue = MeasuredValue<active::measure::MassUnit>

A mass measurement value

Mass is always stored in kilograms, but formatting determines how this is displayed/edited in the UI. Refer to the Unit template for more detailed information about the presentation of measured values.

Refer to MeasuredValue for more detailed information and examples for using MassValue.

Function Documentation

operator!=() [1/2]

bool active::setting::operator!= ( const Value::Shared & lhs, const Value::Shared & rhs )

inline

Inequality operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if the values are not identical

operator!=() [2/2]

bool active::setting::operator!= ( const Value::Unique & lhs, const Value::Unique & rhs )

inline

Inequality operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if the values are not identical

operator<() [1/2]

bool active::setting::operator< ( const Value::Shared & lhs, const Value::Shared & rhs )

inline

Less-than operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if lhs is less than rhs

operator<() [2/2]

bool active::setting::operator< ( const Value::Unique & lhs, const Value::Unique & rhs )

inline

Less-than operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if lhs is less than rhs

operator==() [1/2]

bool active::setting::operator== ( const Value::Shared & lhs, const Value::Shared & rhs )

inline

Equality operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if the values are identical

operator==() [2/2]

bool active::setting::operator== ( const Value::Unique & lhs, const Value::Unique & rhs )

inline

Equality operator

Parameters

lhs	The left value to compare
rhs	The right value to compare

Returns

True if the values are identical