stilterminationitem.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 STILTerminationItem_H
#define STILTerminationItem_H

#include "stilcom.h"              // Common macros, typedefs
#include "stilsigrefexpr.h"       // STILSigRefExpr  interface
#include "stiltermination.h"      // STILTermination enumeration

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILTerminationItem  {

  public:

    // - Default Constructor for a STILTerminationItem object.
    STILTerminationItem();

    // - Constructor a STILTerminationItem object from another STILTerminationItem
    STILTerminationItem(const STILTerminationItem &);

    // - Destructor for a STILTerminationItem object.
    ~STILTerminationItem();

    // _ Initialize the object
    void init();

    // - Assignment operator for a STILTerminationItem object.
    STILTerminationItem &  operator=(const STILTerminationItem &);

    // - Equals operator for a STILTerminationItem object (to make STL happy)
    bool  operator==(const STILTerminationItem &) const;

    // - LT operator for a STILTerminationItem object (also to make STL happy)
    bool  operator<(const STILTerminationItem &) const;

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


    // - Set/Get the SigRefExpr for this STILTerminationItem
    //const STILSigRefExpr * getSigRefExpr();
    void                   setSigRefExpr(const STILSigRefExpr&);

    // - Set/Getthe Termination for this STILTerminationItem
    //STILTermination        getTermination();
    void                   setTermination(STILTermination);

  private:

    // The termination state:
    STILTermination m_termination;

    // The signal reference expression:
    STILSigRefExpr m_sigRef;

};  // end STILTerminationItem class

//INLINE functions:
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILTerminationItem::setTermination (STILTermination t)  {
  m_termination = t;
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILTerminationItem::setSigRefExpr(const STILSigRefExpr& sre) {
  m_sigRef = sre;
}

// These functions aren't used, but STL needs them to be defined.
inline bool STILTerminationItem::operator==(const STILTerminationItem & ti1) const {
  return ( ((*this).m_termination == ti1.m_termination) && ((*this).m_sigRef == ti1.m_sigRef) );
}

inline bool STILTerminationItem::operator<(const STILTerminationItem & ti1) const {
  return false;
}

#endif

---

This page last updated on 6 Jul 2007