stilpatternexec.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 STILPatternExec_H
#define STILPatternExec_H

#include "stilcom.h"             // Common
#include "stilcomstr.h"
#include "stilblock.h"           // STIL Block common base class


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILPatternExec : public STILBlock {

  // - Global std::ostream << operator as friend to output STILPatternExec object
  friend std::ostream& operator<<( std::ostream &os, const STILPatternExec &);

  public:

    // - Default Constructor
    STILPatternExec();

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

    // - Destructor which frees storage associated to a STILPatternExec object
    virtual ~STILPatternExec();

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

    // - Member function to initialize an object
    void init();

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


    // - Member functions to add a Timing reference
    //Was setTiming_ref- remove '_ref' but still refer to enumtype TimingRef
    void setTiming(const sstring & t);

    // - Member functions to add a PatternBurst reference
    //Was setPatternBurst_ref- remove '_ref' but still refer to enumtype PatternBurstRef
    void setPatternBurst(const sstring & p);

    // - Member functions to add a Category reference
    //Was setCategory_ref- remove '_ref' but still refer to enumtype CategoryRef
    void addCategory(const sstring & c);

    // - Member functions to add a Selector reference
    //Was setSelector_ref- remove '_ref' but still refer to enumtype SelectorRef
    void addSelector(const sstring & s);

    // - Member functions to determine if a PatternBurst is referenced
    bool referencesPatternBurst(const sstring & pb) const;

  private:

    //**********************************************************************
    //**********************************************************************
    // Note: all data elements are inherited from STILBlock                *
    //**********************************************************************
    //**********************************************************************

}; // end STILPatternExec class

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternExec::setTiming(const sstring & t) {
  addEntity(TimingRef,"Timing",t);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternExec::setPatternBurst(const sstring & b) {
  addEntity(PatternBurstRef,"PatternBurst",b);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternExec::addCategory(const sstring & c) {
  addEntity(CategoryRef,"Category",c);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternExec::addSelector(const sstring & s) {
  addEntity(SelectorRef,"Selector",s);
}

#endif

---

This page last updated on 6 Jul 2007