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

Work that saves the Freq of a profile to the Freq directory, under the profile's name. More...

#include <mcsavefreqtask.h>

Inheritance diagram for MCSaveFreqTask:
Collaboration diagram for MCSaveFreqTask:

Public Member Functions

 ~MCSaveFreqTask () override=default
 Destroy the object.
 MCSaveFreqTask ()
 Construct the steps.
void Set (int nPort, Campaign *pProfile, const char *pszOldName, int nOverwrite)
 Prepare the work, and serialise the profile into g_pMemcardBuffer.
int GetNeeded ()
 Report the space a save that did not fit needed.
void OnSaveSpace (int nNeeded) override
 Prepare the directory and the file steps when the save fits, and otherwise fail the measurement.
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 saves the Freq of a profile to the Freq directory, under the profile's name.

The RTTI records the class as deriving from MemcardSerialTask and from SaveSpaceUser at +0x20. The object is 0x5c bytes. The steps read the card information, delete the file of the Freq's previous name, measure the space, create the directory, and save the file. A save that does not fit fails after the measurement, and GetNeeded() then reports the space it needed.

Constructor & Destructor Documentation

◆ ~MCSaveFreqTask()

MCSaveFreqTask::~MCSaveFreqTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00352a68
Ghidra address:
PAL: 0x003bfd70

◆ MCSaveFreqTask()

MCSaveFreqTask::MCSaveFreqTask ( )

Construct the steps.

Ghidra address:
NTSC-U/C: 0x001600b8
Ghidra address:
PAL: 0x00162918

Member Function Documentation

◆ Set()

void MCSaveFreqTask::Set ( int nPort,
Campaign * pProfile,
const char * pszOldName,
int nOverwrite )

Prepare the work, and serialise the profile into g_pMemcardBuffer.

The lowered name of the profile is the file name. When the previous name differs from it, ignoring case, the file of the previous name is deleted.

Parameters
nPortThe memory card slot.
pProfileThe profile.
pszOldNameThe name the Freq was saved under before.
nOverwriteNon-zero when a saved Freq of the name may be replaced.
Ghidra address:
NTSC-U/C: 0x00160220
Ghidra address:
PAL: 0x00162a80

◆ GetNeeded()

int MCSaveFreqTask::GetNeeded ( )

Report the space a save that did not fit needed.

Returns
The kilobytes, or zero.
Ghidra address:
NTSC-U/C: 0x00160428
Ghidra address:
PAL: 0x00162c88

◆ OnSaveSpace()

void MCSaveFreqTask::OnSaveSpace ( int nNeeded)
overridevirtual

Prepare the directory and the file steps when the save fits, and otherwise fail the measurement.

Parameters
nNeededThe kilobytes the save needs.
Ghidra address:
NTSC-U/C: 0x00160430
Ghidra address:
PAL: 0x00162c90

Implements SaveSpaceUser.


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