directive_sequencer_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_DIRECTIVE_SEQUENCER_INTERFACE_H__
#define __NUGU_DIRECTIVE_SEQUENCER_INTERFACE_H__
 
#include <set>
 
#include <base/nugu_directive.h>
#include <nugu.h>
 
namespace NuguClientKit {
 
enum class BlockingMedium {
    AUDIO = NUGU_DIRECTIVE_MEDIUM_AUDIO, 
    VISUAL = NUGU_DIRECTIVE_MEDIUM_VISUAL, 
    NONE = NUGU_DIRECTIVE_MEDIUM_NONE, 
    ANY = NUGU_DIRECTIVE_MEDIUM_ANY 
};
 
typedef struct _BlockingPolicy {
    BlockingMedium medium; 
    bool isBlocking; 
} BlockingPolicy;
 
class NUGU_API IDirectiveSequencerListener {
public:
    virtual ~IDirectiveSequencerListener() = default;
 
    virtual bool onPreHandleDirective(NuguDirective* ndir) = 0;
 
    virtual bool onHandleDirective(NuguDirective* ndir) = 0;
 
    virtual void onCancelDirective(NuguDirective* ndir) = 0;
};
 
class NUGU_API IDirectiveSequencer {
public:
    virtual ~IDirectiveSequencer() = default;
 
    virtual void addListener(const std::string& name_space, IDirectiveSequencerListener* listener) = 0;
 
    virtual void removeListener(const std::string& name_space, IDirectiveSequencerListener* listener) = 0;
 
    virtual bool addPolicy(const std::string& name_space, const std::string& name, BlockingPolicy policy) = 0;
 
    virtual BlockingPolicy getPolicy(const std::string& name_space, const std::string& name) = 0;
 
    virtual bool cancel(const std::string& dialog_id, bool cancel_active_directive = true) = 0;
 
    virtual bool cancel(const std::string& dialog_id, std::set<std::string> groups) = 0;
 
    virtual bool cancelAll(bool cancel_active_directive = true) = 0;
 
    virtual bool complete(NuguDirective* ndir) = 0;
 
    virtual bool add(NuguDirective* ndir) = 0;
 
    virtual const std::string& getCanceledDialogId() = 0;
 
    virtual const NuguDirective* findPending(const std::string& name_space, const std::string& name) = 0;
};
 
} // NuguClientKit
 
#endif /* __NUGU_DIRECTIVE_SEQUENCER_INTERFACE_H__ */