Open CASCADE Technology  7.3.0
Public Member Functions
Units_UnitsDictionary Class Reference

This class creates a dictionary of all the units you want to know. More...

#include <Units_UnitsDictionary.hxx>

Inheritance diagram for Units_UnitsDictionary:
Inheritance graph
[legend]

Public Member Functions

 Units_UnitsDictionary ()
 Returns an empty instance of UnitsDictionary. More...
 
void Creates ()
 Returns a UnitsDictionary object which contains the sequence of all the units you want to consider, physical quantity by physical quantity. More...
 
Handle< Units_QuantitiesSequence > Sequence () const
 Returns the head of the sequence of physical quantities. More...
 
TCollection_AsciiString ActiveUnit (const Standard_CString aquantity) const
 Returns for <aquantity> the active unit. More...
 
void Dump (const Standard_Integer alevel) const
 Dumps only the sequence of quantities without the units if <alevel> is equal to zero, and for each quantity all the units stored if <alevel> is equal to one. More...
 
void Dump (const Handle< Units_Dimensions > &adimensions) const
 Dumps for a designated physical dimensions <adimensions> all the previously stored units. 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 creates a dictionary of all the units you want to know.

Constructor & Destructor Documentation

◆ Units_UnitsDictionary()

Units_UnitsDictionary::Units_UnitsDictionary ( )

Returns an empty instance of UnitsDictionary.

Member Function Documentation

◆ ActiveUnit()

TCollection_AsciiString Units_UnitsDictionary::ActiveUnit ( const Standard_CString  aquantity) const

Returns for <aquantity> the active unit.

◆ Creates()

void Units_UnitsDictionary::Creates ( )

Returns a UnitsDictionary object which contains the sequence of all the units you want to consider, physical quantity by physical quantity.

◆ Dump() [1/2]

void Units_UnitsDictionary::Dump ( const Standard_Integer  alevel) const

Dumps only the sequence of quantities without the units if <alevel> is equal to zero, and for each quantity all the units stored if <alevel> is equal to one.

◆ Dump() [2/2]

void Units_UnitsDictionary::Dump ( const Handle< Units_Dimensions > &  adimensions) const

Dumps for a designated physical dimensions <adimensions> all the previously stored units.

◆ Sequence()

Handle< Units_QuantitiesSequence > Units_UnitsDictionary::Sequence ( ) const

Returns the head of the sequence of physical quantities.


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