This class defines an elementary word contained in a Sentence object. More...

#include <Units_Token.hxx>

Inheritance diagram for Units_Token:

[legend]

Public Member Functions
	Units_Token ()
	Creates and returns a empty token.

	Units_Token (const Standard_CString aword)
	Creates and returns a token. <aword> is a string containing the available word.

	Units_Token (const Handle< Units_Token > &atoken)
	Creates and returns a token. <atoken> is copied in the returned token.

	Units_Token (const Standard_CString aword, const Standard_CString amean)
	Creates and returns a token. <aword> is a string containing the available word and <amean> gives the signification of the token.

	Units_Token (const Standard_CString aword, const Standard_CString amean, const Standard_Real avalue)
	Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token and <avalue> is the numeric value of the dimension.

	Units_Token (const Standard_CString aword, const Standard_CString amean, const Standard_Real avalue, const Handle< Units_Dimensions > &adimension)
	Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, and <adimensions> is the dimension of the given word <aword>.

virtual Handle< Units_Token >	Creates () const
	Creates and returns a token, which is a ShiftedToken.

Standard_Integer	Length () const
	Returns the length of the word.

TCollection_AsciiString	Word () const
	Returns the string <theword>

void	Word (const Standard_CString aword)
	Sets the field <theword> to <aword>.

TCollection_AsciiString	Mean () const
	Returns the significance of the word <theword>, which is in the field <themean>.

void	Mean (const Standard_CString amean)
	Sets the field <themean> to <amean>.

Standard_Real	Value () const
	Returns the value stored in the field <thevalue>.

void	Value (const Standard_Real avalue)
	Sets the field <thevalue> to <avalue>.

Handle< Units_Dimensions >	Dimensions () const
	Returns the dimensions of the token <thedimensions>.

void	Dimensions (const Handle< Units_Dimensions > &adimensions)
	Sets the field <thedimensions> to <adimensions>.

void	Update (const Standard_CString amean)
	Updates the token <me> with the additional signification <amean> by concatenation of the two strings <themean> and <amean>. If the two significations are the same , an information message is written in the output device.

Handle< Units_Token >	Add (const Standard_Integer aninteger) const

Handle< Units_Token >	Add (const Handle< Units_Token > &atoken) const
	Returns a token which is the addition of <me> and another token <atoken>. The addition is possible if and only if the dimensions are the same.

Handle< Units_Token >	Subtract (const Handle< Units_Token > &atoken) const
	Returns a token which is the subtraction of <me> and another token <atoken>. The subtraction is possible if and only if the dimensions are the same.

Handle< Units_Token >	Multiply (const Handle< Units_Token > &atoken) const
	Returns a token which is the product of <me> and another token <atoken>.

virtual Standard_Real	Multiplied (const Standard_Real avalue) const
	This virtual method is called by the Measurement methods, to compute the measurement during a conversion.

Handle< Units_Token >	Divide (const Handle< Units_Token > &atoken) const
	Returns a token which is the division of <me> by another token <atoken>.

virtual Standard_Real	Divided (const Standard_Real avalue) const
	This virtual method is called by the Measurement methods, to compute the measurement during a conversion.

Handle< Units_Token >	Power (const Handle< Units_Token > &atoken) const
	Returns a token which is <me> to the power of another token <atoken>. The computation is possible only if <atoken> is a dimensionless constant.

Handle< Units_Token >	Power (const Standard_Real anexponent) const
	Returns a token which is <me> to the power of <anexponent>.

Standard_Boolean	IsEqual (const Standard_CString astring) const
	Returns true if the field <theword> and the string <astring> are the same, false otherwise.

Standard_Boolean	IsEqual (const Handle< Units_Token > &atoken) const
	Returns true if the field <theword> and the string <theword> contained in the token <atoken> are the same, false otherwise.

Standard_Boolean	IsNotEqual (const Standard_CString astring) const
	Returns false if the field <theword> and the string <astring> are the same, true otherwise.

Standard_Boolean	IsNotEqual (const Handle< Units_Token > &atoken) const
	Returns false if the field <theword> and the string <theword> contained in the token <atoken> are the same, true otherwise.

Standard_Boolean	IsLessOrEqual (const Standard_CString astring) const
	Returns true if the field <theword> is strictly contained at the beginning of the string <astring>, false otherwise.

Standard_Boolean	IsGreater (const Standard_CString astring) const
	Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.

Standard_Boolean	IsGreater (const Handle< Units_Token > &atoken) const
	Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.

Standard_Boolean	IsGreaterOrEqual (const Handle< Units_Token > &atoken) const
	Returns true if the string <astring> is strictly contained at the beginning of the field <theword> false otherwise.

virtual void	Dump (const Standard_Integer ashift, const Standard_Integer 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 ()
	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.

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 defines an elementary word contained in a Sentence object.

Constructor & Destructor Documentation

◆ Units_Token() [1/6]

Units_Token::Units_Token ( )

Creates and returns a empty token.

◆ Units_Token() [2/6]

Units_Token::Units_Token ( const Standard_CString aword )

Creates and returns a token. <aword> is a string containing the available word.

◆ Units_Token() [3/6]

Units_Token::Units_Token ( const Handle< Units_Token > & atoken )

Creates and returns a token. <atoken> is copied in the returned token.

◆ Units_Token() [4/6]

Units_Token::Units_Token	(	const Standard_CString	aword,
		const Standard_CString	amean )

Creates and returns a token. <aword> is a string containing the available word and <amean> gives the signification of the token.

◆ Units_Token() [5/6]

Units_Token::Units_Token	(	const Standard_CString	aword,
		const Standard_CString	amean,
		const Standard_Real	avalue )

Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token and <avalue> is the numeric value of the dimension.

◆ Units_Token() [6/6]

Units_Token::Units_Token	(	const Standard_CString	aword,
		const Standard_CString	amean,
		const Standard_Real	avalue,
		const Handle< Units_Dimensions > &	adimension )

Creates and returns a token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, and <adimensions> is the dimension of the given word <aword>.

Member Function Documentation

◆ Add() [1/2]

Handle< Units_Token > Units_Token::Add ( const Handle< Units_Token > & atoken ) const

Returns a token which is the addition of <me> and another token <atoken>. The addition is possible if and only if the dimensions are the same.

◆ Add() [2/2]

Handle< Units_Token > Units_Token::Add ( const Standard_Integer aninteger ) const

◆ Creates()

virtual Handle< Units_Token > Units_Token::Creates ( ) const

virtual

Creates and returns a token, which is a ShiftedToken.

Reimplemented in Units_ShiftedToken.

◆ Dimensions() [1/2]

Handle< Units_Dimensions > Units_Token::Dimensions ( ) const

Returns the dimensions of the token <thedimensions>.

◆ Dimensions() [2/2]

void Units_Token::Dimensions ( const Handle< Units_Dimensions > & adimensions )

Sets the field <thedimensions> to <adimensions>.

◆ Divide()

Handle< Units_Token > Units_Token::Divide ( const Handle< Units_Token > & atoken ) const

Returns a token which is the division of <me> by another token <atoken>.

◆ Divided()

virtual Standard_Real Units_Token::Divided ( const Standard_Real avalue ) const

virtual

This virtual method is called by the Measurement methods, to compute the measurement during a conversion.

Reimplemented in Units_ShiftedToken.

◆ Dump()

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

virtual

Useful for debugging.

Reimplemented in Units_ShiftedToken.

◆ IsEqual() [1/2]

Standard_Boolean Units_Token::IsEqual ( const Handle< Units_Token > & atoken ) const

Returns true if the field <theword> and the string <theword> contained in the token <atoken> are the same, false otherwise.

◆ IsEqual() [2/2]

Standard_Boolean Units_Token::IsEqual ( const Standard_CString astring ) const

Returns true if the field <theword> and the string <astring> are the same, false otherwise.

◆ IsGreater() [1/2]

Standard_Boolean Units_Token::IsGreater ( const Handle< Units_Token > & atoken ) const

Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.

◆ IsGreater() [2/2]

Standard_Boolean Units_Token::IsGreater ( const Standard_CString astring ) const

Returns false if the field <theword> is strictly contained at the beginning of the string <astring>, true otherwise.

◆ IsGreaterOrEqual()

Standard_Boolean Units_Token::IsGreaterOrEqual ( const Handle< Units_Token > & atoken ) const

Returns true if the string <astring> is strictly contained at the beginning of the field <theword> false otherwise.

◆ IsLessOrEqual()

Standard_Boolean Units_Token::IsLessOrEqual ( const Standard_CString astring ) const

Returns true if the field <theword> is strictly contained at the beginning of the string <astring>, false otherwise.

◆ IsNotEqual() [1/2]

Standard_Boolean Units_Token::IsNotEqual ( const Handle< Units_Token > & atoken ) const

Returns false if the field <theword> and the string <theword> contained in the token <atoken> are the same, true otherwise.

◆ IsNotEqual() [2/2]

Standard_Boolean Units_Token::IsNotEqual ( const Standard_CString astring ) const

Returns false if the field <theword> and the string <astring> are the same, true otherwise.

◆ Length()

Standard_Integer Units_Token::Length ( ) const

Returns the length of the word.

◆ Mean() [1/2]

TCollection_AsciiString Units_Token::Mean ( ) const

Returns the significance of the word <theword>, which is in the field <themean>.

◆ Mean() [2/2]

void Units_Token::Mean ( const Standard_CString amean )

Sets the field <themean> to <amean>.

◆ Multiplied()

virtual Standard_Real Units_Token::Multiplied ( const Standard_Real avalue ) const

virtual

This virtual method is called by the Measurement methods, to compute the measurement during a conversion.

Reimplemented in Units_ShiftedToken.

◆ Multiply()

Handle< Units_Token > Units_Token::Multiply ( const Handle< Units_Token > & atoken ) const

Returns a token which is the product of <me> and another token <atoken>.

◆ Power() [1/2]

Handle< Units_Token > Units_Token::Power ( const Handle< Units_Token > & atoken ) const

Returns a token which is <me> to the power of another token <atoken>. The computation is possible only if <atoken> is a dimensionless constant.

◆ Power() [2/2]

Handle< Units_Token > Units_Token::Power ( const Standard_Real anexponent ) const

Returns a token which is <me> to the power of <anexponent>.

◆ Subtract()

Handle< Units_Token > Units_Token::Subtract ( const Handle< Units_Token > & atoken ) const

Returns a token which is the subtraction of <me> and another token <atoken>. The subtraction is possible if and only if the dimensions are the same.

◆ Update()

void Units_Token::Update ( const Standard_CString amean )

Updates the token <me> with the additional signification <amean> by concatenation of the two strings <themean> and <amean>. If the two significations are the same , an information message is written in the output device.

◆ Value() [1/2]

Standard_Real Units_Token::Value ( ) const

Returns the value stored in the field <thevalue>.

◆ Value() [2/2]

void Units_Token::Value ( const Standard_Real avalue )

Sets the field <thevalue> to <avalue>.

◆ Word() [1/2]

TCollection_AsciiString Units_Token::Word ( ) const

Returns the string <theword>

◆ Word() [2/2]

void Units_Token::Word ( const Standard_CString aword )

Sets the field <theword> to <aword>.

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

Units_Token.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Units_Token() [1/6]

◆ Units_Token() [2/6]

◆ Units_Token() [3/6]

◆ Units_Token() [4/6]

◆ Units_Token() [5/6]

◆ Units_Token() [6/6]

Member Function Documentation

◆ Add() [1/2]

◆ Add() [2/2]

◆ Creates()

◆ Dimensions() [1/2]

◆ Dimensions() [2/2]

◆ Divide()

◆ Divided()

◆ Dump()

◆ IsEqual() [1/2]

◆ IsEqual() [2/2]

◆ IsGreater() [1/2]

◆ IsGreater() [2/2]

◆ IsGreaterOrEqual()

◆ IsLessOrEqual()

◆ IsNotEqual() [1/2]

◆ IsNotEqual() [2/2]

◆ Length()

◆ Mean() [1/2]

◆ Mean() [2/2]

◆ Multiplied()

◆ Multiply()

◆ Power() [1/2]

◆ Power() [2/2]

◆ Subtract()

◆ Update()

◆ Value() [1/2]

◆ Value() [2/2]

◆ Word() [1/2]

◆ Word() [2/2]