mtsCommandQueuedVoid.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, Peter Kazanzides, Anton Deguet
  Created on: 2005-05-02

  (C) Copyright 2005-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 _mtsCommandQueuedVoid_h
#define _mtsCommandQueuedVoid_h

#include <cisstMultiTask/mtsCommandVoid.h>
#include <cisstMultiTask/mtsMailBox.h>

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

class mtsCommandWriteBase;

class CISST_EXPORT mtsCommandQueuedVoid: public mtsCommandVoid
{
 public:
    typedef mtsCommandVoid BaseType;

    typedef mtsCommandQueuedVoid ThisType;

 protected:
    mtsMailBox * MailBox;
    mtsQueue<mtsBlockingType> BlockingFlagQueue;

    mtsQueue<mtsCommandWriteBase *> FinishedEventQueue;

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

 public:
    mtsCommandQueuedVoid(void);

    mtsCommandQueuedVoid(mtsCallableVoidBase * callable,
                         const std::string & name,
                         mtsMailBox * mailBox,
                         size_t size);

    inline virtual ~mtsCommandQueuedVoid() {}


    virtual mtsCommandQueuedVoid * Clone(mtsMailBox * mailBox, size_t size) const;

    inline virtual void Allocate(unsigned int CMN_UNUSED(size)) {}

    mtsExecutionResult Execute(mtsBlockingType blocking);

    mtsExecutionResult Execute(mtsBlockingType blocking,
                               mtsCommandWriteBase *finishedEventHandler);

    mtsBlockingType BlockingFlagGet(void);

    mtsCommandWriteBase *FinishedEventGet(void);

    std::string GetMailBoxName(void) const;

    void ToStream(std::ostream & outputStream) const;
};


#endif // _mtsCommandQueuedVoid_h