Command.h

/*
 * This file is part of LSST M1M3 support system package.
 *
 * Developed for the Vera C. Rubin Telescope and Site System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef COMMAND_H_
#define COMMAND_H_
 
#include <string>
 
#include <cRIO/DataTypes.h>
 
namespace LSST {
namespace M1M3 {
namespace SS {

class Command {
public:
    Command(int32_t commandID) : _commandID(commandID) {}
    virtual ~Command();

    inline int32_t getCommandID() { return _commandID; }
 
    virtual double getDefaultTimeout();

    virtual bool validate();

    virtual void execute();
 
    virtual void ackInProgress() { ackInProgress("In-Progress", getDefaultTimeout()); }

    virtual void ackInProgress(const char *description, double timeout);

    virtual void ackComplete();

    virtual void ackFailed(std::string reason);
 
protected:
    int32_t _commandID;
};
 
} /* namespace SS */
} /* namespace M1M3 */
} /* namespace LSST */
 
#endif /* COMMAND_H_ */