Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Attributes
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

 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.

 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.

 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>

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_TColStd_HSequenceOfHAsciiString 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 Handle_Units_Token Token () const
 Starting with <me>, returns a new Token object.

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 void Dump (const Standard_Integer ashift, const Standard_Integer alevel) const
 Useful for debugging

Protected Attributes

Handle_TColStd_HSequenceOfHAsciiString thesymbolssequence
Standard_Real thevalue

Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented in Units_ShiftedUnit.

Handle_Units_Quantity Units_Unit::Quantity ( ) const
Handle_TColStd_HSequenceOfHAsciiString Units_Unit::SymbolsSequence ( ) const
virtual Handle_Units_Token Units_Unit::Token ( ) const [virtual]

Reimplemented in Units_ShiftedUnit.


Field Documentation

Handle_TColStd_HSequenceOfHAsciiString Units_Unit::thesymbolssequence [protected]

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