mtsCallableVoidMethod.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): Anton Deguet
  Created on: 2010-09-26

  (C) Copyright 2010 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 _mtsCallableVoidMethod_h
#define _mtsCallableVoidMethod_h


#include <cisstMultiTask/mtsCallableVoidBase.h>
#include <string>


template <class _classType>
class mtsCallableVoidMethod: public mtsCallableVoidBase {

public:
    typedef mtsCallableVoidBase BaseType;

    typedef _classType ClassType;

    typedef mtsCallableVoidMethod<ClassType> ThisType;

    typedef void(_classType::*ActionType)(void);

private:
    inline mtsCallableVoidMethod(const ThisType & CMN_UNUSED(other)) {}

protected:
    ActionType Action;

    ClassType * ClassInstantiation;

public:
    mtsCallableVoidMethod(void): BaseType(), ClassInstantiation(0) {}

    mtsCallableVoidMethod(ActionType action, ClassType * classInstantiation):
        BaseType(),
        Action(action),
        ClassInstantiation(classInstantiation)
    {}

    virtual ~mtsCallableVoidMethod() {}

    /* documented in base class */
    inline mtsExecutionResult Execute(void) {
        (ClassInstantiation->*Action)();
        return mtsExecutionResult::COMMAND_SUCCEEDED;
    }

    /* documented in base class */
    inline void ToStream(std::ostream & outputStream) const {
        if (this->ClassInstantiation) {
            outputStream << "method based callable void object using class/object \""
                         << mtsObjectName(this->ClassInstantiation) << "\"";
        } else {
            outputStream << "invalid method based callable object";
        }
    }
};

#endif // _mtsCallableVoidMethod_h