wavelength 1.0.0
Loading...
Searching...
No Matches
Command Class Referenceabstract

Unit of work a Scheduler runs at a set time. More...

#include <command.h>

Inheritance diagram for Command:
Collaboration diagram for Command:

Public Member Functions

 ~Command () override
 Release the command.
virtual void Execute ()=0
 Do the work.
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.

Additional Inherited Members

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

Unit of work a Scheduler runs at a set time.

The RTTI includes the class name and records Attachment as the base. The class adds no member. A recorded song saves the commands that report themselves serializable, and its playback rebuilds them by their identifier.

Constructor & Destructor Documentation

◆ ~Command()

Command::~Command ( )
override

Release the command.

Ghidra address:
NTSC-U/C: 0x00334e70
Ghidra address:
PAL: 0x003a2420

Member Function Documentation

◆ Execute()

◆ IsSerializable()

virtual bool Command::IsSerializable ( )
inlinevirtual

Report whether a recording saves the command.

The name is inferred.

Returns
False.
Ghidra address:
NTSC-U/C: 0x00334730
Ghidra address:
PAL: 0x003a1ce0

Reimplemented in SerializableCommand< kId, T >.

◆ GetSerialId()

virtual int Command::GetSerialId ( )
inlinevirtual

Report the identifier a recording rebuilds the command by.

The name is inferred.

Returns
0.
Ghidra address:
NTSC-U/C: 0x00334738
Ghidra address:
PAL: 0x003a1ce8

Reimplemented in SerializableCommand< kId, T >.

◆ Save()

virtual void Command::Save ( BinStream & stream) const
inlinevirtual

Write the command to a recording.

The default writes nothing.

Parameters
streamThe stream to write to.
Ghidra address:
NTSC-U/C: 0x00334740
Ghidra address:
PAL: 0x003a1cf0

◆ Load()

virtual void Command::Load ( BinStream & stream)
inlinevirtual

Read the command Save() writes.

The default reads nothing.

Parameters
streamThe stream to read from.
Ghidra address:
NTSC-U/C: 0x00334748
Ghidra address:
PAL: 0x003a1cf8

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