stiltimeexpr.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 STILTimeExpr_H
#define STILTimeExpr_H

#include "stilcom.h"               // Common library
#include "stilsigrefexpr.h"
#include "stilnumber.h"
#include "stilcomstr.h"


//STILEvalEngine includes STILVectorEventList which includes STILVectorEvent.
//STILVectorEvent includes STILEventList, which includes STILTimeExpr.
//STILTimeExpr includes STILEvalEngine, so we need to prototype it:
class STILEvalEngine; //prototype needed for compile

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILTimeExpr {

  // - Public members
  public:
     // Allowed operators
    enum Operator {
      UndefinedOperator,  
      Plus,               
      Minus,              
      LeftParen,          
      RightParen          
    };

   // - Default constructor
    STILTimeExpr();

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

    // - Destructor
    ~STILTimeExpr();

    // - Assignment operator
    STILTimeExpr & operator=(const STILTimeExpr &);

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

    // - Write this object out to a file
    virtual void write(FILE * pOutFile, LONG indentation=0) const;


    // - Add operators, Id's and numbers to this expression
    void addOp(const Operator);
    void addId(const sstring);
    void addNumber(const STILNumber&);

    // - Get the text of the expression
    // - * NOTE: If expression is empty, it will return a sstring of '' with
    //     length==2
    sstring getText() const;

    // - Evaluate the expression into a number/unit
    // Eventually TimeExpr's can have variable expressions, so an EE
    //   must be passed in:
    STILNumber eval(const STILEvalEngine & ee) const;
    // For now, we can only store a single STILNumber as a TimeExpr,
    //  so there's no need to pass in an EE:
    STILNumber eval() const;

  // - Private members
  private:

    sstring    m_text; // text representation of the string

    STILNumber m_snum; //start off with simple expressions- can only be a number
                       // (no ops)

};

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
// - Get the text of the expression
    // - * NOTE: If expression is empty, it will return a sstring of '' with
    //     length==2
inline    sstring STILTimeExpr::getText() const { return ("\'"+m_text+"\'"); }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
    // - Evaluate the expression into a number/unit
    // Eventually TimeExpr's can have variable expressions, so an EE
    //   must be passed in:
inline    STILNumber STILTimeExpr::eval(const STILEvalEngine & ee) const { return m_snum; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
    // For now, we can only store a single STILNumber as a TimeExpr,
    //  so there's no need to pass in an EE:
inline    STILNumber STILTimeExpr::eval() const { return m_snum; }


#endif

---

This page last updated on 6 Jul 2007