ERC CISST - cisst software

---

mtsInterfaceRequiredOrInput Class Reference
[Multi Task Support]

#include <mtsInterfaceRequiredOrInput.h>

Inheritance diagram for mtsInterfaceRequiredOrInput:

[legend]Collaboration diagram for mtsInterfaceRequiredOrInput:

[legend]List of all members.

---

Detailed Description

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

Definition at line 46 of file mtsInterfaceRequiredOrInput.h.

Public Member Functions

• mtsInterfaceRequiredOrInput (const std::string &interfaceName, mtsRequiredType required=MTS_REQUIRED)
• virtual ~mtsInterfaceRequiredOrInput ()
• const std::string & GetName (void) const
• const mtsInterfaceProvidedOrOutput * GetConnectedInterface (void) const
• virtual bool CouldConnectTo (mtsInterfaceProvidedOrOutput *interfaceProvidedOrOutput)=0
• virtual bool ConnectTo (mtsInterfaceProvidedOrOutput *interfaceProvidedOrOutput)=0
• virtual bool Disconnect (void)=0
• mtsRequiredType IsRequired (void) const

Protected Member Functions

• mtsInterfaceRequiredOrInput (void)

Protected Attributes

• std::string Name
• mtsInterfaceProvidedOrOutput * InterfaceProvidedOrOutput
• mtsRequiredType Required

Friends

• class mtsComponentProxy
• class mtsComponentInterfaceProxyClient
• class mtsManagerLocal
• class mtsManagerLocalTest

---

Constructor & Destructor Documentation

mtsInterfaceRequiredOrInput::mtsInterfaceRequiredOrInput

(

void

)

[inline, protected]

Default constructor. Does nothing, should not be used.

Definition at line 65 of file mtsInterfaceRequiredOrInput.h.

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

Constructor. Sets the name.

Parameters:

interfaceName

Name of required interface

virtual mtsInterfaceRequiredOrInput::~mtsInterfaceRequiredOrInput

(

)

[virtual]

Default destructor.

---

Member Function Documentation

const std::string& mtsInterfaceRequiredOrInput::GetName

(

void

)

const

Returns the name of the interface.

Referenced by svlFilterInput::ConnectTo().

mtsRequiredType mtsInterfaceRequiredOrInput::IsRequired

(

void

)

const

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

---

Member Data Documentation

std::string mtsInterfaceRequiredOrInput::Name [protected]

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

Definition at line 56 of file mtsInterfaceRequiredOrInput.h.

mtsInterfaceProvidedOrOutput* mtsInterfaceRequiredOrInput::InterfaceProvidedOrOutput [protected]

Pointer to provided interface that we are connected to.

Definition at line 59 of file mtsInterfaceRequiredOrInput.h.

mtsRequiredType mtsInterfaceRequiredOrInput::Required [protected]

Indicates if the interface must be connected.

Definition at line 62 of file mtsInterfaceRequiredOrInput.h.

---

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

• mtsInterfaceRequiredOrInput.h

---