stilpatternburst.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 STILPatternBurst_H
#define STILPatternBurst_H


#include "stilcom.h"             // Common
#include "stilcomstr.h"
#include "stilpatlist.h"

#include <list>                  // STL doubly linked list class


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILPatternBurst : public STILPatternBurstBlock {

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

  public:

    // - Default Constructor
    STILPatternBurst();

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

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

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

    // - Member function to update Entity list pointers to link list nodes
    void  updateEntityList();

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

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

    // - Member function to add a PatList block
    void  addPatList(const STILPatList& patlist);

    // - Member function to see if a PatternBurst name matches any of its
    //    PatList names (circular recursion)
    bool  locateInPatLists(const sstring& name) const;

    // - Member function to search for a pattern in the PatternBurst hierarchy
    //    note: class STILPatternBursts is declared in "stilpatlist.h"
    void  findPattern(
           const sstring& patname,
           std::list<STILEntity*>& find_list) const;

  private:

    // Note: inherit everything from STILPatList_item

    // - A list of lists of PatList_items (Patterns or nested PatternBursts)
    std::list<STILPatList>           m_patListLists;

}; // end STILPatternBurst class

#endif

---

This page last updated on 6 Jul 2007