routine_manager_interface.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NUGU_ROUTINE_MANAGER_INTERFACE_H__
#define __NUGU_ROUTINE_MANAGER_INTERFACE_H__
 
#include <functional>
#include <njson/njson.h>
 
#include <base/nugu_directive.h>
#include <nugu.h>
 
namespace NuguClientKit {
 
enum class RoutineActivity {
    IDLE, 
    PLAYING, 
    INTERRUPTED, 
    FINISHED, 
    STOPPED, 
    SUSPENDED 
};
 
class NUGU_API IRoutineManagerListener {
public:
    virtual ~IRoutineManagerListener() = default;
 
    virtual void onActivity(RoutineActivity activity) = 0;
 
    virtual void onActionTimeout(bool last_action = false) = 0;
};
 
class NUGU_API IRoutineManager {
public:
    using TextRequester = std::function<std::string(const std::string&, const std::string&, const std::string&)>;
    using DataRequester = std::function<std::string(const std::string&, const NJson::Value&)>;
 
public:
    virtual ~IRoutineManager() = default;
 
    virtual void addListener(IRoutineManagerListener* listener) = 0;
 
    virtual void removeListener(IRoutineManagerListener* listener) = 0;
 
    virtual void setTextRequester(TextRequester requester) = 0;
 
    virtual void setDataRequester(DataRequester requester) = 0;
 
    virtual bool start(const std::string& token, const NJson::Value& actions) = 0;
 
    virtual void stop() = 0;
 
    virtual void interrupt() = 0;
 
    virtual void resume() = 0;
 
    virtual bool move(unsigned int index) = 0;
 
    virtual void finish() = 0;
 
    virtual std::string getCurrentActionToken() = 0;
 
    virtual unsigned int getCurrentActionIndex() = 0;
 
    virtual unsigned int getCountableActionSize() = 0;
 
    virtual unsigned int getCountableActionIndex() = 0;
 
    virtual bool isActionValid(const NJson::Value& action) = 0;
 
    virtual bool isRoutineProgress() = 0;
 
    virtual bool isRoutineAlive() = 0;
 
    virtual bool isActionProgress(const std::string& dialog_id) = 0;
 
    virtual bool hasRoutineDirective(const NuguDirective* ndir) = 0;
 
    virtual bool isConditionToStop(const NuguDirective* ndir) = 0;
 
    virtual bool isConditionToFinishAction(const NuguDirective* ndir) = 0;
 
    virtual bool isConditionToCancel(const NuguDirective* ndir) = 0;
 
    virtual bool isMuteDelayed() = 0;
 
    virtual void presetActionTimeout() = 0;
 
    virtual void setPendingStop(const NuguDirective* ndir) = 0;
 
    virtual bool hasToSkipMedia(const std::string& dialog_id) = 0;
};
 
} // NuguClientKit
 
#endif /* __NUGU_ROUTINE_MANAGER_INTERFACE_H__ */