stilpatternburstblock.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 STILPatternBurstBlock_H
#define STILPatternBurstBlock_H

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

#include <list>


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILPatternBurstBlock : public STILBlock {

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

  public:

    enum PAT_TERMINATION {
               TERMINATION_UNDEFINED = 0,
               TERMINATION_HIGH      = 1,
               TERMINATION_LOW       = 2,
               TERMINATION_OFF       = 3,
               TERMINATION_UNKNOWN   = 4
    };

// Dont think this is necessary anymore with introduction of STILTerminations (JW-11/19/99)
//    struct  TERMINATION_STRUCT {
//               sstring                TerminationExprString;
//            // expr_tree             TerminationExpr;
//               PAT_TERMINATION       Termination;
//    };

    // - Default Constructor
    STILPatternBurstBlock();

    // - Constructor given a STILEntity::Type
    STILPatternBurstBlock(STILEntity::Type t);

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

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

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

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

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

    // - Member functions to set/get the Start label
    void setStart(const sstring & label);

    // - Member functions to set/get the Stop label
    void setStop(const sstring & label);

    // - Member functions to set a SignalGroup domain name
    // Was previously setSignalGroups_ref, still refers to SignalGroupsRef
    void addSignalGroups(const sstring & name);

    // - Member functions to set a MacroDefs domain name
    // Was previously setMacroDefs_ref, still refers to MacroDefsRef
    void addMacroDefs(const sstring & name);

    // - Member functions to set a Procedure domain name
    // Was previously setProcedures_ref, still refers to ProceduresRef
    void addProcedures(const sstring & name);

    // - Member functions to set/get a ScanStructures domain name
    // Was previously setScanStructures_ref, still refers to ScanStructuresRef
    void addScanStructures(const sstring & name);

    // - Member function to add a Termination definitions
    void addTermination(const STILTerminations&);

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

    // - Memeber function to update the entity list
    void updateEntityList();

    protected: // may be accessed from STILPatternBurst
    // List of STILTerminations
    std::list<STILTerminations> m_termsList;

}; // end STILPatternBurstBlock class


// Inline functions

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::setStart(const sstring & name) {
  addEntity(Start,"Start",name);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::setStop(const sstring & name) {
  addEntity(Stop,"Stop",name);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::addSignalGroups(const sstring & name) {
  addEntity(SignalGroupsRef,"SignalGroups",name);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::addMacroDefs(const sstring & name) {
  addEntity(MacroDefsRef,"MacroDefs",name);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::addProcedures(const sstring & name) {
  addEntity(ProceduresRef,"Procedures",name);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPatternBurstBlock::addScanStructures(const sstring & name) {
  addEntity(ScanStructuresRef,"ScanStructures",name);
}

#endif

---

This page last updated on 6 Jul 2007