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

#include <messages.h>

Public Member Functions
	PSF_DECLARE_MSG_FACTORY ()
	psMusicalSheetMessage (MsgEntry *me)
	Constructor from a MsgEntry.
	psMusicalSheetMessage (uint32_t client, uint32_t itemID, bool readOnly, bool play, const char songTitle, const char musicalSheet)
	Constructor.
virtual csString	ToString (NetBase::AccessPointers *)
	Converts the message into human readable string.
Public Attributes
uint32_t	itemID
csString	musicalSheet
bool	play
bool	readOnly
csString	songTitle

Detailed Description

Message used by to send a musical sheet.

Definition at line 5469 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 ) [inline, virtual]

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.