prmEventButton Class Reference

#include <prmEventButton.h>

Inheritance diagram for prmEventButton:

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

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

Detailed Description

Button event payload

Member Typedef Documentation

BaseType

typedef mtsGenericObject prmEventButton::BaseType

Member Enumeration Documentation

EventType

enum prmEventButton::EventType

Enumerator
PRESSED
RELEASED
CLICKED
DOUBLE_CLICKED
UNDEFINED

Constructor & Destructor Documentation

prmEventButton() [1/3]

prmEventButton::prmEventButton ( )

inline

Default constructor

prmEventButton() [2/3]

prmEventButton::prmEventButton ( const EventType & type )

inline

Constructor with all parameters.

prmEventButton() [3/3]

prmEventButton::prmEventButton ( const prmEventButton & other )

inline

Copy constructor

~prmEventButton()

virtual prmEventButton::~prmEventButton ( )

virtual

Destructor

Member Function Documentation

CMN_DECLARE_MEMBER_AND_ACCESSORS()

prmEventButton::CMN_DECLARE_MEMBER_AND_ACCESSORS	(	EventType	,
		Type	)

Set and Get methods for event type.

DeSerializeRaw()

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

overridevirtual

Binary deserialization

Reimplemented from mtsGenericObject.

operator=()

prmEventButton & prmEventButton::operator= ( const prmEventButton & other )

inline

Assignment operator

SerializeRaw()

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

overridevirtual

Binary serialization

Reimplemented from mtsGenericObject.

ToStream()

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

overridevirtual

Overloaded ToStream

Reimplemented from mtsGenericObject.

ToStreamRaw()

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

overridevirtual

To stream raw data.

Reimplemented from mtsGenericObject.

---

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

• tmp/cisst-saw/cisst/cisstParameterTypes/prmEventButton.h