mtsCommandQualifiedRead.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 _mtsCommandQualifiedRead_h
#define _mtsCommandQualifiedRead_h


#include <cisstMultiTask/mtsCommandBase.h>


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

    typedef mtsCommandQualifiedRead ThisType;

    typedef mtsCallableQualifiedReadBase CallableType;

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

protected:
    mtsCallableQualifiedReadBase * Callable;

    const mtsGenericObject * Argument1Prototype;

    const mtsGenericObject * Argument2Prototype;

public:
    mtsCommandQualifiedRead(void);

    mtsCommandQualifiedRead(const std::string & name);

    mtsCommandQualifiedRead(mtsCallableQualifiedReadBase * callable,
                            const std::string & name,
                            const mtsGenericObject * argument1Prototype,
                            const mtsGenericObject * argument2Prototype);

    virtual ~mtsCommandQualifiedRead();

    virtual mtsExecutionResult Execute(const mtsGenericObject & argument1,
                                       mtsGenericObject & argument2);

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

    mtsCallableQualifiedReadBase * GetCallable(void) const;

    const mtsGenericObject * GetArgument1Prototype(void) const;

    const mtsGenericObject * GetArgument2Prototype(void) const;

    // Following are provided for consistency with mtsCommandWriteReturn
    const mtsGenericObject * GetArgumentPrototype(void) const;
    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 // _mtsCommandQualifiedRead_h