torc/generic/om/PortAttributes.hpp

// Torc - Copyright 2011 University of Southern California.  All Rights Reserved.
// $HeadURL: https://torc-isi.svn.sourceforge.net/svnroot/torc-isi/branches/staging/0.9/src/torc/generic/om/PortAttributes.hpp $
// $Id: PortAttributes.hpp 10 2011-10-12 18:40:16Z nsteiner $

// This program is free software: you can redistribute it and/or modify it under the terms of the 
// GNU General Public License as published by the Free Software Foundation, either version 3 of the 
// License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; 
// without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See 
// the GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License along with this program.  If 
// not, see <http://www.gnu.org/licenses/>.

#ifndef TORC_GENERIC_OM_PORTATTRIBUTES_HPP
#define TORC_GENERIC_OM_PORTATTRIBUTES_HPP

#include "torc/generic/om/DumpRestoreConfig.hpp"

#ifdef GENOM_SERIALIZATION
#include <boost/serialization/access.hpp>
#endif //GENOM_SERIALIZATION

#include "torc/generic/om/PortDelay.hpp"
#include "torc/generic/om/Value.hpp"

namespace torc {

namespace generic {

/**
 * @brief Represents attributes of a Port or PortReference object
 * 
 * The PortAttributes class stores some optional attributes of a Port or overridden values in a PortReference object. The values can be set from an EDIF file using the (port ...), (portBackAnnotate ...) or the (portInstance ...) constructs. The main logic of bringing this out of the Port/PortReference objects is to save space.
 */
class PortAttributes
{
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION

  public:
    inline const Value
    getUnused() const throw();

    void
    setUnused( const Value &inSource ) throw();

    inline const Value
    getDesignator() const throw();

    void
    setDesignator( const Value &inSource ) throw();

    inline const Value
    getAcLoad() const throw();

    void
    setAcLoad(const Value & inSource) throw();

    inline const PortDelay
    getPortDelay() const throw();

    inline const bool
    getIsPortDelaySet() const throw();

    void
    setPortDelay(const PortDelay & inSource) throw();

    inline const Value
    getDcFaninLoad() const throw();

    void
    setDcFaninLoad(const Value & inSource) throw();

    inline const Value
    getDcFanoutLoad() const throw();

    void
    setDcFanoutLoad(const Value & inSource) throw();

    inline const Value
    getDcMaxFanin() const throw();

    void
    setDcMaxFanin(const Value & inSource) throw();

    inline const Value
    getDcMaxFanout() const throw();

    void
    setDcMaxFanout(const Value & inSource) throw();

    PortAttributes();

    ~PortAttributes() throw();

    PortAttributes(const PortAttributes & inSource);

    PortAttributes &
    operator=(const PortAttributes & inSource) throw();

  private:
#ifdef GENOM_SERIALIZATION
    template<class Archive> void
    serialize( Archive &ar, unsigned int );
#endif //GENOM_SERIALIZATION

    Value mUnused;
    Value mDesignator;
    Value mDcFaninLoad;
    Value mDcFanoutLoad;
    Value mDcMaxFanin;
    Value mDcMaxFanout;
    Value mAcLoad;
    PortDelay mPortDelay;
    bool mPortDelaySet;
};

inline const Value
PortAttributes::getUnused() const throw() {
    return mUnused;
}

inline const Value
PortAttributes::getDesignator() const throw() {
    return mDesignator;
}

inline const Value
PortAttributes::getAcLoad() const throw() {
  return mAcLoad;
}

inline const PortDelay
PortAttributes::getPortDelay() const throw() {
  return mPortDelay;
}

inline const bool
PortAttributes::getIsPortDelaySet() const throw() {
  return mPortDelaySet;
}

inline const Value
PortAttributes::getDcFaninLoad() const throw() {
  return mDcFaninLoad;
}

inline const Value
PortAttributes::getDcFanoutLoad() const throw() {
  return mDcFanoutLoad;
}

inline const Value
PortAttributes::getDcMaxFanin() const throw() {
  return mDcMaxFanin;
}

inline const Value
PortAttributes::getDcMaxFanout() const throw() {
  return mDcMaxFanout;
}

} // namespace torc::generic

} // namespace torc
#endif // TORC_GENERIC_OM_PORTATTRIBUTES_HPP

---