libqalculate-1.0.0
Public Member Functions | Protected Attributes | List of all members
Prefix Class Referenceabstract

Abstract class for prefixes. More...

#include <Prefix.h>

Inheritance diagram for Prefix:
BinaryPrefix DecimalPrefix NumberPrefix

Public Member Functions

 Prefix (string long_name, string short_name="", string unicode_name="")
 
const string & shortName (bool return_long_if_no_short=true, bool use_unicode=false) const
 
const string & longName (bool return_short_if_no_long=true, bool use_unicode=false) const
 
const string & unicodeName (bool return_short_if_no_uni=true) const
 
void setShortName (string short_name)
 
void setLongName (string long_name)
 
void setUnicodeName (string unicode_name)
 
const string & name (bool short_default=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
 
virtual Number value (const Number &nexp) const =0
 
virtual Number value (int iexp) const =0
 
virtual Number value () const =0
 
virtual int type () const =0
 

Protected Attributes

string l_name
 
string s_name
 
string u_name
 

Detailed Description

Abstract class for prefixes.

A prefix is prepended to a unit to specificy a quantity multiplicator. A prefix has a numerical value which raised to the units power defines the quantity. In for example the expression "3 kilometers", meter is the unit, 3 is regular quantity, and kilo is a prefix with a value 1000, thus the example equals "3000 meters". If the unit instead had been squared, the value of the prefix would have been raised by two and the total quantity would have been 3.000.000.

Prefixes can have up to free different three names – a long name, a short name and a short unicode name. The unicode name is an alternative to the short name that is preferred if unicode characters can be displayed. The names or used to reference the prefix in mathematical expressions and to display a prefix in a result.

Constructor & Destructor Documentation

◆ Prefix()

Prefix::Prefix ( string  long_name,
string  short_name = "",
string  unicode_name = "" 
)

Create a prefix.

Parameters
long_nameLong name.
short_nameShort name.
unicode_nameUnicode name.

Member Function Documentation

◆ longName()

const string& Prefix::longName ( bool  return_short_if_no_long = true,
bool  use_unicode = false 
) const

Returns the long name of the prefix.

Parameters
return_short_if_no_longIf the short name shall be returned if the prefix has not got a long name (if it is empty).
use_unicodeIf a unicode version of the name is allowed and preferred.
Returns
The long name of the prefix.

◆ name()

const string& Prefix::name ( bool  short_default = true,
bool  use_unicode = false,
bool(*)(const char *, void *)  can_display_unicode_string_function = NULL,
void *  can_display_unicode_string_arg = NULL 
) const

Returns a preferred name of the prefix.

Parameters
short_defaultIf a short name is preferred.
use_unicodeIf a unicode name is preferred.
can_display_unicode_string_functionFunction that tests if the unicode characters in a name can be displayed. If the function returns false, the name will be rejected.
can_display_unicode_string_argArgument to pass to the above test function.
Returns
A preferred name.

◆ setLongName()

void Prefix::setLongName ( string  long_name)

Sets the long name of the prefix.

Parameters
long_nameThe new long name for the prefix.

◆ setShortName()

void Prefix::setShortName ( string  short_name)

Sets the short name of the prefix.

Parameters
short_nameThe new short name for the prefix.

◆ setUnicodeName()

void Prefix::setUnicodeName ( string  unicode_name)

Sets the unicode name of the prefix. The unicode name is an alternative to the short name that is preferred if unicode characters can be displayed.

Parameters
unicode_nameThe new unicode name for the prefix.

◆ shortName()

const string& Prefix::shortName ( bool  return_long_if_no_short = true,
bool  use_unicode = false 
) const

Returns the short name of the prefix.

Parameters
return_long_if_no_shortIf the long name shall be returned if the prefix has not got a short name (if it is empty).
use_unicodeIf a unicode version of the name is allowed and preferred.
Returns
The short name of the prefix.

◆ type()

virtual int Prefix::type ( ) const
pure virtual

Returns type, subclass, of the prefix. This can be PREFIX_DECIMAL for prefixes of the class DecimalPrefix, PREFIX_BINARY for BinaryPrefix, or PREFIX_NUMBER for NumberPrefix.

Returns
The type of the prefix.

Implemented in NumberPrefix, BinaryPrefix, and DecimalPrefix.

◆ unicodeName()

const string& Prefix::unicodeName ( bool  return_short_if_no_uni = true) const

Returns the unicode name of the prefix.

Parameters
return_short_if_no_uniIf the short name shall be returned if the prefix has not got a unicode name (if it is empty).
Returns
The unicode name of the prefix.

◆ value() [1/3]

virtual Number Prefix::value ( const Number nexp) const
pure virtual

Returns the value of the prefix.

Parameters
nexpThe power of the prefixed unit.
Returns
The value of the prefix.

Implemented in NumberPrefix, BinaryPrefix, and DecimalPrefix.

◆ value() [2/3]

virtual Number Prefix::value ( int  iexp) const
pure virtual

Returns the value of the prefix.

Parameters
iexpThe power of the prefixed unit.
Returns
The value of the prefix.

Implemented in NumberPrefix, BinaryPrefix, and DecimalPrefix.

◆ value() [3/3]

virtual Number Prefix::value ( ) const
pure virtual

Returns the value of the prefix.

Returns
The value of the prefix.

Implemented in NumberPrefix, BinaryPrefix, and DecimalPrefix.


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