stilwaveformevent.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 STILWaveformEvent_H
#define STILWaveformEvent_H


#include "stilcom.h"               // Common library
#include "stilblock.h"
#include "stiltimeexpr.h"
#include "stileventlist.h"
#include "stilevent.h"
#include "stilcomstr.h"

#define POUND_SIGN -2
#define UNDEFD_VAL -1

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILWaveformEvent : public STILEntity {

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

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

    // - Destructor
    virtual ~STILWaveformEvent();

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

    // - Initialize/reset this object
    void init();

    // - Get/Set the time expression
    void setTimeExpr(const STILTimeExpr &arg);
    const STILTimeExpr* getTimeExpr() const;

    // - Get/Set a list of events corresponding to the time expression
    void setEventList(const STILEventList &);
    const STILEventList* getEventList() const;

    // - Get/Set an event number to correspond with this event
    void setEventNum(const LONG);
    LONG getEventNum() const;

    // - Set the subwaveformlabel associated with this object
    // (only available in Waveforms blocks)
    void setSubWaveformLabel(const sstring);
    sstring getSubWaveformLabel() const;

    // - Set the subwaveformnum associated with this object
    // (only available in Waveforms blocks)
    void setSubWaveformNum(const LONG);
    LONG getSubWaveformNum() const;

    // - Set the subwaveformrepeat associated with this object
    // (only available in Waveforms blocks)
    void setSubWaveformRepeat(const LONG);
    LONG getSubWaveformRepeat() const;

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


  // - Private members
  private:

    STILTimeExpr m_timeExpr; //The time expr

    LONG   m_eventNum,        //event number
           m_repeat,           //repeat count
           m_SWFNum;          //subwaveform number, -1=uninit'd, -2=#

    sstring m_SWFLabel;

    //The list of events, (force, expect, compare, and unresolved events)
    STILEventList m_eventList;


};

// - Get/Set the time expression
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    void STILWaveformEvent::setTimeExpr(const STILTimeExpr &arg) { m_timeExpr = arg;   }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    const STILTimeExpr* STILWaveformEvent::getTimeExpr() const         { return &m_timeExpr; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    const STILEventList* STILWaveformEvent::getEventList() const       { return &m_eventList; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    LONG STILWaveformEvent::getEventNum() const  { return m_eventNum; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    sstring STILWaveformEvent::getSubWaveformLabel() const         { return m_SWFLabel; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
    // - Set the subwaveformnum associated with this object
    // (only available in Waveforms blocks)
inline    LONG STILWaveformEvent::getSubWaveformNum() const       { return m_SWFNum;  }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline    LONG STILWaveformEvent::getSubWaveformRepeat() const         { return m_repeat; }


#endif

---

This page last updated on 6 Jul 2007