CompositeUnit Class Reference

A unit consisting of a number of other units. More...

`#include <Unit.h>`

Inheritance diagram for CompositeUnit:

## Public Member Functions

| CompositeUnit (std::string cat_, std::string name_, std::string title_="", std::string base_expression_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
| CompositeUnit (const CompositeUnit *unit)
virtual ExpressionItem * | copy () const
virtual void | set (const ExpressionItem *item)
virtual void | add (Unit *u, int exp=1, Prefix *prefix=NULL)
virtual Unit * | get (size_t index, int *exp=NULL, Prefix **prefix=NULL) const
virtual void | setExponent (size_t index, int exp)
virtual void | setPrefix (size_t index, Prefix *prefix)
virtual size_t | countUnits () const
virtual size_t | find (Unit *u) const
virtual void | del (size_t index)
virtual std::string | print (bool plural_, bool short_, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual std::string | print (const PrintOptions &po, bool format=false, int tagtype=0, bool input=false, bool plural=true) const
virtual int | subtype () const
virtual bool | containsRelativeTo (Unit *u) const
virtual bool | hasNonlinearRelationToBase () const
virtual bool | hasApproximateRelationToBase (bool check_variables=false, bool ignore_high_precision_intervals=false) const
virtual MathStructure | generateMathStructure (bool make_division=false, bool set_null_prefixes=false) const
virtual void | setBaseExpression (std::string base_expression_)
virtual void | clear ()
Public Member Functions inherited from Unit
| Unit (std::string cat_, std::string name_, std::string plural_="", std::string singular_="", std::string title_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
| Unit (const Unit *unit)
bool | isSIUnit () const
void | setAsSIUnit ()
void | setSystem (std::string s_system)
const std::string & | system () const
bool | useWithPrefixesByDefault () const
int | maxPreferredPrefix () const
int | minPreferredPrefix () const
int | defaultPrefix () const
void | setUseWithPrefixesByDefault (bool use_with_prefixes)
void | setMaxPreferredPrefix (int exp)
void | setMinPreferredPrefix (int exp)
void | setDefaultPrefix (int exp)
bool | isCurrency () const
const std::string & | countries () const
void | setCountries (std::string country_names)
virtual const std::string & | plural (bool return_singular_if_no_plural=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const std::string & | singular (bool return_abbreviation_if_no_singular=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const std::string & | abbreviation (bool return_singular_if_no_abbreviation=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual bool | isUsedByOtherUnits () const
virtual Unit * | baseUnit () const
virtual MathStructure & | convertToBaseUnit (MathStructure &mvalue, MathStructure &mexp) const
virtual MathStructure & | convertFromBaseUnit (MathStructure &mvalue, MathStructure &mexp) const
virtual MathStructure & | convertToBaseUnit (MathStructure &mvalue) const
virtual MathStructure & | convertFromBaseUnit (MathStructure &mvalue) const
virtual MathStructure | convertToBaseUnit () const
virtual MathStructure | convertFromBaseUnit () const
virtual int | baseExponent (int exp=1) const
virtual int | type () const
virtual bool | isChildOf (Unit *u) const
virtual bool | isParentOf (Unit *u) const
virtual bool | hasNonlinearRelationTo (Unit *u) const
virtual bool | hasApproximateRelationTo (Unit *u, bool check_variables=false, bool ignore_high_precision_intervals=false) const
bool | convert (Unit *u, MathStructure &mvalue, MathStructure &exp) const
bool | convert (Unit *u, MathStructure &mvalue) const
MathStructure | convert (Unit *u, bool *converted=NULL) const
Public Member Functions inherited from ExpressionItem
| ExpressionItem (std::string cat_, std::string name_, std::string title_="", std::string descr_="", bool is_local=true, bool is_builtin=false, bool is_active=true)
virtual bool | destroy ()
bool | isRegistered () const
void | setRegistered (bool is_registered)
| For internal use.
virtual const std::string & | name (bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const std::string & | referenceName () const
virtual const ExpressionName & | preferredName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const ExpressionName & | preferredInputName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const ExpressionName & | preferredDisplayName (bool abbreviation=false, bool use_unicode=false, bool plural=false, bool reference=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const ExpressionName & | getName (size_t index) const
virtual void | setName (const ExpressionName &ename, size_t index=1, bool force=true)
virtual void | setName (std::string sname, size_t index, bool force=true)
virtual void | addName (const ExpressionName &ename, size_t index=0, bool force=true)
virtual void | addName (std::string sname, size_t index=0, bool force=true)
virtual size_t | countNames () const
virtual void | clearNames ()
virtual void | clearNonReferenceNames ()
virtual void | removeName (size_t index)
virtual size_t | hasName (const std::string &sname, bool case_sensitive=true) const
virtual size_t | hasNameCaseSensitive (const std::string &sname) const
virtual const ExpressionName & | findName (int abbreviation=-1, int use_unicode=-1, int plural=-1, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual const std::string & | title (bool return_name_if_no_title=true, bool use_unicode=false, bool(*can_display_unicode_string_function)(const char *, void *)=NULL, void *can_display_unicode_string_arg=NULL) const
virtual void | setTitle (std::string title_)
virtual const std::string & | description () const
virtual void | setDescription (std::string descr_)
virtual const std::string & | category () const
virtual void | setCategory (std::string cat_)
virtual bool | hasChanged () const
virtual void | setChanged (bool has_changed)
virtual bool | isLocal () const
virtual bool | setLocal (bool is_local=true, int will_be_active=-1)
virtual bool | isBuiltin () const
virtual bool | isApproximate () const
virtual void | setApproximate (bool is_approx=true)
virtual int | precision () const
virtual void | setPrecision (int prec)
virtual bool | isActive () const
virtual void | setActive (bool is_active)
virtual bool | isHidden () const
virtual void | setHidden (bool is_hidden)
virtual int | refcount () const
virtual void | ref ()
virtual void | unref ()
virtual void | ref (ExpressionItem *o)
virtual void | unref (ExpressionItem *o)
virtual ExpressionItem * | getReferencer (size_t index=1) const
virtual bool | changeReference (ExpressionItem *o_from, ExpressionItem *o_to)
virtual int | id () const

## Protected Attributes

std::string | sshort
std::vector< AliasUnit_Composite * > | units
Protected Attributes inherited from Unit
std::string | ssystem
std::string | scountries
bool | b_si
unsigned short | b_use_with_prefixes
Protected Attributes inherited from ExpressionItem
std::string | scat
std::string | stitle
std::string | sdescr
bool | b_local
bool | b_changed
bool | b_builtin
bool | b_approx
bool | b_active
bool | b_registered
bool | b_hidden
bool | b_destroyed
int | i_ref
int | i_precision
std::vector< ExpressionItem * > | v_refs
std::vector< ExpressionName > | names

## Detailed Description

A unit consisting of a number of other units.

Composite units are defined by a unit expression with multiple units. Composite units often have an alias unit associated with them, as they do not have a reference name on their own. For example, a joule is defined as an alias defined in relation to a composite unit defined as "Newton * meter".

The names of composite units are only used to reference the unit in definitions of other units. They can not be used in expressions.

Composite units are defined as a composition of units. The units, with prefixes and exponents, can either be added one by one with add() or parsed from an expression (ex. "cm^3/g) with setBaseExpression().

## Member Function Documentation

## add()

virtual void CompositeUnit::add | ( | Unit * | u,
|  | int | exp = `1`,
|  | Prefix * | prefix = `NULL`
| ) |  |

virtual

Adds a sub/base unit with specified exponent and an optional prefix.

Parameters

  u | Unit.
  exp | Exponent.
  prefix | Prefix.

## clear()

virtual void CompositeUnit::clear | ( |  | ) |

virtual

Removes all sub/base units.

## containsRelativeTo()

virtual bool CompositeUnit::containsRelativeTo | ( | Unit * | u | ) | const

virtual

If this unit contains a sub/base unit with a relation to the specified unit.

Reimplemented from Unit.

## copy()

virtual ExpressionItem * CompositeUnit::copy | ( |  | ) | const

virtual

Reimplemented from Unit.

## countUnits()

virtual size_t CompositeUnit::countUnits | ( |  | ) | const

virtual

Returns the number of sub/base units

## generateMathStructure()

virtual MathStructure CompositeUnit::generateMathStructure | ( | bool | make_division = `false`,
|  | bool | set_null_prefixes = `false`
| ) |  | const

virtual

Creates a MathStructure with the sub/base units of the unit.

## get()

virtual Unit * CompositeUnit::get | ( | size_t | index,
|  | int * | exp = `NULL`,
|  | Prefix ** | prefix = `NULL`
| ) |  | const

virtual

Retrieves information about a sub/base unit

Parameters

  | index | Index starting at 1.
  [out] | exp | Exponent.
  [out] | prefix | Prefix.

Returns
  Sub/base unit (AliasUnit_Composite::firstBaseUnit()).

## hasApproximateRelationToBase()

virtual bool CompositeUnit::hasApproximateRelationToBase | ( | bool | check_variables = `false`,
|  | bool | ignore_high_precision_intervals = `false`
| ) |  | const

virtual

Reimplemented from Unit.

## hasNonlinearRelationToBase()

virtual bool CompositeUnit::hasNonlinearRelationToBase | ( |  | ) | const

virtual

Reimplemented from Unit.

## print() [1/2]

virtual std::string CompositeUnit::print | ( | bool | plural_,
|  | bool | short_,
|  | bool | use_unicode = `false`,
|  | bool(*)(const char *, void *) | can_display_unicode_string_function = `NULL`,
|  | void * | can_display_unicode_string_arg = `NULL`
| ) |  | const

virtual

Prints out the sub/base units with prefixes and exponents. This is the representation of the unit in expressions.

Reimplemented from Unit.

## print() [2/2]

virtual std::string CompositeUnit::print | ( | const PrintOptions & | po,
|  | bool | format = `false`,
|  | int | tagtype = `0`,
|  | bool | input = `false`,
|  | bool | plural = `true`
| ) |  | const

virtual

Reimplemented from Unit.

## set()

virtual void CompositeUnit::set | ( | const ExpressionItem * | item | ) |

virtual

Reimplemented from Unit.

## subtype()

virtual int CompositeUnit::subtype | ( |  | ) | const

virtual

Returns the subtype of the unit, corresponding to which subsubclass the object belongs to.

Returns
  UnitSubtype.

Reimplemented from Unit.

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

- /opt/local/var/macports/build/_opt_bblocal_var_buildworker_ports_build_ports_math_libqalculate/libqalculate/work/libqalculate-4.9.0/libqalculate/Unit.h