mtsInterfaceInput Class Reference

#include <mtsInterfaceInput.h>

Inheritance diagram for mtsInterfaceInput:

Public Member Functions
	mtsInterfaceInput (const std::string &interfaceName, mtsComponent *component)
virtual	~mtsInterfaceInput ()
const mtsInterfaceOutput *	GetConnectedInterface (void) const
ConnectionIDType	GetConnectionID (void) const
virtual bool	CouldConnectTo (mtsInterfaceOutput *interfaceOutput)=0
virtual bool	ConnectTo (mtsInterfaceOutput *interfacePOutput)=0
virtual bool	Disconnect (void)=0
Public Member Functions inherited from mtsInterface
	mtsInterface (const std::string &interfaceName, mtsComponent *component)
virtual	~mtsInterface ()
const std::string &	GetName (void) const
const std::string	GetFullName (void) const
const mtsComponent *	GetComponent (void) const
const std::string &	GetComponentName (void) const
void	AddTag (const std::string &tag)
const std::set< std::string > &	GetTags (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 CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Protected Member Functions
	mtsInterfaceInput (void)
Protected Member Functions inherited from mtsInterface
void	Initialize (void)

Protected Attributes
mtsInterfaceOutput *	InterfaceOutput
ConnectionIDType	ConnectionID
Protected Attributes inherited from mtsInterface
const std::string	Name
mtsComponent *	Component
std::set< std::string >	mTags

Friends
class	mtsManagerComponent

Constructor & Destructor Documentation

mtsInterfaceInput() [1/2]

mtsInterfaceInput::mtsInterfaceInput ( void )

protected

Default constructor. Does nothing, should not be used.

mtsInterfaceInput() [2/2]

mtsInterfaceInput::mtsInterfaceInput	(	const std::string &	interfaceName,
		mtsComponent *	component )

Constructor. Sets the name.

Parameters

interfaceName

Name of input interface

~mtsInterfaceInput()

virtual mtsInterfaceInput::~mtsInterfaceInput ( )

virtual

Default destructor.

Member Function Documentation

ConnectTo()

virtual bool mtsInterfaceInput::ConnectTo ( mtsInterfaceOutput * interfacePOutput )

pure virtual

CouldConnectTo()

virtual bool mtsInterfaceInput::CouldConnectTo ( mtsInterfaceOutput * interfaceOutput )

pure virtual

Disconnect()

virtual bool mtsInterfaceInput::Disconnect ( void )

pure virtual

GetConnectedInterface()

const mtsInterfaceOutput * mtsInterfaceInput::GetConnectedInterface

(

void

)

const

GetConnectionID()

ConnectionIDType mtsInterfaceInput::GetConnectionID ( void ) const

inline

Friends And Related Symbol Documentation

mtsManagerComponent

friend class mtsManagerComponent

friend

Member Data Documentation

ConnectionID

ConnectionIDType mtsInterfaceInput::ConnectionID

protected

Connection ID assigned by manager component. This is not really needed, but is maintained for historical reasons.

InterfaceOutput

mtsInterfaceOutput* mtsInterfaceInput::InterfaceOutput

protected

Pointer to output interface that we are connected to. We could instead use the Connection member in svlFilterInput.

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsInterfaceInput.h