mtsInterfaceRequiredOrInput.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):  Peter Kazanzides, Anton Deguet, Min Yang Jung
  Created on: 2008-11-13

  (C) Copyright 2008-2011 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 ---
*/

#error File deprecated

#ifndef _mtsInterfaceRequiredOrInput_h
#define _mtsInterfaceRequiredOrInput_h

#include <cisstCommon/cmnGenericObject.h>
#include <cisstCommon/cmnClassRegisterMacros.h>

#include <cisstMultiTask/mtsForwardDeclarations.h>

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


class CISST_EXPORT mtsInterfaceRequiredOrInput: public cmnGenericObject
{
    friend class mtsComponentProxy;
    friend class mtsComponentInterfaceProxyClient;
    friend class mtsManagerLocal;
    friend class mtsManagerLocalTest;

protected:

    const std::string Name;

    mtsComponent * Component;

    mtsRequiredType Required;

    mtsInterfaceRequiredOrInput(void) {}

 public:
    mtsInterfaceRequiredOrInput(const std::string & interfaceName,
                                mtsComponent * component,
                                mtsRequiredType required = MTS_REQUIRED);

    virtual ~mtsInterfaceRequiredOrInput();

    const std::string & GetName(void) const;

    const std::string GetFullName(void) const;

    const mtsComponent * GetComponent(void) const;

    virtual const mtsInterfaceProvidedOrOutput * GetConnectedInterface(void) const = 0;

    virtual bool CouldConnectTo(mtsInterfaceProvidedOrOutput * interfaceProvidedOrOutput) = 0;
    virtual bool ConnectTo(mtsInterfaceProvidedOrOutput * interfaceProvidedOrOutput) = 0;
    virtual bool Disconnect(void) = 0;

    mtsRequiredType IsRequired(void) const;

    // bool BindCommandsAndEvents(unsigned int userId);
};


#endif // _mtsInterfaceRequiredOrInput_h