stilsignal.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 STILSignal_H
#define STILSignal_H

#include "stilsignalblock.h"

//forward prototype
class STILSignalList;

// STILSignal Class
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
class STILSignal : public STILSignalBlock {

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

  // - Allow STILSignalList to access data members
  friend class STILSignalList;

  // - Public members
  public:

    // The basic type of usage for this signal
    enum Usage {
      UndefinedUsage, 
      In,             
      Out,            
      InOut,          
      Supply,         
      Pseudo          
    };

    // - Default Constructor
    STILSignal();

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

    // - Destructor
    virtual ~STILSignal();

    // - Assignment Operator
    STILSignal & operator=(const STILSignal &);

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

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


    // - Member functions to set/get Usage
    void              setUsage(Usage) ;
    Usage             getUsage() const;

    // - Member functions to get/set first & last array index (-1 if not an array)
    LONG              getFirstIndex() const;
    void              setFirstIndex(LONG);
    LONG              getLastIndex() const;
    void              setLastIndex(LONG);

    // - Member functions to set/get ID.  ID will be a unique numeric
    // identifier for this signal.  It will be indicative of the count
    // (starting at 0) of this particular signal object in the Signals block.
    void              setID(LONG) ;
    LONG              getID() const;

    // - Static Member functions to convert enumerations to sstring values
    static const sstring &    convertUsage(Usage);

  // Private members
  private:
    // - Set the base data members to the SignalGroup base values (for
    // - flattening from SignalGroups into a SignalList)
    void resetBaseValues (const STILSignalBlock*);

    // Usage for this signal
    Usage                       m_usage;

    // First & Last index if this is a Signal array
    // NOTE: For every Signal declaration XYZ[m..n] in the signals block
    //       there will be a separate Signal object even if the base name
    //       "XYZ" is the same.  It is an error to have more than one
    //       XYZ signal declarations that share index values.
    LONG                        m_firstIndex; // -1 if not declared as an array
    LONG                        m_lastIndex;  // -1 if not declared as an array

    // A unique numeric ID for a given signal.  This ID value is actually
    // the running count (starting at 0) of this particular signal entry in the
    // Signals block.
    // Note: For signal array entries this is the count of the first element
    //       of the array.
    LONG                        m_id;

}; // end STILSignal class


// Inline functions
//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void              STILSignal::setUsage(Usage u) { m_usage = u; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline STILSignal::Usage STILSignal::getUsage() const { return m_usage; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline LONG              STILSignal::getFirstIndex() const { return m_firstIndex; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void              STILSignal::setFirstIndex(LONG i) { m_firstIndex = i; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline LONG              STILSignal::getLastIndex() const { return m_lastIndex; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void              STILSignal::setLastIndex(LONG i) { m_lastIndex = i; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline LONG              STILSignal::getID() const { return m_id; }

//--------------------------------------------------------------------------
//--------------------------------------------------------------------------
inline void              STILSignal::setID(LONG i) { m_id = i; }

#endif

---

This page last updated on 6 Jul 2007