Nameable.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_NAMEABLE_HPP
#define TORC_GENERIC_NAMEABLE_HPP

//BOOST
#ifdef GENOM_SERIALIZATION
#include <boost/serialization/access.hpp>
#include <boost/serialization/weak_ptr.hpp>
#endif //GENOM_SERIALIZATION
#include "torc/generic/Error.hpp"

namespace torc {
namespace generic {

/**
 * @brief An object that has a name
 * 
 * The Nameable class provides an interface for and implements functionality that allows an object of a derivd class to have a string name.
 */
class Nameable {
#ifdef GENOM_SERIALIZATION
    friend class boost::serialization::access;
#endif

protected:
    explicit Nameable();

public:
    virtual ~Nameable() throw ();

private:
    Nameable(const Nameable& source);

    Nameable& operator=(const Nameable& source);

public:
    /**
     * Get the object name
     *
     * @return Name of the object
     */
    inline virtual const std::string getName() const;

    /**
     * Set a name for this object
     *
     * @param[in] inSource Name of the object
     *
     * @exception Error Could not set name, because name is empty (Will be used by array members)
     *       <ul>
     *         <li>
     *             Id : eMessageIdErrorEmptyItemName
     *         </li>
     *         <li> Context Data
     *           <ul>
     *               <li>Nameable - <i>String</i></li>
     *           </ul>
     *         </li>
     *       </ul>
     */
    void setName(const std::string& inSource) throw (Error);

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

/**
 * Get the object name
 * 
 * @return Name of the object
 */
inline const std::string Nameable::getName() const {
    return mName;
}

} // namespace generic
} // namespace torc

#endif // TORC_GENERIC_NAMEABLE_HPP