prmEventButton Class Reference

#include <prmEventButton.h>

Inheritance diagram for prmEventButton:

Public Types
enum	EventType { PRESSED, RELEASED, CLICKED, DOUBLE_CLICKED }
typedef mtsGenericObject	BaseType

Public Member Functions
	prmEventButton ()
	prmEventButton (const EventType &type)
	prmEventButton (const prmEventButton &other)
virtual	~prmEventButton ()
virtual void	ToStream (std::ostream &outputStream) const
void	ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
void	SerializeRaw (std::ostream &outputStream) const
void	DeSerializeRaw (std::istream &inputStream)
	CMN_DECLARE_MEMBER_AND_ACCESSORS (EventType, Type)
Public Member Functions inherited from mtsGenericObject
	mtsGenericObject (void)
	mtsGenericObject (double timestamp, bool automaticTimestamp, bool valid)
	mtsGenericObject (const mtsGenericObject &other)
virtual	~mtsGenericObject (void)
bool	SetTimestampIfAutomatic (double timestamp)
virtual bool	FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
size_t	ScalarNumber (void) const
bool	ScalarNumberIsFixed (void) const
double	Scalar (const size_t index) const throw (std::out_of_range)
std::string	ScalarDescription (const size_t index, const std::string &userDescription="") const throw (std::out_of_range)
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 cmnLogger::StreamBufType *	GetLogMultiplexer (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

Detailed Description

Button event payload

Member Typedef Documentation

typedef mtsGenericObject prmEventButton::BaseType

Member Enumeration Documentation

enum prmEventButton::EventType

Enumerator
PRESSED
RELEASED
CLICKED
DOUBLE_CLICKED

Constructor & Destructor Documentation

prmEventButton::prmEventButton ( )

inline

Default constructor

prmEventButton::prmEventButton ( const EventType &  type )

inline

Constructor with all parameters

prmEventButton::prmEventButton ( const prmEventButton &  other )

inline

Copy constructor

virtual prmEventButton::~prmEventButton ( )

virtual

Destructor

Member Function Documentation

prmEventButton::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	EventType	,
		Type
	)

Set and Get methods for event type.

void prmEventButton::DeSerializeRaw ( std::istream &  inputStream )

virtual

Binary deserialization

Reimplemented from mtsGenericObject.

void prmEventButton::SerializeRaw ( std::ostream &  outputStream ) const

virtual

Binary serialization

Reimplemented from mtsGenericObject.

virtual void prmEventButton::ToStream ( std::ostream &  outputStream ) const

virtual

Overloaded ToStream

Reimplemented from mtsGenericObject.

void prmEventButton::ToStreamRaw ( std::ostream &  outputStream, const char  delimiter = ' ', bool  headerOnly = false, const std::string &  headerPrefix = ""  ) const

virtual

To stream raw data.

Reimplemented from mtsGenericObject.

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstParameterTypes/prmEventButton.h