Open CASCADE Technology  7.7.0
Public Member Functions

Units_ShiftedUnit Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 Units_ShiftedUnit (const Standard_CString aname, const Standard_CString asymbol, const Standard_Real avalue, const Standard_Real amove, const 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. More...
 
 Units_ShiftedUnit (const Standard_CString aname, const Standard_CString asymbol)
 Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit. More...
 
 Units_ShiftedUnit (const Standard_CString aname)
 Creates and returns a unit. <aname> is the name of the unit. More...
 
void Move (const Standard_Real amove)
 Sets the field <themove> to <amove> More...
 
Standard_Real Move () const
 Returns the shifted value <themove>. More...
 
virtual Handle< Units_TokenToken () const override
 This redefined method returns a ShiftedToken object. More...
 
virtual void Dump (const Standard_Integer ashift, const Standard_Integer alevel) const override
 Useful for debugging. More...
 
- Public Member Functions inherited from Units_Unit
 Units_Unit (const Standard_CString aname, const Standard_CString asymbol, const Standard_Real avalue, const 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. More...
 
 Units_Unit (const Standard_CString aname, const Standard_CString asymbol)
 Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit. More...
 
 Units_Unit (const Standard_CString aname)
 Creates and returns a unit. <aname> is the name of the unit. More...
 
TCollection_AsciiString Name () const
 Returns the name of the unit <thename> More...
 
void Symbol (const Standard_CString asymbol)
 Adds a new symbol <asymbol> attached to <me>. More...
 
Standard_Real Value () const
 Returns the value in relation with the International System of Units. More...
 
Handle< Units_QuantityQuantity () const
 Returns <thequantity> contained in <me>. More...
 
Handle< TColStd_HSequenceOfHAsciiString > SymbolsSequence () const
 Returns the sequence of symbols <thesymbolssequence> More...
 
void Value (const Standard_Real avalue)
 Sets the value <avalue> to <me>. More...
 
void Quantity (const Handle< Units_Quantity > &aquantity)
 Sets the physical Quantity <aquantity> to <me>. More...
 
Standard_Boolean IsEqual (const Standard_CString 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. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
Standard_Boolean 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. More...
 
Standard_Boolean IsKind (const Standard_CString 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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 
- Protected Attributes inherited from Units_Unit
Handle< TColStd_HSequenceOfHAsciiString > thesymbolssequence
 
Standard_Real 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 Standard_CString  aname,
const Standard_CString  asymbol,
const Standard_Real  avalue,
const Standard_Real  amove,
const 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 Standard_CString  aname,
const Standard_CString  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 Standard_CString  aname)

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

Member Function Documentation

◆ Dump()

virtual void Units_ShiftedUnit::Dump ( const Standard_Integer  ashift,
const Standard_Integer  alevel 
) const
overridevirtual

Useful for debugging.

Reimplemented from Units_Unit.

◆ Move() [1/2]

Standard_Real Units_ShiftedUnit::Move ( ) const

Returns the shifted value <themove>.

◆ Move() [2/2]

void Units_ShiftedUnit::Move ( const Standard_Real  amove)

Sets the field <themove> to <amove>

◆ Token()

virtual Handle< Units_Token > Units_ShiftedUnit::Token ( ) const
overridevirtual

This redefined method returns a ShiftedToken object.

Reimplemented from Units_Unit.


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