This class defines an elementary word contained in
a physical quantity.
More...

#include <Units_Unit.hxx>

Inheritance diagram for Units_Unit:

Public Member Functions
	Units_Unit (const Standard_CString aname, const Standard_CString asymbol, const Standard_Real avalue, const Handle< Units_Quantity > &aquantity)
	Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit, and <avalue> is the value in relation to the International System of Units. More...

	Units_Unit (const Standard_CString aname, const Standard_CString asymbol)
	Creates and returns a unit. <aname> is the name of the unit, <asymbol> is the usual abbreviation of the unit. More...

	Units_Unit (const Standard_CString aname)
	Creates and returns a unit. <aname> is the name of the unit. More...

TCollection_AsciiString	Name () const
	Returns the name of the unit <thename> More...

void	Symbol (const Standard_CString asymbol)
	Adds a new symbol <asymbol> attached to <me>. More...

Standard_Real	Value () const
	Returns the value in relation with the International System of Units. More...

Handle_Units_Quantity	Quantity () const
	Returns <thequantity> contained in <me>. More...

Handle_TColStd_HSequenceOfHAsciiString	SymbolsSequence () const
	Returns the sequence of symbols <thesymbolssequence> More...

void	Value (const Standard_Real avalue)
	Sets the value <avalue> to <me>. More...

void	Quantity (const Handle< Units_Quantity > &aquantity)
	Sets the physical Quantity <aquantity> to <me>. More...

virtual Handle_Units_Token	Token () const
	Starting with <me>, returns a new Token object. More...

Standard_Boolean	IsEqual (const Standard_CString astring) const
	Compares all the symbols linked within <me> with the name of <atoken>, and returns True if there is one symbol equal to the name, False otherwise. More...

virtual void	Dump (const Standard_Integer ashift, const Standard_Integer alevel) const
	Useful for debugging More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual void	ShallowDump (Standard_OStream &) const

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const 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 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...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Protected Attributes
Handle_TColStd_HSequenceOfHAsciiString	thesymbolssequence

Standard_Real	thevalue

Detailed Description

This class defines an elementary word contained in
a physical quantity.

Constructor & Destructor Documentation

Units_Unit::Units_Unit	(	const Standard_CString	aname,
		const Standard_CString	asymbol,
		const Standard_Real	avalue,
		const Handle< Units_Quantity > &	aquantity
	)

Creates and returns a unit. <aname> is the name of
the unit, <asymbol> is the usual abbreviation of the
unit, and <avalue> is the value in relation to the
International System of Units.

Units_Unit::Units_Unit	(	const Standard_CString	aname,
		const Standard_CString	asymbol
	)

Creates and returns a unit. <aname> is the name of
the unit, <asymbol> is the usual abbreviation of the
unit.

Units_Unit::Units_Unit ( const Standard_CString aname )

Creates and returns a unit. <aname> is the name of
the unit.

Member Function Documentation

virtual void Units_Unit::Dump	(	const Standard_Integer	ashift,
		const Standard_Integer	alevel
	)		const

virtual

Useful for debugging

Reimplemented in Units_ShiftedUnit.

Standard_Boolean Units_Unit::IsEqual ( const Standard_CString astring ) const

Compares all the symbols linked within <me> with the
name of <atoken>, and returns True if there is one
symbol equal to the name, False otherwise.

TCollection_AsciiString Units_Unit::Name ( ) const

Returns the name of the unit <thename>

Handle_Units_Quantity Units_Unit::Quantity ( ) const

Returns <thequantity> contained in <me>.

void Units_Unit::Quantity ( const Handle< Units_Quantity > & aquantity )

Sets the physical Quantity <aquantity> to <me>.

void Units_Unit::Symbol ( const Standard_CString asymbol )

Adds a new symbol <asymbol> attached to <me>.

Handle_TColStd_HSequenceOfHAsciiString Units_Unit::SymbolsSequence ( ) const

Returns the sequence of symbols <thesymbolssequence>

virtual Handle_Units_Token Units_Unit::Token ( ) const

virtual

Starting with <me>, returns a new Token object.

Reimplemented in Units_ShiftedUnit.

Standard_Real Units_Unit::Value ( ) const

Returns the value in relation with the International
System of Units.

void Units_Unit::Value ( const Standard_Real avalue )

Sets the value <avalue> to <me>.

Field Documentation

Handle_TColStd_HSequenceOfHAsciiString Units_Unit::thesymbolssequence

protected

Standard_Real Units_Unit::thevalue

protected

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

Units_Unit.hxx

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation