mtsFunctionBase.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-2026 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 _mtsFunctionBase_h
#define _mtsFunctionBase_h
 
#include <cisstOSAbstraction/osaForwardDeclarations.h>
#include <cisstMultiTask/mtsExecutionResult.h>
#include <cisstMultiTask/mtsForwardDeclarations.h>
 
// Always include last
#include <cisstMultiTask/mtsExport.h>
 
class mtsEventReceiverWrite;
 
class CISST_EXPORT mtsFunctionBase {
 
protected:
    mtsFunctionBase();

    virtual ~mtsFunctionBase();

    osaThreadSignal * ThreadSignal;

    mtsEventReceiverWrite *CompletionCommand;
 
public:
    virtual bool Detach(void) = 0;

    virtual bool IsValid(void) const = 0;

    virtual void ToStream(std::ostream & outputStream) const = 0;

    virtual void InitCompletionCommand(const std::string &name);

    virtual void DeleteCompletionCommand(void);

    void SetThreadSignal(osaThreadSignal * threadSignal);

    void ThreadSignalWait(void) const;

    mtsExecutionResult WaitForResult(void) const;
};
 

inline std::ostream & operator << (std::ostream & output,
                                   const mtsFunctionBase & function) {
    function.ToStream(output);
    return output;
}
 
 
#endif // _mtsFunctionBase_h