mtsCommandWriteBase.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: 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 _mtsCommandWriteBase_h
#define _mtsCommandWriteBase_h


#include <cisstMultiTask/mtsCommandBase.h>
#include <iostream>

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

class mtsCommandWriteBase: public mtsCommandBase {

    friend class mtsMulticastCommandWriteBase;
    friend class mtsCommandQueuedWriteGeneric;

public:
    typedef mtsCommandBase BaseType;

    mtsCommandWriteBase(void):
        BaseType(),
        ArgumentPrototype(0)
    {}

    mtsCommandWriteBase(const std::string & name):
        BaseType(name),
        ArgumentPrototype(0)
    {}

    virtual ~mtsCommandWriteBase() {}

    virtual mtsExecutionResult Execute(const mtsGenericObject & argument, mtsBlockingType blocking) = 0;

    virtual mtsExecutionResult Execute(const mtsGenericObject & argument, mtsBlockingType blocking,
                                       mtsCommandWriteBase * CMN_UNUSED(finishedEventHandler)) = 0;

    /* documented in base class */
    inline size_t NumberOfArguments(void) const {
        return 1;
    }

    /* documented in base class */
    inline bool Returns(void) const {
        return false;
    }

    inline virtual const mtsGenericObject * GetArgumentPrototype(void) const {
        return this->ArgumentPrototype;
    }

    inline const cmnClassServicesBase * GetArgumentClassServices(void) const {
        return this->GetArgumentPrototype()->Services();
    }

protected:

    inline virtual void SetArgumentPrototype(const mtsGenericObject * argumentPrototype) {
        this->ArgumentPrototype = argumentPrototype;
    }

    const mtsGenericObject * ArgumentPrototype;

};


#endif // _mtsCommandWriteBase_h