torc/generic/om/InstanceArrayMember.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/InstanceArrayMember.hpp $
// $Id: InstanceArrayMember.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_INSTANCEARRAYMEMBER_HPP
#define TORC_GENERIC_OM_INSTANCEARRAYMEMBER_HPP

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

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

#include "torc/generic/util/Error.hpp"
#include "torc/generic/om/FactoryType.hpp"
#include "torc/generic/om/Instance.hpp"
#include "torc/generic/om/VectorBit.hpp"
#include "torc/generic/om/VisitorType.hpp"

namespace torc { namespace generic { class BaseVisitor; }  }
namespace torc { namespace generic { class ParameterMap; }  }

namespace torc {

namespace generic {

/**
 * @brief Represents a member of an instance array.
 *
 * The InstanceArrayMember represents a single instance from an array of instances.
 */
class InstanceArrayMember :
    public Instance,
    public VectorBit<Instance> {
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif //GENOM_SERIALIZATION
    

  public:
    typedef VisitorType<InstanceArrayMember> Visitor;
    /**
     * Convenience typedef to create a parameter array element.
     */
    typedef FactoryType<InstanceArrayMember> Factory;

    /**
     * Recive a inoutVisitor to this class. The visit method of the inoutVisitor is called and a reference to this object is passed as a parameter. It has to be noted however, that a dynamic_cast is performed inside this method. If the cast fails, an appropriate exception is thrown by this method. This sitation can arise when the passed Visitor object does not inherit from the appropriate inoutVisitor specialization. See Visitor documentation for more details.
     *
     * @param[in,out] inoutVisitor A reference to the inoutVisitor object
     * @exception Error Visitor type inappropriate for visiting this object or any other error thrown by the Visitor::throw() method.
     */
    virtual void
    accept(BaseVisitor & inoutVisitor) throw(Error);

    /**
      * Returns the parent container's context that will be used to get parameters from
      * the parameter map. For an unbound instance,
      * this will return an invalid value
      */
    virtual ParameterContext
    getParameterContext() const throw();

    /**
     * Get the ParameterMap corresponding to this instance and it's master
     *
     * @return A ParameterMap consisiting of only the overridden parameters.
     */
    virtual ParameterMapSharedPtr
    getParameters() const throw(Error);

    InstanceArrayMember();
    virtual ~InstanceArrayMember() throw();

    /**
     * Flatten an instance so that internal references are resolved to implementation level gates for the instance
     */
    virtual void
    flatten() throw(Error);


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

};

} // namespace torc::generic

} // namespace torc
#endif // TORC_GENERIC_OM_INSTANCEARRAYMEMBER_HPP

---