mtsCommandVoid.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: 2004-04-30

  (C) Copyright 2004-2014 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 _mtsCommandVoid_h
#define _mtsCommandVoid_h


#include <cisstMultiTask/mtsCommandBase.h>

// Always include last
#include <cisstMultiTask/mtsExport.h>

class CISST_EXPORT mtsCommandVoid: public mtsCommandBase {

public:
    typedef mtsCommandBase BaseType;

    typedef mtsCommandVoid ThisType;

private:
    mtsCommandVoid(const ThisType & CMN_UNUSED(other));

protected:
    mtsCallableVoidBase * Callable;

public:
    mtsCommandVoid(void);

    mtsCommandVoid(mtsCallableVoidBase * callable, const std::string & name);

    virtual ~mtsCommandVoid();

    virtual mtsExecutionResult Execute(mtsBlockingType CMN_UNUSED(blocking));

    virtual mtsExecutionResult Execute(mtsBlockingType blocking,
                                       mtsCommandWriteBase * CMN_UNUSED(finishedEventHandler))
    { return Execute(blocking); }

    mtsCallableVoidBase * GetCallable(void) const;

    /* documented in base class */
    void ToStream(std::ostream & outputStream) const;

    /* documented in base class */
    size_t NumberOfArguments(void) const;

    /* documented in base class */
    bool Returns(void) const;
};


#endif // _mtsCommandVoid_h