VectorPortBit.hpp

Go to the documentation of this file.

// Torc - Copyright 2011-2013 University of Southern California.  All Rights Reserved.
// $HeadURL$
// $Id$

// 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_VECTORPORTBIT_HPP
#define TORC_GENERIC_VECTORPORTBIT_HPP

#include "torc/generic/PointerTypes.hpp"

#ifdef GENOM_SERIALIZATION
#include <boost/serialization/access.hpp>
#endif //GENOM_SERIALIZATION
#include "torc/generic/Port.hpp"
#include "torc/generic/VectorBit.hpp"
#include "torc/generic/Error.hpp"
#include "torc/generic/FactoryType.hpp"
#include "torc/generic/VisitorType.hpp"

namespace torc { namespace generic { class BaseVisitor; } }


namespace torc {
namespace generic {

/**
 * @brief Represents a bit of a port.
 * 
 * The VectorPortBit class represents a bit of an array port. Such objects cannot be created in
 * EDIF. They are automatically created when a particular member of an array is accessed using the
 * (member ...) syntax.
 */
class VectorPortBit : public Port, public VectorBit<Port> {

#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION
public:
    typedef FactoryType<VectorPortBit> Factory;
    typedef VisitorType<VectorPortBit> Visitor;

    virtual void accept(BaseVisitor& inoutVisitor) throw (Error);

    virtual Connection connect(const NetSharedPtr& inNet) throw (Error);

    using Connectable::disconnect;

    virtual void disconnect(const Connection& inConnection) throw (Error);

    virtual void getConnectedNets(std::vector<NetSharedPtr>& outNets,
        bool inSkipChildConnections = false) const throw (Error);

    VectorPortBit();

    ~VectorPortBit() throw ();

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

} // namespace generic
} // namespace torc

#endif // TORC_GENERIC_VECTORPORTBIT_HPP