wavelength 1.0.0
Loading...
Searching...
No Matches
StdMidiMuse::StdMidiCommand Class Reference

Command that sends the message of a muse when the scheduler runs it. More...

#include <stdmidimuse.h>

Inheritance diagram for StdMidiMuse::StdMidiCommand:
Collaboration diagram for StdMidiMuse::StdMidiCommand:

Public Member Functions

 ~StdMidiCommand () override=default
 Destroy the object.
 StdMidiCommand (StdMidiMuse *pMuse)
 Construct the command of a muse.
void Execute () override
 Send the message, timed within the pump of the scheduler, and forget the scheduler.
void Cancel ()
 Withdraw the command from the scheduler that queued it.
Scheduler * GetScheduler () const
void SetScheduler (Scheduler *pScheduler)
Public Member Functions inherited from Command
 ~Command () override
 Release the command.
virtual bool IsSerializable ()
 Report whether a recording saves the command.
virtual int GetSerialId ()
 Report the identifier a recording rebuilds the command by.
virtual void Save (BinStream &stream) const
 Write the command to a recording.
virtual void Load (BinStream &stream)
 Read the command Save() writes.
Public Member Functions inherited from Attachment
 Attachment ()
 Construct an object with no reference.
virtual ~Attachment ()
 Release the object.
void AddRef ()
 Take one reference.
void Release ()
 Give back one reference and delete the object once the last one is gone.

Static Public Member Functions

static void * operator new (size_t nSize)
 Allocate a command from the pool.
static void operator delete (void *pBlock)
 Return a command to the pool.
Static Public Member Functions inherited from Attachment
static void ReleaseIfSet (Attachment *pAttachment)
 Give back one reference to an object that may be null.

Detailed Description

Command that sends the message of a muse when the scheduler runs it.

The RTTI includes the nested name and records Command as the base. The allocations come from the pool of fixed-size blocks, billed to the tag "StdMidiMuse cmd".

Constructor & Destructor Documentation

◆ ~StdMidiCommand()

StdMidiMuse::StdMidiCommand::~StdMidiCommand ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0034f0d0
Ghidra address:
PAL: 0x003bc4f8

◆ StdMidiCommand()

StdMidiMuse::StdMidiCommand::StdMidiCommand ( StdMidiMuse * pMuse)
inlineexplicit

Construct the command of a muse.

Parameters
pMuseThe muse.

Member Function Documentation

◆ operator new()

void * StdMidiMuse::StdMidiCommand::operator new ( size_t nSize)
inlinestatic

Allocate a command from the pool.

Parameters
nSizeThe object size.
Returns
The block.

◆ operator delete()

void StdMidiMuse::StdMidiCommand::operator delete ( void * pBlock)
inlinestatic

Return a command to the pool.

Parameters
pBlockThe block.

◆ Execute()

void StdMidiMuse::StdMidiCommand::Execute ( )
overridevirtual

Send the message, timed within the pump of the scheduler, and forget the scheduler.

Ghidra address:
NTSC-U/C: 0x0034f128
Ghidra address:
PAL: 0x003bc550

Implements Command.

◆ Cancel()

void StdMidiMuse::StdMidiCommand::Cancel ( )

Withdraw the command from the scheduler that queued it.

Ghidra address:
NTSC-U/C: 0x0034f1a0
Ghidra address:
PAL: 0x003bc5c8

◆ GetScheduler()

Scheduler * StdMidiMuse::StdMidiCommand::GetScheduler ( ) const
inline
Returns
The scheduler that queued the command, or null.

◆ SetScheduler()

void StdMidiMuse::StdMidiCommand::SetScheduler ( Scheduler * pScheduler)
inline
Parameters
pSchedulerThe scheduler that queued the command, or null.

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