mtsInterface Class Reference

#include <mtsInterface.h>

Inheritance diagram for mtsInterface:

Public Member Functions
	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
void	Initialize (void)

Protected Attributes
const std::string	Name
mtsComponent *	Component
std::set< std::string >	mTags

Detailed Description

Base class for all interfaces.

Constructor & Destructor Documentation

mtsInterface()

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

Constructor. Sets the name.

Parameters

interfaceName

Name of interface

~mtsInterface()

virtual mtsInterface::~mtsInterface ( )

virtual

Default destructor.

Member Function Documentation

AddTag()

void mtsInterface::AddTag

(

const std::string &

tag

)

Add a tag to the interface.

GetComponent()

const mtsComponent * mtsInterface::GetComponent

(

void

)

const

Get a const pointer on the component

GetComponentName()

const std::string & mtsInterface::GetComponentName

(

void

)

const

Returns name of owner component

GetFullName()

const std::string mtsInterface::GetFullName

(

void

)

const

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

GetName()

const std::string & mtsInterface::GetName

(

void

)

const

Returns the name of the interface.

GetTags()

const std::set< std::string > & mtsInterface::GetTags

(

void

)

const

Return all tags.

Initialize()

void mtsInterface::Initialize ( void )

protected

Initializer

Member Data Documentation

Component

mtsComponent* mtsInterface::Component

protected

Pointer on the device itself.

mTags

std::set<std::string> mtsInterface::mTags

protected

Interface tags.

Name

const std::string mtsInterface::Name

protected

A string identifying the 'Name' of this interface.

---

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

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