mtsInterfaceRequiredOrInput Class Reference

#include <mtsInterfaceRequiredOrInput.h>

Inheritance diagram for mtsInterfaceRequiredOrInput:

Public Member Functions
	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
Public Member Functions inherited from cmnGenericObject
virtual	~cmnGenericObject (void)
virtual const cmnClassServicesBase *	Services (void) const =0
bool	ReconstructFrom (const cmnGenericObject &other)
std::string	ToString (void) const
virtual void	ToStream (std::ostream &outputStream) const
virtual void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
virtual void	SerializeRaw (std::ostream &outputStream) const
virtual void	DeSerializeRaw (std::istream &inputStream)
virtual cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
virtual size_t	ScalarNumber (void) const
virtual bool	ScalarNumberIsFixed (void) const
virtual double	Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
	mtsInterfaceRequiredOrInput (void)

Protected Attributes
const std::string	Name
mtsComponent *	Component
mtsRequiredType	Required

Friends
class	mtsComponentProxy
class	mtsComponentInterfaceProxyClient
class	mtsManagerLocal
class	mtsManagerLocalTest

Detailed Description

Base class for mtsInterfaceRequired and mtsInterfaceInput. This class contains pure virtual methods and can not be instantiated.

Constructor & Destructor Documentation

mtsInterfaceRequiredOrInput::mtsInterfaceRequiredOrInput ( void  )

inlineprotected

Default constructor. Does nothing, should not be used.

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

Constructor. Sets the name.

Parameters

interfaceName

Name of required interface

virtual mtsInterfaceRequiredOrInput::~mtsInterfaceRequiredOrInput ( )

virtual

Default destructor.

Member Function Documentation

virtual bool mtsInterfaceRequiredOrInput::ConnectTo ( mtsInterfaceProvidedOrOutput *  interfaceProvidedOrOutput )

pure virtual

virtual bool mtsInterfaceRequiredOrInput::CouldConnectTo ( mtsInterfaceProvidedOrOutput *  interfaceProvidedOrOutput )

pure virtual

virtual bool mtsInterfaceRequiredOrInput::Disconnect ( void  )

pure virtual

const mtsComponent* mtsInterfaceRequiredOrInput::GetComponent

(

void

)

const

Get a const pointer on the component

virtual const mtsInterfaceProvidedOrOutput* mtsInterfaceRequiredOrInput::GetConnectedInterface ( void  ) const

pure virtual

const std::string mtsInterfaceRequiredOrInput::GetFullName

(

void

)

const

Returns the name of the this interface as well as the component that owns the interface.

const std::string& mtsInterfaceRequiredOrInput::GetName

(

void

)

const

Returns the name of the interface.

mtsRequiredType mtsInterfaceRequiredOrInput::IsRequired

(

void

)

const

Check if this interface is required or not for the component to function.

Friends And Related Function Documentation

friend class mtsComponentInterfaceProxyClient

friend

friend class mtsComponentProxy

friend

friend class mtsManagerLocal

friend

friend class mtsManagerLocalTest

friend

Member Data Documentation

mtsComponent* mtsInterfaceRequiredOrInput::Component

protected

Pointer on the device itself.

const std::string mtsInterfaceRequiredOrInput::Name

protected

A string identifying the 'Name' of the required interface.

mtsRequiredType mtsInterfaceRequiredOrInput::Required

protected

Indicates if the interface must be connected.

---

The documentation for this class was generated from the following file:

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsInterfaceRequiredOrInput.h