mtsCommandBase.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */

/*

  Author(s):  Ankur Kapoor, Anton Deguet
  Created on: 2006-05-02

  (C) Copyright 2006-2009 Johns Hopkins University (JHU), All Rights
  Reserved.

--- begin cisst license - do not edit ---

This software is provided "as is" under an open source license, with
no warranty.  The complete license can be found in license.txt and
http://www.cisst.org/cisst/license.txt.

--- end cisst license ---
*/


#ifndef _mtsCommandBase_h
#define _mtsCommandBase_h

// These two includes are not required to compile this class but are
// pretty much always needed in conjunction with commands.  To ease
// the user's life, we include them now.
//include <cisstMultiTask/mtsGenericObjectProxy.h>
#include <cisstMultiTask/mtsExecutionResult.h>
#include <cisstMultiTask/mtsForwardDeclarations.h>

#include <iostream>
#include <sstream>

class mtsCommandBase {

private:
    inline mtsCommandBase(const mtsCommandBase & CMN_UNUSED(other));

protected:
    std::string Name;

    bool EnableFlag;

public:
    inline mtsCommandBase(void):
        Name("??"),
        EnableFlag(true)
    {}

    inline mtsCommandBase(const std::string & name):
        Name(name),
        EnableFlag(true)
    {}

    virtual ~mtsCommandBase() {}

    virtual std::string ToString(void) const  {
        std::stringstream outputStream;
        ToStream(outputStream);
        return outputStream.str();
    };
    virtual void ToStream(std::ostream & outputStream) const = 0;

    virtual size_t NumberOfArguments(void) const = 0;

    virtual bool Returns(void) const = 0;

    inline void Enable(void) {
        this->EnableFlag = true;
    }

    inline void Disable(void) {
        this->EnableFlag = false;
    }

    inline bool IsEnabled(void) const {
        return this->EnableFlag;
    }

    inline bool IsDisabled(void) const {
        return !(this->EnableFlag);
    }

    inline const std::string & GetName(void) const {
        return this->Name;
    }
};


inline std::ostream & operator << (std::ostream & outputStream,
                                   const mtsCommandBase & command) {
    command.ToStream(outputStream);
    return outputStream;
}


#endif // _mtsCommandBase_h