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:

Public Member Functions
	Units_Quantity (const char *const aname, const occ::handle< Units_Dimensions > &adimensions, const occ::handle< NCollection_HSequence< occ::handle< Units_Unit > > > &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.
TCollection_AsciiString	Name () const
	Returns in a AsciiString from TCollection the name of the quantity.
occ::handle< Units_Dimensions >	Dimensions () const
	Returns the physical dimensions of the quantity.
occ::handle< NCollection_HSequence< occ::handle< Units_Unit > > >	Sequence () const
	Returns <theunitssequence>, which is the sequence of all the units stored for this physical quantity.
bool	IsEqual (const char *const astring) const
	Returns True if the name of the Quantity <me> is equal to <astring>, False otherwise.
void	Dump (const int ashift, const int alevel) const
	Useful for debugging.
Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.
	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.
Standard_Transient &	operator= (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_Transient *	This () 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 char *	get_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 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 char *const	aname,
		const occ::handle< Units_Dimensions > &	adimensions,
		const occ::handle< NCollection_HSequence< occ::handle< Units_Unit > > > &	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()

occ::handle< Units_Dimensions > Units_Quantity::Dimensions

(

)

const

Returns the physical dimensions of the quantity.

Dump()

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

Useful for debugging.

IsEqual()

bool Units_Quantity::IsEqual

(

const char *const

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()

occ::handle< NCollection_HSequence< occ::handle< Units_Unit > > > 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:

• Units_Quantity.hxx