source: code/branches/presentation2012merge/src/orxonox/pickup/PickupIdentifier.cc @ 9314

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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 2
 *   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, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */

/**
    @file PickupIdentifier.cc
    @brief Implementation of the PickupIdentifier class.
*/

#include "PickupIdentifier.h"

#include "core/CoreIncludes.h"
#include "core/Identifier.h"

#include "interfaces/Pickupable.h"

namespace orxonox
{

    /**
    @brief
        Constructor. Registers the object and initializes member variables.
    */
    PickupIdentifier::PickupIdentifier(Pickupable* pickup)
    {
        RegisterRootObject(PickupIdentifier);

        if(pickup == NULL)
            orxout(internal_error, context::pickups) << "PickupIdentifier was created without a valid Pickupable." << endl;

        this->pickup_ = pickup;
    }

    PickupIdentifier::~PickupIdentifier()
    {

    }

    /**
    @brief
        Compares two PickupIdentifiers and returns 0 if a == b, <0 if a < b and >0 if a > b for a.compare(b).
    @param identifier
        Pointer to the second PickupIdentifier, b.
    @return
        Returns an integer. 0 if the two compared PickupIdentifiers are the same, <0 if a < b and >0 if a > b.
    */
    int PickupIdentifier::compare(const PickupIdentifier* identifier) const
    {
        assert(identifier);
        assert(identifier->pickup_);
        assert(this->pickup_);

        // If the classIdentifiers are not the same (meaning the PickupIdentifiers identify different classes), then obviously the two Pickupables identified by the PickupIdentifiers cannot be the same. An ordering is established through the alphabetical ordering of the respective classnames.
        if(identifier->pickup_->getIdentifier() != this->pickup_->getIdentifier())
            return this->pickup_->getIdentifier()->getName().compare(identifier->pickup_->getIdentifier()->getName());

        // If the class is the same for both PickupIdentifiers we go on to check the parameters of the class.
        // If the two have a different number of parameters then obviously something is very wrong.
        if(this->parameters_.size() != identifier->parameters_.size())
        {
            orxout(internal_error, context::pickups) << "Two PickupIdentifiers of the same Class have a different number of parameters. " << this->parameters_.size() << " vs. " << identifier->parameters_.size() << ". This indicates a bug in " << this->pickup_->getIdentifier()->getName() << "." << endl;
            return this->parameters_.size()-identifier->parameters_.size();
        }

        // We iterate through all parameters and compare their values (which are strings). The ordering is once again established by the alphabetical comparison of the two value strings.
        std::map<std::string, std::string>::const_iterator it1 = this->parameters_.begin();
        std::map<std::string, std::string>::const_iterator it2 = identifier->parameters_.begin();
        for( ; it1 != this->parameters_.end(); ++it1, ++it2)
        {
            // If a parameter present in one of the identifiers is not found in the other, once again, something is very wrong.
            if(it1->first != it2->first)
            {
                orxout(internal_error, context::pickups) << this->pickup_->getIdentifier()->getName() <<  " Something went wrong in PickupIdentifier!" << endl;
                return it1->first.compare(it2->first);
            }

            int result = it1->second.compare(it2->second);
            if(result != 0)
                return result;
        }

        return 0;
    }

    /**
    @brief
        Add a parameter to the PickupIdentifier.
    @param name
        The name of the parameter.
    @param value
        The value of the parameter.
    @return
        Returns false if the parameter already existed, true if not.
    */
    bool PickupIdentifier::addParameter(const std::string& name, const MultiType& value)
    {
        orxout(verbose, context::pickups) << "PickupIdentifier " << name << ", " << value << endl;

        if(!(this->parameters_.find(name) == this->parameters_.end()))
        {
            orxout(verbose, context::pickups) << "Request for adding a parameter that already exists for the PickupIdentififer was denied. name: '" << name << "', value: '" << value << "'."<<  endl;
            return false;
        }

        this->parameters_[name] = value.getString();

        return true;
    }

}