stilwaveformtable.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 STILWaveformTable_H
#define STILWaveformTable_H


#include "stilcom.h"               // Common library
#include "stilcomstr.h"
#include "stilblock.h"
#include "stiltimeexpr.h"
#include "stiltimingwaveformref.h"
#include "stilsubwaveforms.h"
#include "stilwaveforms.h"

#include <list>

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILWaveformTable : public STILBlock {

  // - Public members
  public:
    // - Default constructor
    STILWaveformTable();

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

    // - Destructor
    virtual ~STILWaveformTable();

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

    // - Initialize/reset this object
    void  init(const sstring&);

    // - Write this object out to a file
    virtual void write(FILE * pOutFile, LONG indentation=0) const;


    // - Get/Set the period of the waveform table
    void setPeriod(const STILTimeExpr &per);
    const STILTimeExpr& getPeriod() const ;


    // - Get/Set the period resource tag of the waveform table (1450.3 addition)
    void setPeriodResourceTag(const sstring & tag);
    const sstring & getPeriodResourceTag() const;

    // - Add an inherit waveformtable reference
    void addInheritWaveformTable(const sstring);
    void addInheritWaveformTable(const STILTimingWaveformRef &);

    // - Get/Set the subwaveforms block of this object (optional)
    void setSubWaveforms(const STILSubWaveforms &);
    const STILSubWaveforms * getSubWaveforms();

    // - Get/Set the waveforms block of this object (not optional)
    void setWaveforms(const STILWaveforms &);
    const STILWaveforms * getWaveforms();


  // - Private members
  private:
    void updateEntityList(); //when there are some members in here

    // Expression for the time period of this waveform
    STILTimeExpr m_period;

    // Period resource tag value
    sstring m_periodResourceTag;

    // Reference to inherited waveform table
    std::list<STILTimingWaveformRef> m_inhWFTList;

    // Subwaveforms block
    STILSubWaveforms m_swfs;

    // Waveforms block
    STILWaveforms    m_wfs;

};


//--------------------------------------------------------------------------
//-------------------------------------------------------------------------
inline     const STILTimeExpr& STILWaveformTable::getPeriod() const  { return m_period; }

//--------------------------------------------------------------------------
//-------------------------------------------------------------------------
inline     const sstring & STILWaveformTable::getPeriodResourceTag() const   { return m_periodResourceTag; }

//--------------------------------------------------------------------------
//-------------------------------------------------------------------------
inline     const STILSubWaveforms * STILWaveformTable::getSubWaveforms()  { return &m_swfs; }

//--------------------------------------------------------------------------
//-------------------------------------------------------------------------
inline     const STILWaveforms * STILWaveformTable::getWaveforms() { return &m_wfs; }


#endif

---

This page last updated on 6 Jul 2007