mtsCommandRead.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 _mtsCommandRead_h
#define _mtsCommandRead_h


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

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

class CISST_EXPORT mtsCommandRead: public mtsCommandBase {
public:
    typedef mtsCommandBase BaseType;

    typedef mtsCommandRead ThisType;

    typedef mtsCallableReadBase CallableType;

private:
    inline mtsCommandRead(const ThisType & CMN_UNUSED(other));

protected:
    mtsCallableReadBase * Callable;

    const mtsGenericObject * ArgumentPrototype;

public:
    mtsCommandRead(void);

    mtsCommandRead(const std::string & name);


    mtsCommandRead(mtsCallableReadBase * callable,
                   const std::string & name,
                   const mtsGenericObject * argumentPrototype);

    ~mtsCommandRead();

    virtual mtsExecutionResult Execute(mtsGenericObject & argument);

    virtual mtsExecutionResult Execute(mtsGenericObject & argument,
                                       mtsCommandWriteBase * CMN_UNUSED(finishedEventHandler))
    { return Execute(argument); }

    mtsCallableReadBase * GetCallable(void) const;

    virtual const mtsGenericObject * GetArgumentPrototype(void) const;
    // GetResultPrototype is same as GetArgumentPrototype, but provided for
    // consistency with mtsCommandVoidReturn
    virtual const mtsGenericObject * GetResultPrototype(void) const;

    /* documented in base class */
    size_t NumberOfArguments(void) const;

    /* documented in base class */
    bool Returns(void) const;

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


#endif // _mtsCommandRead_h