This class is useful to describe units with a shifted origin in relation to another unit. A well known example is the Celsius degrees in relation to Kelvin degrees. The shift of the Celsius origin is 273.15 Kelvin degrees. More...

#include <Units_ShiftedUnit.hxx>

Inheritance diagram for Units_ShiftedUnit:

[legend]

Public Member Functions
	Units_ShiftedUnit (const char const aname, const char const asymbol, const double avalue, const double amove, const occ::handle< Units_Quantity > &aquantity)
	Creates and returns a shifted unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, <avalue> is the value in relation to the International System of Units, and <amove> is the gap in relation to another unit.

	Units_ShiftedUnit (const char const aname, const char const asymbol)
	Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit.

	Units_ShiftedUnit (const char *const aname)
	Creates and returns a unit. <aname> is the name of the unit.

void	Move (const double amove)
	Sets the field <themove> to <amove>

double	Move () const
	Returns the shifted value <themove>.

occ::handle< Units_Token >	Token () const override
	This redefined method returns a ShiftedToken object.

void	Dump (const int ashift, const int alevel) const override
	Useful for debugging.

Public Member Functions inherited from Units_Unit
	Units_Unit (const char const aname, const char const asymbol, const double avalue, const occ::handle< Units_Quantity > &aquantity)
	Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, and <avalue> is the value in relation to the International System of Units.

	Units_Unit (const char const aname, const char const asymbol)
	Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit.

	Units_Unit (const char *const aname)
	Creates and returns a unit. <aname> is the name of the unit.

TCollection_AsciiString	Name () const
	Returns the name of the unit <thename>

void	Symbol (const char *const asymbol)
	Adds a new symbol <asymbol> attached to <me>.

double	Value () const
	Returns the value in relation with the International System of Units.

occ::handle< Units_Quantity >	Quantity () const
	Returns <thequantity> contained in <me>.

occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > >	SymbolsSequence () const
	Returns the sequence of symbols <thesymbolssequence>

void	Value (const double avalue)
	Sets the value <avalue> to <me>.

void	Quantity (const occ::handle< Units_Quantity > &aquantity)
	Sets the physical Quantity <aquantity> to <me>.

bool	IsEqual (const char *const astring) const
	Compares all the symbols linked within <me> with the name of <atoken>, and returns True if there is one symbol equal to the name, False otherwise.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()=default
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

bool	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

bool	IsInstance (const char *const theTypeName) const
	Returns a true value if this is an instance of TypeName.

bool	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

bool	IsKind (const char *const theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

int	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.

int	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Attributes inherited from Units_Unit
occ::handle< NCollection_HSequence< occ::handle< TCollection_HAsciiString > > >	thesymbolssequence

double	thevalue

Detailed Description

This class is useful to describe units with a shifted origin in relation to another unit. A well known example is the Celsius degrees in relation to Kelvin degrees. The shift of the Celsius origin is 273.15 Kelvin degrees.

Constructor & Destructor Documentation

◆ Units_ShiftedUnit() [1/3]

Units_ShiftedUnit::Units_ShiftedUnit	(	const char *const	aname,
		const char *const	asymbol,
		const double	avalue,
		const double	amove,
		const occ::handle< Units_Quantity > &	aquantity )

Creates and returns a shifted unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, <avalue> is the value in relation to the International System of Units, and <amove> is the gap in relation to another unit.

For example Celsius degree of temperature is an instance of ShiftedUnit with <avalue> equal to 1. and <amove> equal to 273.15.

◆ Units_ShiftedUnit() [2/3]

Units_ShiftedUnit::Units_ShiftedUnit	(	const char *const	aname,
		const char *const	asymbol )

Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit.

◆ Units_ShiftedUnit() [3/3]

Units_ShiftedUnit::Units_ShiftedUnit ( const char *const aname )

Creates and returns a unit. <aname> is the name of the unit.

Member Function Documentation

◆ Dump()

void Units_ShiftedUnit::Dump	(	const int	ashift,
		const int	alevel ) const

overridevirtual

Useful for debugging.

Reimplemented from Units_Unit.

◆ Move() [1/2]

double Units_ShiftedUnit::Move ( ) const

Returns the shifted value <themove>.

◆ Move() [2/2]

void Units_ShiftedUnit::Move ( const double amove )

Sets the field <themove> to <amove>

◆ Token()

occ::handle< Units_Token > Units_ShiftedUnit::Token ( ) const