TrainingLog.h

/*
GRT MIT License
Copyright (c) <2012> <Nicholas Gillian, Media Lab, MIT>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
and associated documentation files (the "Software"), to deal in the Software without restriction, 
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial 
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef GRT_TRAINING_LOG_HEADER
#define GRT_TRAINING_LOG_HEADER

#include "Log.h"
#include "ObserverManager.h"

GRT_BEGIN_NAMESPACE
    
class GRT_API TrainingLogMessage{
public:
    TrainingLogMessage(std::string key = "",std::string message = ""){
        this->key = key;
        this->message = message;
    }
    ~TrainingLogMessage(){
        
    }
    
    std::string getProceedingText() const {
        return key;
    }
    
    std::string getMessage() const {
        return message;
    }
    
    std::string key;
    std::string message;
};

class GRT_API TrainingLog : public Log{
public:
    TrainingLog( const std::string &key = "" ) : Log( key )
    {
        Log::loggingEnabledPtr = &trainingLoggingEnabled; 
    }

    virtual ~TrainingLog(){}

    TrainingLog& operator=(const TrainingLog &rhs){
        if( this != &rhs ){
            //Copy the base class
            Log *thisBase = this;
            const Log *rhsBase = &rhs;
            *thisBase = *rhsBase;

            //Perform any custom copies
            this->loggingEnabledPtr = &trainingLoggingEnabled;
        }
        return *this;
    }

    static bool getLoggingEnabled() { 
        return trainingLoggingEnabled; 
    }

    static bool setLoggingEnabled(const bool enabled) { 
        trainingLoggingEnabled = enabled; 
        return true; 
    }
    
    static bool registerObserver(Observer< TrainingLogMessage > &observer);

    static bool removeObserver(Observer< TrainingLogMessage > &observer);

    GRT_DEPRECATED_MSG("enableLogging is deprecated, use setLoggingEnabled instead", static bool enableLogging(bool loggingEnabled) );
    GRT_DEPRECATED_MSG("loggingEnabled is deprecated, use getLoggingEnabled instead", bool loggingEnabled() const );
    
protected:
    virtual void triggerCallback( const std::string &message ) const{
        observerManager.notifyObservers( TrainingLogMessage(key,message) );
        return;
    }
    
    static bool trainingLoggingEnabled;
    static ObserverManager< TrainingLogMessage > observerManager;
};

GRT_END_NAMESPACE

#endif //GRT_TRAINING_LOG_HEADER