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

Task that lists the entries matching a name into MemcardTask::sDirEntries and MemcardTask::sDirCount. More...

#include <mcgetdirtask.h>

Inheritance diagram for MCGetDirTask:
Collaboration diagram for MCGetDirTask:

Public Member Functions

 ~MCGetDirTask () override=default
 Destroy the object.
void Set (MemcardSerialTask *pOwner, int nPort, const char *pszName, int nMaxEntries, int nMode)
 Prepare the task.
void OnGetDir (int nResult, MemcardDirEntry *pEntries) override
 Record the entries and the outcome, finish, and tell mOwner.
Public Member Functions inherited from MemcardTask
 ~MemcardTask () override=default
 Destroy the object.
 MemcardTask ()
 Construct an idle task for the first slot.
void SetPort (int nPort)
 Select the slot the command addresses.
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.
Public Member Functions inherited from MemcardCBHandler
virtual ~MemcardCBHandler ()
 Release the handler.
virtual void OnGetInfo (int nResult)
 Receive the result of MemcardGetInfo().
virtual void OnGetEntSpace (int nResult)
 Receive the free entries of a directory.
virtual void OnOpen (int nResult)
 Receive the result of MemcardOpen().
virtual void OnClose (int nResult)
 Receive the result of MemcardClose().
virtual void OnRead (int nResult)
 Receive the result of MemcardRead().
virtual void OnWrite (int nResult)
 Receive the result of MemcardWrite().
virtual void OnSeek (int nResult)
 Receive the result of MemcardSeek().
virtual void OnMkdir (int nResult)
 Receive the result of MemcardMkdir().
virtual void OnRename (int nResult)
 Receive the result of a rename.
virtual void OnDelete (int nResult)
 Receive the result of MemcardDelete().
virtual void OnFormat (int nResult)
 Receive the result of MemcardFormat().
virtual void OnUnformat (int nResult)
 Receive the result of MemcardUnformat().

Protected Member Functions

void OnStart () override
 Issue the command.
Protected Member Functions inherited from MemcardTask
void OnPoll () override
 Advance the memory card command in flight.
Protected Member Functions inherited from Task
virtual void OnStop ()
 Abandon the work.

Additional Inherited Members

Public Types inherited from MemcardTask
enum  Status {
  kStatusOk = 0 , kStatusNoCard = 1 , kStatusFull = 2 , kStatusUnformatted = 3 ,
  kStatusChangedCard = 4 , kStatusExists = 5 , kStatusLimit = 6 , kStatusFormatted = 7 ,
  kStatusNotFound = 8 , kStatusConfigsBad = 9 , kStatusConfigsError = 10
}
 Values of sStatus, the outcome every memory card task and user reports. More...
Public Types inherited from Task
enum  State { kStateIdle = 0 , kStateRunning = 1 , kStateDone = 2 , kStateFailed = 3 }
 Values of mState. More...
Static Public Member Functions inherited from MemcardTask
static void SetStatus (int nResult)
 Record a library result in sResult, and translate the result into sStatus.
Static Public Attributes inherited from MemcardTask
static int sFd
 The file descriptor the last open reported.
static int sResult
 The library result SetStatus() last translated.
static int sStatus
 The outcome of the last command, one of Status.
static MemcardDirEntry * sDirEntries
 The entries the last directory listing reported.
static int sDirCount
 The number of entries the last directory listing reported.
Protected Attributes inherited from MemcardTask
int mPort

Detailed Description

Task that lists the entries matching a name into MemcardTask::sDirEntries and MemcardTask::sDirCount.

The RTTI records the class as deriving from MemcardTask. The object is 0x30 bytes. A name that has no match counts as success with no entries.

Constructor & Destructor Documentation

◆ ~MCGetDirTask()

MCGetDirTask::~MCGetDirTask ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x00351d90
Ghidra address:
PAL: 0x003bf010

Member Function Documentation

◆ Set()

void MCGetDirTask::Set ( MemcardSerialTask * pOwner,
int nPort,
const char * pszName,
int nMaxEntries,
int nMode )

Prepare the task.

Parameters
pOwnerThe task that learns when this one ends through OnDirListed(), or null.
nPortThe memory card slot.
pszNameThe name. It may include wildcards.
nMaxEntriesThe number of entries requested.
nModeThe library's listing mode.
Ghidra address:
NTSC-U/C: 0x0015deb8
Ghidra address:
PAL: 0x0015f6f8

◆ OnGetDir()

void MCGetDirTask::OnGetDir ( int nResult,
MemcardDirEntry * pEntries )
overridevirtual

Record the entries and the outcome, finish, and tell mOwner.

Parameters
nResultThe number of entries, or a negative library error.
pEntriesThe entries.
Ghidra address:
NTSC-U/C: 0x0015df28
Ghidra address:
PAL: 0x0015f768

Reimplemented from MemcardCBHandler.

◆ OnStart()

void MCGetDirTask::OnStart ( )
overrideprotectedvirtual

Issue the command.

Ghidra address:
NTSC-U/C: 0x0015dfe8
Ghidra address:
PAL: 0x0015f828

Reimplemented from Task.


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