mtsFunctionVoid.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):  Peter Kazanzides, Anton Deguet

  (C) Copyright 2007-2011 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 _mtsFunctionVoid_h
#define _mtsFunctionVoid_h

#include <cisstMultiTask/mtsCommandBase.h>
#include <cisstMultiTask/mtsFunctionBase.h>
#include <cisstMultiTask/mtsForwardDeclarations.h>

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

class CISST_EXPORT mtsFunctionVoid: public mtsFunctionBase {
 public:
    typedef mtsCommandVoid CommandType;
 protected:
    CommandType * Command;

 public:
    mtsFunctionVoid(const bool isProxy = false);

    ~mtsFunctionVoid();

    // documented in base class
    bool Detach(void);

    // documented in base class
    bool IsValid(void) const;

    bool Bind(CommandType * command);

    mtsExecutionResult operator()(void) const { return Execute(); }

    mtsExecutionResult Execute(void) const;

    mtsExecutionResult ExecuteBlocking(void) const;

    mtsCommandVoid * GetCommand(void) const;

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


#endif // _mtsFunctionVoid_h