ActiveLib
Loading...
Searching...
No Matches
Public Member Functions | List of all members
active::setting::AngleValue Class Reference

#include <AngleValue.h>

Inheritance diagram for active::setting::AngleValue:
Inheritance graph
[legend]
Collaboration diagram for active::setting::AngleValue:
Collaboration graph
[legend]

Public Member Functions

 AngleValue (double val=0.0)
 
virtual utility::String operator() (const measure::AngleUnit &unit) const override
 
virtual Valueassign (const utility::String &val, const measure::AngleUnit &unit) override
 
Valueoperator= (const utility::String &val) override
 
- Public Member Functions inherited from active::setting::MeasuredValue< active::measure::AngleUnit >
 MeasuredValue ()
 
 MeasuredValue (double val)
 
 MeasuredValue (const active::measure::AngleUnit &unit, double val=0.0)
 
 MeasuredValue (UnitRetrieval unitFinder, double val=0.0)
 
Valueoperator= (const utility::String &val) override
 
virtual Valueoperator= (const Value &val) override
 
virtual Valueoperator= (bool val) override
 
virtual Valueoperator= (int32_t val) override
 
virtual Valueoperator= (uint32_t val) override
 
virtual Valueoperator= (int64_t val) override
 
virtual Valueoperator= (double val) override
 
virtual Valueoperator= (const active::utility::String &val) override
 
virtual Valueoperator= (const char *val) override
 
virtual Valueoperator= (const active::utility::Guid &val) override
 
virtual Valueoperator= (const active::utility::Time &val) override
 
Valueoperator= (const Value &val)
 
 operator utility::String () const override
 
virtual active::measure::AngleUnit getUnit () const
 
virtual void setUnit (const active::measure::AngleUnit &unit)
 
virtual void setUnit (UnitRetrieval unitFinder)
 
- Public Member Functions inherited from active::setting::ValueBase< T >
 ValueBase ()
 
 ValueBase (const T &val, Status stat=good)
 
 ValueBase (const Value &value)
 
 ValueBase (const utility::String &stringVal)
 
 ValueBase (const ValueBase &source)=default
 
virtual ValueclonePtr () const override
 
virtual bool operator== (const Value &ref) const override
 
bool operator!= (const Value &ref) const
 
virtual bool operator< (const Value &ref) const override
 
virtual operator bool () const override
 
virtual operator int32_t () const override
 
virtual operator uint32_t () const override
 
virtual operator int64_t () const override
 
virtual operator double () const override
 
virtual operator active::utility::String () const override
 
virtual operator active::utility::Guid () const override
 
virtual operator active::utility::Time () const override
 
virtual bool isNull () const override
 
virtual Type getType () const override
 
virtual void setDefault () override
 
Valueoperator= (const Value &val)
 
- Public Member Functions inherited from active::setting::Value
 Value (Status stat=good)
 
virtual ~Value ()=default
 
bool operator!= (const Value &ref) const
 
virtual bool isGood () const
 
- Public Member Functions inherited from active::utility::Cloner
virtual ~Cloner ()=default
 

Additional Inherited Members

- Public Types inherited from active::setting::MeasuredValue< active::measure::AngleUnit >
using Type
 
using UnitRetrieval
 Function retrieving a measument unit.
 
- Public Types inherited from active::setting::Value
enum class  Status { undefined = 0 , bad , good }
 The value status (defines whether a value has been explicitly set and (if so) if it's meaningful.
 
enum class  Type {
  null = 0 , boolType , idType , intType ,
  floatType , stringType , timeType
}
 Supported value types (broad groups, e.g. int32_t and int64_t are both intType)
 
using Unique = std::unique_ptr<Value>
 Unique pointer.
 
using Shared = std::shared_ptr<Value>
 Shared pointer.
 
using Option = std::optional<Value>
 Optional.
 
- Static Public Member Functions inherited from active::setting::Value
static std::optional< TypetypeFromName (const utility::String &text)
 
static utility::String nameForType (Type type)
 
- Public Attributes inherited from active::setting::ValueBase< T >
data = T()
 The value data.
 
- Public Attributes inherited from active::setting::Value
Status status
 The value status.
 

Detailed Description

An angle measurement value

Angles are always stored in radians with the convention that zero degrees aligns to the positive x axis and a positive angle sweeps in an anticlockwise direction (viewed along the negative direction of the z axis). Formatting determines how this is displayed/edited in the UI, e.g. surveyor conventions may orientate 0° to North (positive y axis) with positive sweep in a clockwise direction. 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 AngleValue.

Constructor & Destructor Documentation

◆ AngleValue()

active::setting::AngleValue::AngleValue ( double val = 0.0)
inline

Constructor

Parameters
valThe measurement value
Here is the caller graph for this function:

Member Function Documentation

◆ assign()

Value & AngleValue::assign ( const utility::String & val,
const measure::AngleUnit & unit )
overridevirtual

Assign a measurement value from a string

Parameters
valA string value to assign
unitThe input unit
Returns
A reference to this

Reimplemented from active::setting::MeasuredValue< active::measure::AngleUnit >.

Here is the call graph for this function:

◆ operator()()

String AngleValue::operator() ( const measure::AngleUnit & unit) const
overridevirtual

Get the measurement as a formatted string

Parameters
unitThe output unit
Returns
The measurement as a string

Reimplemented from active::setting::MeasuredValue< active::measure::AngleUnit >.

Here is the call graph for this function:

◆ operator=()

Value & active::setting::MeasuredValue< T >::operator= ( const utility::String & val)
inlineoverridevirtual

Assignment operator

Parameters
valA string value to assign
Returns
A reference to this

Reimplemented from active::setting::ValueBase< T >.


The documentation for this class was generated from the following files: