The ShiftedToken class inherits from Token and describes tokens which have a gap in addition of the multiplicative factor. This kind of token allows the description of linear functions which do not pass through the origin, of the form : More...
#include <Units_ShiftedToken.hxx>
Inheritance diagram for Units_ShiftedToken:
Public Member Functions | |
| Units_ShiftedToken (const Standard_CString aword, const Standard_CString amean, const Standard_Real avalue, const Standard_Real amove, const Handle< Units_Dimensions > &adimensions) | |
| Creates and returns a shifted token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, <amove> is the gap, and <adimensions> is the dimension of the given word <aword>. | |
| virtual Handle< Units_Token > | Creates () const override |
| Creates and returns a token, which is a ShiftedToken. | |
| Standard_Real | Move () const |
| Returns the gap <themove> | |
| virtual Standard_Real | Multiplied (const Standard_Real avalue) const override |
| This virtual method is called by the Measurement methods, to compute the measurement during a conversion. | |
| virtual Standard_Real | Divided (const Standard_Real avalue) const override |
| This virtual method is called by the Measurement methods, to compute the measurement during a conversion. | |
| virtual void | Dump (const Standard_Integer ashift, const Standard_Integer alevel) const override |
| Useful for debugging. | |
 Public Member Functions inherited from Units_Token | |
| 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>. | |
| 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>. | |
| Handle< Units_Token > | Divide (const Handle< Units_Token > &atoken) const |
| Returns a token which is the division of <me> by another token <atoken>. | |
| 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. | |
| 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
The ShiftedToken class inherits from Token and describes tokens which have a gap in addition of the multiplicative factor. This kind of token allows the description of linear functions which do not pass through the origin, of the form :
y = ax +b
where <x> and <y> are the unknown variables, the mutiplicative factor, and the gap relative to the ordinate axis.
An example is the translation between the Celsius and Fahrenheit degree of temperature.
Constructor & Destructor Documentation
◆ Units_ShiftedToken()
| Units_ShiftedToken::Units_ShiftedToken | ( | const Standard_CString | aword, |
| const Standard_CString | amean, | ||
| const Standard_Real | avalue, | ||
| const Standard_Real | amove, | ||
| const Handle< Units_Dimensions > & | adimensions | ||
| ) |
Creates and returns a shifted token. <aword> is a string containing the available word, <amean> gives the signification of the token, <avalue> is the numeric value of the dimension, <amove> is the gap, and <adimensions> is the dimension of the given word <aword>.
Member Function Documentation
◆ Creates()
|
overridevirtual |
Creates and returns a token, which is a ShiftedToken.
Reimplemented from Units_Token.
◆ Divided()
|
overridevirtual |
This virtual method is called by the Measurement methods, to compute the measurement during a conversion.
Reimplemented from Units_Token.
◆ Dump()
|
overridevirtual |
Useful for debugging.
Reimplemented from Units_Token.
◆ Move()
| Standard_Real Units_ShiftedToken::Move | ( | ) | const |
Returns the gap <themove>
◆ Multiplied()
|
overridevirtual |
This virtual method is called by the Measurement methods, to compute the measurement during a conversion.
Reimplemented from Units_Token.
The documentation for this class was generated from the following file:
