API Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ScaledUnit Struct Reference

A unit that describes a simple scale (think meters vs feet) More...

#include <UnitTypes.h>

Inheritance diagram for ScaledUnit:
[legend]
Collaboration diagram for ScaledUnit:
[legend]

Public Member Functions

virtual const TranslatedString & abbreviation (uint01 direction=X) const override
 
virtual Unit * clone (const String &name, const TranslatedString &translated_id) const override
 
virtual fltp08 convertFromString (const String &unit_string, uint01 direction=X) const override
 
virtual fltp08 convertFromUnit (const fltp08 &program_space, const uint01 direction=X) const override
 
virtual Ray< 3, fltp08 > convertFromUnit (const Ray< 3, fltp08 > &program_space) const override
 
virtual Vertex< 3, fltp08 > convertFromUnit (const Vertex< 3, fltp08 > &program_space) const override
 
virtual String convertToString (const fltp08 &program_space, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, bool include_abv=true, uint01 direction=X) const override
 
virtual fltp08 convertToUnit (const fltp08 &program_space, const uint01 direction=X) const override
 
virtual Ray< 3, fltp08 > convertToUnit (const Ray< 3, fltp08 > &program_space) const override
 
virtual Vertex< 3, fltp08 > convertToUnit (const Vertex< 3, fltp08 > &program_space) const override
 
virtual fltp08 fromString (const String &unit_string, uint01 direction=X) const override
 
virtual Matrix< fltp08 > matrix () const override
 
 ScaledUnit (String name, TranslatedString translated_id, TranslatedString abbreviation, fltp08 scale)
 
virtual const Unit * subUnit (uint01) const override
 
- Public Member Functions inherited from Unit
virtual Unit * clone () const
 
template<class t_angle_type >
Angle< t_angle_type > convertAngleFromUnit (const fltp08 &unit_space, uint01 direction=X) const
 
template<class t_angle_type >
String convertToString (const Angle< t_angle_type > &program_space, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, bool include_abv=true, uint01 direction=X) const
 
template<class t_angle_type >
fltp08 convertToUnit (const Angle< t_angle_type > &program_space, uint01 direction=X) const
 
virtual fltp08 epsilon (fltp08 value, uint01 direction=X) const
 
virtual String getNextPreferredSeparator (const String &current_string, uint01 direction=X) const
 
bool operator== (const Unit &other) const
 
virtual String toFormula (const String &unit_string, uint01 direction=X) const
 
String toString (const fltp08 &unit_space, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, bool include_abv=true, uint01 direction=X) const
 
virtual void toString (String &string, const fltp08 &unit_space, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits, bool include_abv=true, uint01 direction=X) const
 
virtual TranslatedString translatedAxisName (uint04 index) const
 
TranslatedString translatedName () const
 
 Unit (String name, TranslatedString translated_id)
 
virtual ~Unit ()=default
 

Public Attributes

const TranslatedString core_abbreviation
 
const fltp08 scale
 
- Public Attributes inherited from Unit
TranslatedString axis_abbreviations [4]
 
TranslatedString axis_name_ids [4]
 
const String name
 
const TranslatedString translated_id
 

Additional Inherited Members

- Static Protected Member Functions inherited from Unit
static Buffer< String > OperatorSplit (const String &string)
 

Detailed Description

A unit that describes a simple scale (think meters vs feet)

autotoc_md672

Constructor & Destructor Documentation

◆ ScaledUnit()

ScaledUnit ( String name,
TranslatedString translated_id,
TranslatedString abbreviation,
fltp08 scale )
inline

Member Function Documentation

◆ abbreviation()

virtual const TranslatedString & abbreviation ( uint01 direction = X) const
inlinenodiscardoverridevirtual

Implements Unit.

◆ clone()

virtual Unit * clone ( const String & name,
const TranslatedString & translated_id ) const
nodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit, DDMMSSAngleUnit, ThreePartAngleUnit, TwoPartAngleUnit, and TwoPartUnit.

◆ convertFromString()

virtual fltp08 convertFromString ( const String & unit_string,
uint01 direction = X ) const
inlinenodiscardoverridevirtual

Reimplemented from Unit.

◆ convertFromUnit() [1/3]

virtual fltp08 convertFromUnit ( const fltp08 & program_space,
const uint01 direction = X ) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ convertFromUnit() [2/3]

virtual Ray< 3, fltp08 > convertFromUnit ( const Ray< 3, fltp08 > & program_space) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ convertFromUnit() [3/3]

virtual Vertex< 3, fltp08 > convertFromUnit ( const Vertex< 3, fltp08 > & program_space) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ convertToString()

virtual String convertToString ( const fltp08 & program_space,
bool add_comma,
uint04 min_decimals,
uint04 max_decimals,
uint04 min_digits,
bool include_abv = true,
uint01 direction = X ) const
inlinenodiscardoverridevirtual

Reimplemented from Unit.

◆ convertToUnit() [1/3]

virtual fltp08 convertToUnit ( const fltp08 & program_space,
const uint01 direction = X ) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ convertToUnit() [2/3]

virtual Ray< 3, fltp08 > convertToUnit ( const Ray< 3, fltp08 > & program_space) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ convertToUnit() [3/3]

virtual Vertex< 3, fltp08 > convertToUnit ( const Vertex< 3, fltp08 > & program_space) const
inlinenodiscardoverridevirtual

Implements Unit.

Reimplemented in AngleUnit.

◆ fromString()

virtual fltp08 fromString ( const String & unit_string,
uint01 direction = X ) const
inlinenodiscardoverridevirtual

Reimplemented from Unit.

Reimplemented in DDMMSSAngleUnit, ThreePartAngleUnit, TwoPartAngleUnit, and TwoPartUnit.

◆ matrix()

virtual Matrix< fltp08 > matrix ( ) const
inlinenodiscardoverridevirtual

Implements Unit.

◆ subUnit()

virtual const Unit * subUnit ( uint01 ) const
inlinenodiscardoverridevirtual

Implements Unit.

Member Data Documentation

◆ core_abbreviation

const TranslatedString core_abbreviation

◆ scale

const fltp08 scale
The documentation for this struct was generated from the following file: