psMusicalSheetMessage Class Reference

Message used by to send a musical sheet. More...

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psMusicalSheetMessage (uint32_t client, uint32_t itemID, bool readOnly, bool play, const char *songTitle, const char *musicalSheet)
	Constructor. More...
	psMusicalSheetMessage (MsgEntry *me)
	Constructor from a MsgEntry. More...
virtual csString	ToString (NetBase::AccessPointers *)
	Converts the message into human readable string. More...
Public Member Functions inherited from psMessageCracker
void	FireEvent ()
	Publishes the message to the local program. More...
virtual csString	GetMessageTypeName () const =0
	Gets the name of the message type. More...
void	Multicast (csArray< PublishDestination > &multi, uint32_t except, float range)
	Multicasts the message to all current connections. More...
	psMessageCracker ()
void	SendMessage ()
	Sends the message to the client/server. More...
virtual	~psMessageCracker ()

Public Attributes
uint32_t	itemID
csString	musicalSheet
bool	play
bool	readOnly
csString	songTitle
Public Attributes inherited from psMessageCracker
int	filterNumber
csRef< MsgEntry >	msg
bool	valid

Additional Inherited Members
Static Public Attributes inherited from psMessageCracker
static MsgHandler *	msghandler

Detailed Description

Message used by to send a musical sheet.

Definition at line 5476 of file messages.h.

Constructor & Destructor Documentation

psMusicalSheetMessage::psMusicalSheetMessage	(	uint32_t	client,
		uint32_t	itemID,
		bool	readOnly,
		bool	play,
		const char *	songTitle,
		const char *	musicalSheet
	)

Constructor.

Parameters

client	the client's ID.
itemID	the ID of the item containing the musical sheet.
readOnly	true if the client cannot edit the score.
play	true if the client asks to play the score.
songTitle	the song's title.
musicalSheet	the score.

psMusicalSheetMessage::psMusicalSheetMessage

(

MsgEntry *

me

)

Constructor from a MsgEntry.

Parameters

me	the message entry.

Member Function Documentation

psMusicalSheetMessage::PSF_DECLARE_MSG_FACTORY

(

)

virtual csString psMusicalSheetMessage::ToString ( NetBase::AccessPointers *  accessPointers )

inlinevirtual

Converts the message into human readable string.

Used when a message is Logged. Every message should implement a version of this function that print all data that was decoded when the message was initiated from a NetEntry. See psDRMessage::ToString for an example.

Parameters

accessPointers

A struct to a number of access pointers.

Returns

Return a human readable string for the message.

Implements psMessageCracker.

Definition at line 5500 of file messages.h.

Member Data Documentation

uint32_t psMusicalSheetMessage::itemID

Definition at line 5505 of file messages.h.

csString psMusicalSheetMessage::musicalSheet

Definition at line 5509 of file messages.h.

bool psMusicalSheetMessage::play

Definition at line 5507 of file messages.h.

bool psMusicalSheetMessage::readOnly

Definition at line 5506 of file messages.h.

csString psMusicalSheetMessage::songTitle

Definition at line 5508 of file messages.h.

---

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

• common/net/messages.h