133 lines
4.7 KiB
C++
133 lines
4.7 KiB
C++
// Created on: 1992-06-22
|
|
// Created by: Gilles DEBARBOUILLE
|
|
// Copyright (c) 1992-1999 Matra Datavision
|
|
// Copyright (c) 1999-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef _Units_Measurement_HeaderFile
|
|
#define _Units_Measurement_HeaderFile
|
|
|
|
#include "Standard.hxx"
|
|
#include "Standard_DefineAlloc.hxx"
|
|
#include "Standard_Handle.hxx"
|
|
|
|
class Units_Token;
|
|
|
|
//! This class defines a measurement which is the
|
|
//! association of a real value and a unit.
|
|
class Units_Measurement
|
|
{
|
|
public:
|
|
DEFINE_STANDARD_ALLOC
|
|
|
|
//! It is the empty constructor of the class.
|
|
Standard_EXPORT Units_Measurement();
|
|
|
|
//! Returns an instance of this class. <avalue> defines
|
|
//! the measurement, and <atoken> the token which defines
|
|
//! the unit used.
|
|
Standard_EXPORT Units_Measurement(const Standard_Real avalue, const Handle(Units_Token)& atoken);
|
|
|
|
//! Returns an instance of this class. <avalue> defines
|
|
//! the measurement, and <aunit> the unit used,
|
|
//! described in natural language.
|
|
Standard_EXPORT Units_Measurement(const Standard_Real avalue, const Standard_CString aunit);
|
|
|
|
//! Converts (if possible) the measurement object into
|
|
//! another unit. <aunit> must have the same
|
|
//! dimensionality as the unit contained in the token
|
|
//! <thetoken>.
|
|
Standard_EXPORT void Convert(const Standard_CString aunit);
|
|
|
|
//! Returns a Measurement object with the integer value of
|
|
//! the measurement contained in <me>.
|
|
Standard_EXPORT Units_Measurement Integer() const;
|
|
|
|
//! Returns a Measurement object with the fractional value
|
|
//! of the measurement contained in <me>.
|
|
Standard_EXPORT Units_Measurement Fractional() const;
|
|
|
|
//! Returns the value of the measurement.
|
|
Standard_EXPORT Standard_Real Measurement() const;
|
|
|
|
//! Returns the token contained in <me>.
|
|
Standard_EXPORT Handle(Units_Token) Token() const;
|
|
|
|
//! Returns (if it is possible) a measurement which is the
|
|
//! addition of <me> and <ameasurement>. The chosen
|
|
//! returned unit is the unit of <me>.
|
|
Standard_EXPORT Units_Measurement Add(const Units_Measurement& ameasurement) const;
|
|
|
|
Units_Measurement operator+(const Units_Measurement& ameasurement) const
|
|
{
|
|
return Add(ameasurement);
|
|
}
|
|
|
|
//! Returns (if it is possible) a measurement which is the
|
|
//! subtraction of <me> and <ameasurement>. The chosen
|
|
//! returned unit is the unit of <me>.
|
|
Standard_EXPORT Units_Measurement Subtract(const Units_Measurement& ameasurement) const;
|
|
|
|
Units_Measurement operator-(const Units_Measurement& ameasurement) const
|
|
{
|
|
return Subtract(ameasurement);
|
|
}
|
|
|
|
//! Returns a measurement which is the multiplication of
|
|
//! <me> and <ameasurement>.
|
|
Standard_EXPORT Units_Measurement Multiply(const Units_Measurement& ameasurement) const;
|
|
|
|
Units_Measurement operator*(const Units_Measurement& ameasurement) const
|
|
{
|
|
return Multiply(ameasurement);
|
|
}
|
|
|
|
//! Returns a measurement which is the multiplication of
|
|
//! <me> with the value <avalue>.
|
|
Standard_EXPORT Units_Measurement Multiply(const Standard_Real avalue) const;
|
|
|
|
Units_Measurement operator*(const Standard_Real avalue) const { return Multiply(avalue); }
|
|
|
|
//! Returns a measurement which is the division of <me> by
|
|
//! <ameasurement>.
|
|
Standard_EXPORT Units_Measurement Divide(const Units_Measurement& ameasurement) const;
|
|
|
|
Units_Measurement operator/(const Units_Measurement& ameasurement) const
|
|
{
|
|
return Divide(ameasurement);
|
|
}
|
|
|
|
//! Returns a measurement which is the division of <me> by
|
|
//! the constant <avalue>.
|
|
Standard_EXPORT Units_Measurement Divide(const Standard_Real avalue) const;
|
|
|
|
Units_Measurement operator/(const Standard_Real avalue) const { return Divide(avalue); }
|
|
|
|
//! Returns a measurement which is <me> powered
|
|
//! <anexponent>.
|
|
Standard_EXPORT Units_Measurement Power(const Standard_Real anexponent) const;
|
|
|
|
Standard_EXPORT Standard_Boolean HasToken() const;
|
|
|
|
//! Useful for debugging.
|
|
Standard_EXPORT void Dump() const;
|
|
|
|
protected:
|
|
private:
|
|
Standard_Real themeasurement;
|
|
Handle(Units_Token) thetoken;
|
|
Standard_Boolean myHasToken;
|
|
};
|
|
|
|
#endif // _Units_Measurement_HeaderFile
|