cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
mtsInterfaceProvidedOrOutput Class Reference

#include <mtsInterfaceProvidedOrOutput.h>

Inheritance diagram for mtsInterfaceProvidedOrOutput:
cmnGenericObject

Public Member Functions

 mtsInterfaceProvidedOrOutput (const std::string &interfaceName, mtsComponent *component)
 
virtual ~mtsInterfaceProvidedOrOutput ()
 
const std::string & GetName (void) const
 
const std::string GetFullName (void) const
 
const mtsComponentGetComponent (void) const
 
virtual void Cleanup (void)
 
- 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::StreamBufTypeGetLogMultiplexer (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

 mtsInterfaceProvidedOrOutput (void)
 

Protected Attributes

const std::string Name
 
mtsComponentComponent
 

Constructor & Destructor Documentation

mtsInterfaceProvidedOrOutput::mtsInterfaceProvidedOrOutput ( void  )
inlineprotected

Default constructor. Does nothing, should not be used.

mtsInterfaceProvidedOrOutput::mtsInterfaceProvidedOrOutput ( const std::string &  interfaceName,
mtsComponent component 
)

Constructor. Sets the name.

virtual mtsInterfaceProvidedOrOutput::~mtsInterfaceProvidedOrOutput ( )
inlinevirtual

Default destructor. Does nothing.

Member Function Documentation

virtual void mtsInterfaceProvidedOrOutput::Cleanup ( void  )
virtual

Cleanup method

const mtsComponent* mtsInterfaceProvidedOrOutput::GetComponent ( void  ) const

Get a const pointer on the component

const std::string mtsInterfaceProvidedOrOutput::GetFullName ( void  ) const

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

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

Returns the name of the interface.

Member Data Documentation

mtsComponent* mtsInterfaceProvidedOrOutput::Component
protected

Pointer on the component itself.

const std::string mtsInterfaceProvidedOrOutput::Name
protected

A string identifying the 'Name' of the interface.


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