Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
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.
 
void Creates ()
 Returns a UnitsDictionary object which contains the sequence of all the units you want to consider, physical quantity by physical quantity.
 
occ::handle< NCollection_HSequence< occ::handle< Units_Quantity > > > Sequence () const
 Returns the head of the sequence of physical quantities.
 
TCollection_AsciiString ActiveUnit (const char *const aquantity) const
 Returns for <aquantity> the active unit.
 
void Dump (const int 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.
 
void Dump (const occ::handle< Units_Dimensions > &adimensions) const
 Dumps for a designated physical dimensions <adimensions> all the previously stored units.
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor.
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing.
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter.
 
virtual ~Standard_Transient ()=default
 Destructor must be virtual.
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object.
 
bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type.
 
bool IsInstance (const char *const theTypeName) const
 Returns a true value if this is an instance of TypeName.
 
bool 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.
 
bool IsKind (const char *const 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.
 
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.
 
int GetRefCount () const noexcept
 Get the reference counter of this object.
 
void IncrementRefCounter () noexcept
 Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
 
int DecrementRefCounter () noexcept
 Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
 
virtual void Delete () const
 Memory deallocator for transient classes.
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object.
 
- Static Public Member Functions inherited from Standard_Transient
static constexpr const charget_type_name ()
 Returns a type descriptor about this object.
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class.
 

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 char *const 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 int 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 occ::handle< Units_Dimensions > & adimensions) const

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

◆ Sequence()

occ::handle< NCollection_HSequence< occ::handle< Units_Quantity > > > Units_UnitsDictionary::Sequence ( ) const

Returns the head of the sequence of physical quantities.


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