stilnumber.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2006 International Business Machines Corporation
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Common Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.opensource.org/licenses/cpl1.0.php
 *
 * Contributors:
 *    Douglas Sprague, Joel Wheeler - initial API and implementation
 *
 *****************************************************************************/

#ifndef STILNUMBER_H
#define STILNUMBER_H

#include "stilcom.h"
#include "stilcomstr.h"
#include <math.h>


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILNumber  {

  // - Friend Classes
  // - Overload the insertion operator with an std::ostream and STILNumber object
  friend std::ostream& operator<<(std::ostream &ostr,const STILNumber&);

  // - Overload the '+' operator for a double value
  friend double operator+(double &val,const STILNumber &obj);

  // - Overload the '+=' operator for a double value
  friend double operator+=(double &val,const STILNumber &obj);

  // - Overload the '-' operator for a double value
  friend double operator-(double &val,const STILNumber &);

  // - Overload the '-=' operator for a double value
  friend double operator-=(double &val,const STILNumber &obj);

  // - Overload the '*' operator for a double value
  friend double operator*(double &val,const STILNumber &);

  // - Overload the '*=' operator for a double value
  friend double operator*=(double &val,const STILNumber &);

  // - Overload the '/' operator for a double value
  friend double operator/(double &val,const STILNumber &);

  // - Overload the '/=' operator for a double value
  friend double operator/=(double &val,const STILNumber &);

  // - Overload the '>' operator for a double value
  friend BOOLEAN operator>(double val,const STILNumber &);

  // - Overload the '>=' operator for a double value
  friend BOOLEAN operator>=(double val,const STILNumber &);

  // - Overload the '<' operator for a double value
  friend BOOLEAN operator<(double val,const STILNumber &);

  // - Overload the '<=' operator for a double value
  friend BOOLEAN operator<=(double val,const STILNumber &);

  // - Overload the '==' operator for a double value
  friend BOOLEAN operator==(double val,const STILNumber &);


  public:

    // - Default Constructor
    STILNumber();

    // - Constructor with a character
    STILNumber(const char *);

    // - Constructor with an sstring object
    STILNumber(const sstring &);

    // - Copy Constructor
    STILNumber(const STILNumber &);

    // - Destructor
    ~STILNumber();

    // - Overload the assignment operator with a character
    STILNumber &operator=(const char *);

    // - Overload the assignment operator with a character
    STILNumber &operator=(const sstring &);

    // - Overload the assignment operator with a STILNumber  object
    STILNumber & operator=(const STILNumber &);

    // - Overload the '+' operator with a character
    //STILNumber  operator+(const char *);

    // - Overload the '+' operator with a STILNumber  object
    //STILNumber  operator+(const STILNumber &);

    // - Overload the '*' operator with a character
    //STILNumber  operator*(const char *);

    // - Overload the '*' operator with a type double
    //STILNumber  operator*(double);

    // - Overload the '*' operator with a type LONG
    //STILNumber  operator*(LONG);

    // - Overload the '*' operator with a STILNumber  object
    //STILNumber  operator*(const STILNumber &);

    // - Overload the '*=' operator with a STILNumber  object
    STILNumber & operator*=(const STILNumber &);

    // - Overload the '*=' operator with a double value
    STILNumber & operator*=(double val);

    // - Overload the '-' operator with a STILNumber  object
    //STILNumber  operator-(const STILNumber &);

    // - Overload the '-' operator with a character
    //STILNumber  operator-(const char *);

    // - Overload the '-=' operator with a STILNumber  object
    STILNumber & operator-=(const STILNumber &);

    // - Overload the '+=' operator with a STILNumber  object
    STILNumber & operator+=(const STILNumber &);

    // - Overload the '/' operator with a character
    //STILNumber  operator/(const char *);

    // - Overload the '/' operator with a STILNumber  object
    //STILNumber  operator/(const STILNumber &);

    // - Overload the '/=' operator with a STILNumber  object
    STILNumber & operator/=(const STILNumber &);

    // - Overload the '<' operator with a character
    //BOOLEAN operator<(const char*) const;

    // - Overload the '<' operator with a STILNumber object
    BOOLEAN operator<(const STILNumber &n) const;

    // - Overload the '<=' operator with a character
    //BOOLEAN operator<=(const char * val) const;

    // - Overload the '<=' operator with a STILNumber object
    BOOLEAN operator<=(const STILNumber &) const;

    // - Overload the '>' operator with a character
    //BOOLEAN operator>(const char*) const;

    // - Overload the '>' operator with a STILNumber object
    BOOLEAN operator>(const STILNumber &) const;

    // - Overload the '>=' operator with a character
    //BOOLEAN operator>=(const char* val) const;

    // - Overload the '>=' operator with a STILNumber object
    BOOLEAN operator>=(const STILNumber &) const;

    // - Overload the '==' operator with a STILNumber  object
    BOOLEAN operator==(const STILNumber &) const;

    // - Overload the '==' operator with a type integer
    //BOOLEAN operator==(int) const;

    // - Overload the '!=' operator with a STILNumber  object
    //BOOLEAN operator!=(const STILNumber &) const;

    // - Overload the '!=' operator with a type integer
    //BOOLEAN operator!=(const int &) const;

    // - Return the representation as a sstring object
    sstring getText() const;

    // - Return the representation as a double
    double asDouble() const;

    // - Determine if an object has been defined
    BOOLEAN isDefined() const;

    //others: ??
    //getUnits(), getunitprefix()

    // - Print this objects values (for debug)
    void print(void);

    // - Initialize this object
    void init(void);

  private:
    double    m_value;      // Objects value
    sstring   m_unit;       // (A)mps, (V)olts, ...

    int       m_modifier;   // (-3) mV, (-6) uS

    sstring   m_text;       // string representation
};

//inlines:

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// - Destructor
inline STILNumber::~STILNumber() { };

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// - Return the representation as a sstring object
inline     sstring  STILNumber::getText() const    { return m_text; } //was asString- use getText to stick with conventions used elsewhere in STIL

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
    // - Return the representation as a double
inline     double  STILNumber::asDouble() const    { return (m_value*(pow(10.0,m_modifier))); }//need to multipy value*m_modifier

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
    // - Determine if an object has been defined
inline     BOOLEAN  STILNumber::isDefined() const  { return (m_text!=""); }


//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline BOOLEAN STILNumber::operator<(const STILNumber &n) const { return (asDouble() < n.asDouble()); }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline BOOLEAN STILNumber::operator<=(const STILNumber &n) const
  { return ( (asDouble() < n.asDouble()) || (asDouble() == n.asDouble()) ); }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline BOOLEAN STILNumber::operator>(const STILNumber &n) const
  { return (asDouble() > n.asDouble()); }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline BOOLEAN STILNumber::operator>=(const STILNumber &n) const
  { return ( (asDouble() > n.asDouble()) || (asDouble() == n.asDouble()) ); }

#endif

---

This page last updated on 6 Jul 2007