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

FoundationClasses
TKernel
Units


Units_Unit Class Reference

This class defines an elementary word contained in
a physical quantity.
.

#include <Units_Unit.hxx>

Inheritance diagram for Units_Unit:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT Units_Unit (const Standard_CString aname)
 Creates and returns a unit. <aname> is the name of
the unit.
.
TCollection_AsciiString Name () const
 Returns the name of the unit <thename>
.
Standard_EXPORT void Symbol (const Standard_CString asymbol)
 Adds a new symbol <asymbol> attached to <me>.
.
Standard_Real Value () const
 Returns the value in relation with the International
System of Units.
.
Handle_Units_Quantity Quantity () const
 Returns <thequantity> contained in <me>.
.
Handle_Units_StringsSequence SymbolsSequence () const
 Returns the sequence of symbols <thesymbolssequence>
.
void Value (const Standard_Real avalue)
 Sets the value <avalue> to <me>.
.
void Quantity (const Handle(Units_Quantity)&aquantity)
 Sets the physical Quantity <aquantity> to <me>.
.
virtual Standard_EXPORT Handle_Units_Token Token () const
 Starting with <me>, returns a new Token object.
.
Standard_EXPORT 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.
.
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

Protected Attributes

Handle_Units_StringsSequence thesymbolssequence
Standard_Real thevalue

Private Attributes

Handle_TCollection_HAsciiString thename
Handle_Units_Quantity thequantity

Constructor & Destructor Documentation

Standard_EXPORT Units_Unit::Units_Unit const Standard_CString  aname,
const Standard_CString  asymbol,
const Standard_Real  avalue,
const Handle(Units_Quantity)&  aquantity
 

Standard_EXPORT Units_Unit::Units_Unit const Standard_CString  aname,
const Standard_CString  asymbol
 

Standard_EXPORT Units_Unit::Units_Unit const Standard_CString  aname  ) 
 


Member Function Documentation

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

Reimplemented in Units_ShiftedUnit.

Standard_EXPORT const Units_Unit::Handle Standard_Type   )  const
 

Reimplemented from MMgt_TShared.

Reimplemented in Units_ShiftedUnit.

Standard_EXPORT Standard_Boolean Units_Unit::IsEqual const Standard_CString  astring  )  const
 

TCollection_AsciiString Units_Unit::Name  )  const [inline]
 

void Units_Unit::Quantity const Handle(Units_Quantity)&  aquantity  )  [inline]
 

Handle_Units_Quantity Units_Unit::Quantity  )  const
 

Standard_EXPORT void Units_Unit::Symbol const Standard_CString  asymbol  ) 
 

Handle_Units_StringsSequence Units_Unit::SymbolsSequence  )  const
 

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

Reimplemented in Units_ShiftedUnit.

void Units_Unit::Value const Standard_Real  avalue  )  [inline]
 

Standard_Real Units_Unit::Value  )  const [inline]
 


Field Documentation

Handle_TCollection_HAsciiString Units_Unit::thename [private]
 

Handle_Units_Quantity Units_Unit::thequantity [private]
 

Handle_Units_StringsSequence Units_Unit::thesymbolssequence [protected]
 

Standard_Real Units_Unit::thevalue [protected]
 


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