liboce-foundation-dev 0.18.2-2build1 / usr / include / oce / Units_Token.hxx

// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _Units_Token_HeaderFile
#define _Units_Token_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_Units_Token.hxx>

#include <TCollection_AsciiString.hxx>
#include <Standard_Real.hxx>
#include <Handle_Units_Dimensions.hxx>
#include <MMgt_TShared.hxx>
#include <Standard_CString.hxx>
#include <Standard_Integer.hxx>
#include <Standard_Boolean.hxx>
class Units_Dimensions;


//! This class defines an elementary word contained in
//! a Sentence object.
class Units_Token : public MMgt_TShared
{

public:

  
  //! Creates and returns a empty token.
  Standard_EXPORT Units_Token();
  
  //! Creates  and returns  a token.   <aword>  is  a string
  //! containing the available word.
  Standard_EXPORT Units_Token(const Standard_CString aword);
  
  //! Creates and returns a  token.  <atoken> is  copied  in
  //! the returned token.
  Standard_EXPORT Units_Token(const Handle(Units_Token)& atoken);
  
  //! Creates  and  returns a  token.   <aword> is  a string
  //! containing the  available word and  <amean>  gives the
  //! signification of the token.
  Standard_EXPORT Units_Token(const Standard_CString aword, const Standard_CString amean);
  
  //! 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.
  Standard_EXPORT 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, <avalue> is  the numeric
  //! value  of the dimension,  and <adimensions>   is   the
  //! dimension of the given word <aword>.
  Standard_EXPORT Units_Token(const Standard_CString aword, const Standard_CString amean, const Standard_Real avalue, const Handle(Units_Dimensions)& adimension);
  
  //! Creates and returns a  token, which is a ShiftedToken.
  Standard_EXPORT virtual   Handle(Units_Token) Creates()  const;
  
  //! Returns the length of the word.
  Standard_EXPORT   Standard_Integer Length()  const;
  
  //! Returns the string <theword>
      TCollection_AsciiString Word()  const;
  
  //! Sets the field <theword> to <aword>.
      void Word (const Standard_CString aword) ;
  
  //! Returns the significance of the word  <theword>, which
  //! is in the field <themean>.
      TCollection_AsciiString Mean()  const;
  
  //! Sets the field <themean> to <amean>.
      void Mean (const Standard_CString amean) ;
  
  //! Returns the value stored in the field <thevalue>.
      Standard_Real Value()  const;
  
  //! Sets the field <thevalue> to <avalue>.
      void Value (const Standard_Real avalue) ;
  
  //! Returns the dimensions of the token <thedimensions>.
      Handle(Units_Dimensions) Dimensions()  const;
  
  //! Sets the field <thedimensions> to <adimensions>.
  Standard_EXPORT   void Dimensions (const Handle(Units_Dimensions)& adimensions) ;
  
  //! 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.
  Standard_EXPORT   void Update (const Standard_CString amean) ;
  
  Standard_EXPORT   Handle(Units_Token) Add (const Standard_Integer aninteger)  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.
  Standard_EXPORT   Handle(Units_Token) Add (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.
  Standard_EXPORT   Handle(Units_Token) Subtract (const Handle(Units_Token)& atoken)  const;
  
  //! Returns a  token  which  is the  product of   <me> and
  //! another token <atoken>.
  Standard_EXPORT   Handle(Units_Token) Multiply (const Handle(Units_Token)& atoken)  const;
  
  //! This   virtual method is   called  by  the Measurement
  //! methods,  to  compute    the   measurement   during  a
  //! conversion.
  Standard_EXPORT virtual   Standard_Real Multiplied (const Standard_Real avalue)  const;
  
  //! Returns a token which is the division of <me> by another
  //! token <atoken>.
  Standard_EXPORT   Handle(Units_Token) Divide (const Handle(Units_Token)& atoken)  const;
  
  //! This  virtual  method  is  called by  the  Measurement
  //! methods,   to   compute   the measurement  during    a
  //! conversion.
  Standard_EXPORT virtual   Standard_Real Divided (const Standard_Real avalue)  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.
  Standard_EXPORT   Handle(Units_Token) Power (const Handle(Units_Token)& atoken)  const;
  
  //! Returns a token which is <me> to the power  of <anexponent>.
  Standard_EXPORT   Handle(Units_Token) Power (const Standard_Real anexponent)  const;
  
  //! Returns true if  the  field <theword> and  the  string
  //! <astring> are the same, false otherwise.
  Standard_EXPORT   Standard_Boolean IsEqual (const Standard_CString astring)  const;
  
  //! Returns true  if the  field  <theword> and  the string
  //! <theword> contained  in  the  token <atoken>  are  the
  //! same, false otherwise.
  Standard_EXPORT   Standard_Boolean IsEqual (const Handle(Units_Token)& atoken)  const;
  
  //! Returns false if  the field <theword>  and the  string
  //! <astring> are the same, true otherwise.
      Standard_Boolean IsNotEqual (const Standard_CString astring)  const;
  
  //! Returns false if  the field <theword>  and the  string
  //! <theword> contained  in the  token  <atoken>  are  the
  //! same, true otherwise.
      Standard_Boolean IsNotEqual (const Handle(Units_Token)& atoken)  const;
  
  //! Returns   true  if the   field <theword>  is  strictly
  //! contained at  the beginning  of the string  <astring>,
  //! false otherwise.
      Standard_Boolean IsLessOrEqual (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 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 true  if  the string <astring>   is   strictly
  //! contained   at the  beginning  of  the field <theword>
  //! false otherwise.
      Standard_Boolean IsGreaterOrEqual (const Handle(Units_Token)& atoken)  const;
  
  //! Destroies the Token
  Standard_EXPORT virtual   void Destroy() ;
~Units_Token()
{
  Destroy();
}
  
  //! Useful for debugging
  Standard_EXPORT virtual   void Dump (const Standard_Integer ashift, const Standard_Integer alevel)  const;



  DEFINE_STANDARD_RTTI(Units_Token)

protected:




private: 


  TCollection_AsciiString theword;
  TCollection_AsciiString themean;
  Standard_Real thevalue;
  Handle(Units_Dimensions) thedimensions;


};


#include <Units_Token.lxx>





#endif // _Units_Token_HeaderFile