OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKernel
Units


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

#include <Units_ShiftedUnit.hxx>

Inheritance diagram for Units_ShiftedUnit:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT 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 Celcius dregee of temperature is an
instance of ShiftedUnit with <avalue> equal to 1. and
<amove> equal to 273.15.
.
Standard_EXPORT 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.
.
Standard_EXPORT Units_ShiftedUnit (const Standard_CString aname)
 Creates and returns a unit. <aname> is the name of
the unit.
.
Standard_EXPORT void Move (const Standard_Real amove)
 Sets the field <themove> to <amove>
.
Standard_EXPORT Standard_Real Move () const
 Returns the shifted value <themove>.
.
virtual Standard_EXPORT Handle_Units_Token Token () const
 This redefined method returns a ShiftedToken object.
.
virtual Standard_EXPORT void Dump (const Standard_Integer ashift, const Standard_Integer alevel) const
 Useful for debugging
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Standard_Real themove

Constructor & Destructor Documentation

Standard_EXPORT 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
 

Standard_EXPORT Units_ShiftedUnit::Units_ShiftedUnit const Standard_CString  aname,
const Standard_CString  asymbol
 

Standard_EXPORT Units_ShiftedUnit::Units_ShiftedUnit const Standard_CString  aname  ) 
 


Member Function Documentation

virtual Standard_EXPORT void Units_ShiftedUnit::Dump const Standard_Integer  ashift,
const Standard_Integer  alevel
const [virtual]
 

Reimplemented from Units_Unit.

Standard_EXPORT const Units_ShiftedUnit::Handle Standard_Type   )  const
 

Reimplemented from Units_Unit.

Standard_EXPORT Standard_Real Units_ShiftedUnit::Move  )  const
 

Standard_EXPORT void Units_ShiftedUnit::Move const Standard_Real  amove  ) 
 

virtual Standard_EXPORT Handle_Units_Token Units_ShiftedUnit::Token  )  const [virtual]
 

Reimplemented from Units_Unit.


Field Documentation

Standard_Real Units_ShiftedUnit::themove [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:14:14 2008 for OpenCASCADE by  doxygen 1.4.1