wavelength 1.0.0
Loading...
Searching...
No Matches
MCGetRemixInfoTask Class Reference

Work that reads the RemixInfo at the start of a remix file into mBuffer: open, read, and close. More...

#include <mcgetremixinfotask.h>

Inheritance diagram for MCGetRemixInfoTask:
Collaboration diagram for MCGetRemixInfoTask:

Public Member Functions

 MCGetRemixInfoTask ()
 Construct the steps and the buffer.
 ~MCGetRemixInfoTask () override
 Release the buffer and the steps.
void Set (int nPort, const char *pszName)
 Prepare the work.
char * GetBuffer () const
int GetSize () const
Public Member Functions inherited from MemcardSerialTask
 ~MemcardSerialTask () override=default
 Destroy the object.
int GetResult ()
 Report the outcome of the work.
virtual void OnDirListed ()
 Learn that a directory listing step ended.
virtual void OnCardInfo ()
 Learn that a card information step ended.
virtual void OnFileLoaded ()
 Learn that a file load step ended.
Public Member Functions inherited from SerialTasks
 ~SerialTasks () override
 Release the list and every task in it.
void Add (Task *pTask)
 Append a task, which the list then manages.
Public Member Functions inherited from Task
 Task ()
 Construct an idle task.
virtual ~Task ()
 Release the task.
int Poll ()
 Report the state after giving a running task one poll.
void Start ()
 Enter the running state and call OnStart(), unless the task is already running.
void Stop ()
 Call OnStop() when the task is running, and return to the idle state.
void Finish (bool bSucceeded)
 End the task from outside its poll, and call OnStop() when it was running.
int GetState () const
 Report mState.

Additional Inherited Members

Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Protected Member Functions inherited from MemcardSerialTask
void OnStop () override
 Record MemcardTask::sStatus in mResult.
Protected Member Functions inherited from SerialTasks
void OnStart () override
 Start the first task, or finish with success when the list is empty.
void OnStop () override
 Stop the task that runs now.
void OnPoll () override
 Poll the task that runs now, start the next one after it is done, and finish after the last one or after a failure.
const std::vector< std::unique_ptr< Task > > & GetTasks () const

Detailed Description

Work that reads the RemixInfo at the start of a remix file into mBuffer: open, read, and close.

The RTTI records the class as deriving from MemcardSerialTask. The object is 0x34 bytes.

Constructor & Destructor Documentation

◆ MCGetRemixInfoTask()

MCGetRemixInfoTask::MCGetRemixInfoTask ( )

Construct the steps and the buffer.

Ghidra address:
NTSC-U/C: 0x00161348
Ghidra address:
PAL: 0x00163e88

◆ ~MCGetRemixInfoTask()

MCGetRemixInfoTask::~MCGetRemixInfoTask ( )
override

Release the buffer and the steps.

Ghidra address:
NTSC-U/C: 0x00161468
Ghidra address:
PAL: 0x00163fa8

Member Function Documentation

◆ Set()

void MCGetRemixInfoTask::Set ( int nPort,
const char * pszName )

Prepare the work.

Parameters
nPortThe memory card slot.
pszNameThe remix file.
Ghidra address:
NTSC-U/C: 0x001614c8
Ghidra address:
PAL: 0x00164008

◆ GetBuffer()

char * MCGetRemixInfoTask::GetBuffer ( ) const
inline
Returns
The buffer that receives the description as stored.

◆ GetSize()

int MCGetRemixInfoTask::GetSize ( ) const
inline
Returns
The size of the buffer.

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