stilpattern.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 STILPattern_H
#define STILPattern_H

#include "stilcomstr.h"


#include "stilpatternblock.h"  // STIL PatternBlock Interface (base class)
#include "stilvector.h"        // STIL Vector Interface
#include "stilloop.h"          // STIL Loop Interface

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILPattern : public STILPatternBlock {

  // - Public members
  public:

    // - Default Constructor
    STILPattern();

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

    // - Destructor
    virtual ~STILPattern();

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

    // - Initialize this STILPattern object.
    void init();

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


    // - Get/Set the TimeUnit attribute
    void           setTimeUnit(const sstring &,const sstring & label="");
    const sstring & getTimeUnit() const;

    // - Get/Set the "parser_blocked" attribute for this pattern block.
    //   When the "parser_blocked" attribute is true it indicates that this
    //   pattern block is in a "blocked" state in the parser thread and
    //   the parser thread is waiting for the client thread to use up all
    //   the currently parsed patterns and then "unblock" the parser.
    void           setParserBlocked(bool pb);
    bool           getParserBlocked() const;

    // - Get/Set the "flush" attribute for this pattern block.
    //   When the "flush" attribute is true it indicates that this
    //   pattern block should be flushed by the parser up to the next
    //   pattern block.  The parser should just do syntax checking in
    //   this case and not actually store pattern entries into this
    //   pattern block.
    void           setFlush(bool f);
    bool           getFlush() const;

  // Private members
  private:

    sstring          m_timeUnit;          // TimeUnit Attribute
    bool             m_parserBlocked;    // Is the parser blocked on this pattern
    bool             m_flush;             // Should the parser flush this pat blk

}; // end STILPattern class

// Inline functions
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPattern::setTimeUnit(const sstring & tu,
                                     const sstring & label) {
  m_timeUnit = tu;
  addEntity(TimeUnit,"TimeUnit",tu,label);
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline const sstring & STILPattern::getTimeUnit() const { return m_timeUnit; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPattern::setParserBlocked(bool pb) {
  m_parserBlocked = pb;
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline bool STILPattern::getParserBlocked() const { return m_parserBlocked; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void STILPattern::setFlush(bool f) {
  m_flush = f;
}

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline bool STILPattern::getFlush() const { return m_flush; }



#endif

---

This page last updated on 6 Jul 2007