Open CASCADE Technology  7.4.1.dev
Public Member Functions
Units_Quantity Class Reference

This class stores in its field all the possible units of all the unit systems for a given physical quantity. Each unit's value is expressed in the S.I. unit system. More...

#include <Units_Quantity.hxx>

Inheritance diagram for Units_Quantity:
Inheritance graph
[legend]

Public Member Functions

 Units_Quantity (const Standard_CString aname, const Handle< Units_Dimensions > &adimensions, const Handle< Units_UnitsSequence > &aunitssequence)
 Creates a new Quantity object with <aname> which is the name of the physical quantity, <adimensions> which is the physical dimensions, and <aunitssequence> which describes all the units known for this quantity. More...
 
TCollection_AsciiString Name () const
 Returns in a AsciiString from TCollection the name of the quantity. More...
 
Handle< Units_DimensionsDimensions () const
 Returns the physical dimensions of the quantity. More...
 
Handle< Units_UnitsSequence > Sequence () const
 Returns <theunitssequence>, which is the sequence of all the units stored for this physical quantity. More...
 
Standard_Boolean IsEqual (const Standard_CString astring) const
 Returns True if the name of the Quantity <me> is equal to <astring>, False otherwise. More...
 
void Dump (const Standard_Integer ashift, const Standard_Integer alevel) const
 Useful for debugging. 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...
 

Detailed Description

This class stores in its field all the possible units of all the unit systems for a given physical quantity. Each unit's value is expressed in the S.I. unit system.

Constructor & Destructor Documentation

◆ Units_Quantity()

Units_Quantity::Units_Quantity ( const Standard_CString  aname,
const Handle< Units_Dimensions > &  adimensions,
const Handle< Units_UnitsSequence > &  aunitssequence 
)

Creates a new Quantity object with <aname> which is the name of the physical quantity, <adimensions> which is the physical dimensions, and <aunitssequence> which describes all the units known for this quantity.

Member Function Documentation

◆ Dimensions()

Handle< Units_Dimensions > Units_Quantity::Dimensions ( ) const

Returns the physical dimensions of the quantity.

◆ Dump()

void Units_Quantity::Dump ( const Standard_Integer  ashift,
const Standard_Integer  alevel 
) const

Useful for debugging.

◆ IsEqual()

Standard_Boolean Units_Quantity::IsEqual ( const Standard_CString  astring) const

Returns True if the name of the Quantity <me> is equal to <astring>, False otherwise.

◆ Name()

TCollection_AsciiString Units_Quantity::Name ( ) const

Returns in a AsciiString from TCollection the name of the quantity.

◆ Sequence()

Handle< Units_UnitsSequence > Units_Quantity::Sequence ( ) const

Returns <theunitssequence>, which is the sequence of all the units stored for this physical quantity.


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