mtsCallableVoidFunction.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 _mtsCallableVoidFunction_h
#define _mtsCallableVoidFunction_h

class mtsCallableVoidFunction: public mtsCallableVoidBase {

public:
    typedef mtsCallableVoidBase BaseType;

    typedef mtsCallableVoidFunction ThisType;

    typedef void(*ActionType)(void);

private:
    inline mtsCallableVoidFunction(const ThisType & CMN_UNUSED(other));

protected:
    ActionType Action;

public:
    mtsCallableVoidFunction(): BaseType(), Action(0) {}

    mtsCallableVoidFunction(ActionType action):
        BaseType(),
        Action(action)
    {}

    virtual ~mtsCallableVoidFunction() {}

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

    /* documented in base class */
    inline void ToStream(std::ostream & outputStream) const {
        outputStream << "function based callable object";
    }

};


#endif // _mtsCallableVoidFunction_h