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

#include <Unit.h>

Inheritance diagram for CompositeUnit:

Public Member Functions
	CompositeUnit (string cat_, string name_, string title_="", 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 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 int	subtype () const

virtual bool	containsRelativeTo (Unit *u) const

virtual MathStructure	generateMathStructure (bool make_division=false, bool set_null_prefixes=false) const

virtual void	setBaseExpression (string base_expression_)

virtual void	clear ()

Public Member Functions inherited from Unit
	Unit (string cat_, string name_, string plural_="", string singular_="", 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 (string s_system)

const string &	system () const

bool	useWithPrefixesByDefault () const

void	setUseWithPrefixesByDefault (bool use_with_prefixes)

bool	isCurrency () const

const string &	countries () const

void	setCountries (string country_names)

virtual const 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 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 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	hasComplexRelationTo (Unit *u) 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 (string cat_, string name_, string title_="", 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 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 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 (string sname, size_t index, bool force=true)

virtual void	addName (const ExpressionName &ename, size_t index=0, bool force=true)

virtual void	addName (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 string &sname, bool case_sensitive=true) const

virtual size_t	hasNameCaseSensitive (const 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 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 (string title_)

virtual const string &	description () const

virtual void	setDescription (string descr_)

virtual const string &	category () const

virtual void	setCategory (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)

Protected Attributes
string	sshort

vector< AliasUnit_Composite * >	units

Protected Attributes inherited from Unit
string	ssystem

string	scountries

bool	b_si

bool	b_use_with_prefixes

Protected Attributes inherited from ExpressionItem
string	scat

string	stitle

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

vector< ExpressionItem * >	v_refs

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 is only used to reference the unit in definitions of other units. They can not be used in expressions.

Composite units is definited 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.

◆ 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()).

◆ print()

virtual 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.

◆ 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:

libqalculate/Unit.h

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add()

◆ clear()

◆ containsRelativeTo()

◆ countUnits()

◆ generateMathStructure()

◆ get()

◆ print()

◆ subtype()