/* -*- 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-16 (C) Copyright 2010-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 --- */ /*! \file \brief Define an internal command for cisstMultiTask */ #ifndef _mtsCommandQueuedWriteReturn_h #define _mtsCommandQueuedWriteReturn_h #include #include #include #include // Always include last #include class mtsCommandWriteBase; /*! \ingroup cisstMultiTask */ template class mtsCommandQueuedWriteReturnBase: public _Base { public: typedef _Base BaseType; /*! This type. */ typedef mtsCommandQueuedWriteReturnBase<_Base> ThisType; typedef typename _Base::CallableType CallableType; protected: /*! Mailbox used to queue the commands */ mtsMailBox * MailBox; size_t ArgumentQueueSize; // size used for queues /*! Queue to store arguments */ mtsQueueGeneric ArgumentsQueue; /*! Queue to store pointer to return value */ mtsQueue ReturnsQueue; /*! Queue for return events (to send result to caller) */ mtsQueue FinishedEventQueue; private: /*! Private default constructor to prevent use. */ mtsCommandQueuedWriteReturnBase(void); /*! Private copy constructor to prevent copies */ mtsCommandQueuedWriteReturnBase(const ThisType & CMN_UNUSED(other)); public: /*! Constructor */ mtsCommandQueuedWriteReturnBase(CallableType * callable, const std::string & name, const mtsGenericObject * argumentPrototype, const mtsGenericObject * resultPrototype, mtsMailBox * mailBox, size_t size); /*! Destructor */ virtual ~mtsCommandQueuedWriteReturnBase(); virtual std::string GetClassName(void) const; virtual ThisType * Clone(mtsMailBox * mailBox, size_t size) const; // virtual method defined in base class mtsExecutionResult Execute(const mtsGenericObject & argument, mtsGenericObject & result); // virtual method defined in base class mtsExecutionResult Execute(const mtsGenericObject & argument, mtsGenericObject & result, mtsCommandWriteBase * finishedEventHandler); std::string GetMailBoxName(void) const; inline virtual mtsGenericObject * ArgumentPeek(void) { return ArgumentsQueue.Peek(); } inline virtual mtsGenericObject * ArgumentGet(void) { return ArgumentsQueue.Get(); } inline virtual mtsGenericObject * ReturnGet(void) { return *(ReturnsQueue.Get()); } inline virtual mtsCommandWriteBase * FinishedEventGet(void) { return *(FinishedEventQueue.Get()); } void ToStream(std::ostream & outputStream) const; }; typedef mtsCommandQueuedWriteReturnBase mtsCommandQueuedWriteReturn; typedef mtsCommandQueuedWriteReturnBase mtsCommandQueuedQualifiedRead; #ifdef CISST_COMPILER_IS_MSVC #pragma warning ( disable : 4661 ) template class CISST_EXPORT mtsCommandQueuedWriteReturnBase; template class CISST_EXPORT mtsCommandQueuedWriteReturnBase; #endif #endif // _mtsCommandQueuedWriteReturn_h