Units_Dimensions Class Reference

This class includes all the methods to create and manipulate the dimensions of the physical quantities. More...

#include <Units_Dimensions.hxx>

Inheritance diagram for Units_Dimensions:

Public Member Functions
	Units_Dimensions (const Standard_Real amass, const Standard_Real alength, const Standard_Real atime, const Standard_Real anelectriccurrent, const Standard_Real athermodynamictemperature, const Standard_Real anamountofsubstance, const Standard_Real aluminousintensity, const Standard_Real aplaneangle, const Standard_Real asolidangle)
	Returns a Dimensions object which represents the dimension of a physical quantity. Each of the <amass>, <alength>, <atime>, <anelectriccurrent>, <athermodynamictemperature>, <anamountofsubstance>, <aluminousintensity>, <aplaneangle>, <asolidangle> are the powers for the 7 fundamental units of physical quantity and the 2 secondary fundamental units of physical quantity.
Standard_Real	Mass () const
	Returns the power of mass stored in the dimensions.
Standard_Real	Length () const
	Returns the power of length stored in the dimensions.
Standard_Real	Time () const
	Returns the power of time stored in the dimensions.
Standard_Real	ElectricCurrent () const
	Returns the power of electrical intensity (current) stored in the dimensions.
Standard_Real	ThermodynamicTemperature () const
	Returns the power of temperature stored in the dimensions.
Standard_Real	AmountOfSubstance () const
	Returns the power of quantity of material (mole) stored in the dimensions.
Standard_Real	LuminousIntensity () const
	Returns the power of light intensity stored in the dimensions.
Standard_Real	PlaneAngle () const
	Returns the power of plane angle stored in the dimensions.
Standard_Real	SolidAngle () const
	Returns the power of solid angle stored in the dimensions.
Standard_CString	Quantity () const
	Returns the quantity string of the dimension.
Handle< Units_Dimensions >	Multiply (const Handle< Units_Dimensions > &adimensions) const
	Creates and returns a new Dimensions object which is the result of the multiplication of <me> and <adimensions>.
Handle< Units_Dimensions >	Divide (const Handle< Units_Dimensions > &adimensions) const
	Creates and returns a new Dimensions object which is the result of the division of <me> by <adimensions>.
Handle< Units_Dimensions >	Power (const Standard_Real anexponent) const
	Creates and returns a new Dimensions object which is the result of the power of <me> and <anexponent>.
Standard_Boolean	IsEqual (const Handle< Units_Dimensions > &adimensions) const
	Returns true if <me> and <adimensions> have the same dimensions, false otherwise.
Standard_Boolean	IsNotEqual (const Handle< Units_Dimensions > &adimensions) const
	Returns false if <me> and <adimensions> have the same dimensions, true otherwise.
void	Dump (const Standard_Integer ashift) const
	Useful for degugging.
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 ()
	Destructor must be virtual.
virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.
Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.
Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.
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.
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.
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.
Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.
void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.
Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.
virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Handle< Units_Dimensions >	ALess ()
static Handle< Units_Dimensions >	AMass ()
static Handle< Units_Dimensions >	ALength ()
static Handle< Units_Dimensions >	ATime ()
static Handle< Units_Dimensions >	AElectricCurrent ()
static Handle< Units_Dimensions >	AThermodynamicTemperature ()
static Handle< Units_Dimensions >	AAmountOfSubstance ()
static Handle< Units_Dimensions >	ALuminousIntensity ()
static Handle< Units_Dimensions >	APlaneAngle ()
static Handle< Units_Dimensions >	ASolidAngle ()
	Returns the basic dimensions.
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.

Additional Inherited Members
typedef void	base_type
	Returns a type descriptor about this object.

Detailed Description

This class includes all the methods to create and manipulate the dimensions of the physical quantities.

Constructor & Destructor Documentation

Units_Dimensions()

Units_Dimensions::Units_Dimensions	(	const Standard_Real	amass,
		const Standard_Real	alength,
		const Standard_Real	atime,
		const Standard_Real	anelectriccurrent,
		const Standard_Real	athermodynamictemperature,
		const Standard_Real	anamountofsubstance,
		const Standard_Real	aluminousintensity,
		const Standard_Real	aplaneangle,
		const Standard_Real	asolidangle )

Returns a Dimensions object which represents the dimension of a physical quantity. Each of the <amass>, <alength>, <atime>, <anelectriccurrent>, <athermodynamictemperature>, <anamountofsubstance>, <aluminousintensity>, <aplaneangle>, <asolidangle> are the powers for the 7 fundamental units of physical quantity and the 2 secondary fundamental units of physical quantity.

Member Function Documentation

AAmountOfSubstance()

static Handle< Units_Dimensions > Units_Dimensions::AAmountOfSubstance ( )

static

AElectricCurrent()

static Handle< Units_Dimensions > Units_Dimensions::AElectricCurrent ( )

static

ALength()

static Handle< Units_Dimensions > Units_Dimensions::ALength ( )

static

ALess()

static Handle< Units_Dimensions > Units_Dimensions::ALess ( )

static

ALuminousIntensity()

static Handle< Units_Dimensions > Units_Dimensions::ALuminousIntensity ( )

static

AMass()

static Handle< Units_Dimensions > Units_Dimensions::AMass ( )

static

AmountOfSubstance()

Standard_Real Units_Dimensions::AmountOfSubstance

(

)

const

Returns the power of quantity of material (mole) stored in the dimensions.

APlaneAngle()

static Handle< Units_Dimensions > Units_Dimensions::APlaneAngle ( )

static

ASolidAngle()

static Handle< Units_Dimensions > Units_Dimensions::ASolidAngle ( )

static

Returns the basic dimensions.

AThermodynamicTemperature()

static Handle< Units_Dimensions > Units_Dimensions::AThermodynamicTemperature ( )

static

ATime()

static Handle< Units_Dimensions > Units_Dimensions::ATime ( )

static

Divide()

Handle< Units_Dimensions > Units_Dimensions::Divide

(

const Handle< Units_Dimensions > &

adimensions

)

const

Creates and returns a new Dimensions object which is the result of the division of <me> by <adimensions>.

Dump()

void Units_Dimensions::Dump

(

const Standard_Integer

ashift

)

const

Useful for degugging.

ElectricCurrent()

Standard_Real Units_Dimensions::ElectricCurrent

(

)

const

Returns the power of electrical intensity (current) stored in the dimensions.

IsEqual()

Standard_Boolean Units_Dimensions::IsEqual

(

const Handle< Units_Dimensions > &

adimensions

)

const

Returns true if <me> and <adimensions> have the same dimensions, false otherwise.

IsNotEqual()

Standard_Boolean Units_Dimensions::IsNotEqual

(

const Handle< Units_Dimensions > &

adimensions

)

const

Returns false if <me> and <adimensions> have the same dimensions, true otherwise.

Length()

Standard_Real Units_Dimensions::Length

(

)

const

Returns the power of length stored in the dimensions.

LuminousIntensity()

Standard_Real Units_Dimensions::LuminousIntensity

(

)

const

Returns the power of light intensity stored in the dimensions.

Mass()

Standard_Real Units_Dimensions::Mass

(

)

const

Returns the power of mass stored in the dimensions.

Multiply()

Handle< Units_Dimensions > Units_Dimensions::Multiply

(

const Handle< Units_Dimensions > &

adimensions

)

const

Creates and returns a new Dimensions object which is the result of the multiplication of <me> and <adimensions>.

PlaneAngle()

Standard_Real Units_Dimensions::PlaneAngle

(

)

const

Returns the power of plane angle stored in the dimensions.

Power()

Handle< Units_Dimensions > Units_Dimensions::Power

(

const Standard_Real

anexponent

)

const

Creates and returns a new Dimensions object which is the result of the power of <me> and <anexponent>.

Quantity()

Standard_CString Units_Dimensions::Quantity

(

)

const

Returns the quantity string of the dimension.

SolidAngle()

Standard_Real Units_Dimensions::SolidAngle

(

)

const

Returns the power of solid angle stored in the dimensions.

ThermodynamicTemperature()

Standard_Real Units_Dimensions::ThermodynamicTemperature

(

)

const

Returns the power of temperature stored in the dimensions.

Time()

Standard_Real Units_Dimensions::Time

(

)

const

Returns the power of time stored in the dimensions.

---

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

• Units_Dimensions.hxx