stilpatlist.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 STILPatList_H
#define STILPatList_H

#include "stilcom.h"                 // Common
#include "stilcomstr.h"
#include <list>                      // STL doubly linked list class

#include "stilpatternburstblock.h"


//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILPatList : public STILBlock {

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

  public:

    // - Default Constructor
    STILPatList();

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

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

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

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

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

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


    // - Member function to add a PatternBurstBlock
    void  addBlock(const STILPatternBurstBlock& block);

    // - Member function to see if a name specified matches any PatternBurstBlock name
    bool  locate_inPatList(const sstring& name) const;

  private:

    // A list of PatList items (Pattern or PatternBurst references)
    std::list<STILPatternBurstBlock>      m_patListList;

}; // end STILPatList class


#endif

---

This page last updated on 6 Jul 2007