stilterminations.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 STILTerminations_H
#define STILTerminations_H

#include "stilcom.h"              // Common macros, typedefs
#include "stilcomstr.h"
#include "stilterminationitem.h"  // TerminationItem object

#include <list>                   // STL Linked List Interface

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILTerminations : public STILBlock {

  public:
    // - Default Constructor for a STILTerminations object.
    STILTerminations();

    // - Constructor for a STILTerminations object which sets the Entity type
    STILTerminations(STILEntity::Type t);

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

    // - Destructor for a STILTerminations object.
    virtual ~STILTerminations();

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

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

    // - add a Termination to the list of Terminations
    void  addTerminationItem(const STILTerminationItem &);

    // - clear and setup the new Terminations object
    void init();

  private:

    // ***** Implementation NOTE: ***
    //   After looking at this code quickly again just now, it looks like
    //    the list below should instead be replaced by the base entity list,
    //    and then adding each
    //    termination item would be a call to an addEntity (simple entity) call.
    //   Not sure why this is implemented as it's own list. It could be
    //    that this code hasnt been touched since the very beginning.
    //   In any case - see if this can be replaced with an addEntity() call,
    //    and if so, fix it !!!

    // list of STILTerminationItems for this Termination block
    std::list<STILTerminationItem> m_termItemList;

};  // end class STILTerminations

#endif

---

This page last updated on 6 Jul 2007