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

Progress or result of a transfer of a remix, NetLobby::UploadRemix() or NetLobby::DownloadRemix(). More...

#include <reporemixstatusmsg.h>

Inheritance diagram for RepoRemixStatusMsg:
Collaboration diagram for RepoRemixStatusMsg:

Public Types

enum  Status { kStatusFailed = -100 , kStatusAlreadyExists = -61 , kStatusDone = 0 , kStatusProgress = 5 }
 Values of mStatus. More...

Public Member Functions

 ~RepoRemixStatusMsg () override=default
 Destroy the object.
 RepoRemixStatusMsg (int nStatus, float fProgress)
 Construct a message.
void * operator new (size_t nSize)
 Allocate a message, billed to the class name.
void operator delete (void *pBlock)
 Release a message.
Message * Clone () override
 Produce a heap copy of this message.
int Type () override
 Report this message's registered identity.
const char * GetName () const override
 Report this message's class name.
void PrintExtra (PrnStream &stream) const override
 Write the status and the progress.
float GetProgress () const
int GetStatus () const
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual void saveGuts (BinStream &stream) const
 Write this message's payload to a stream.
virtual void restoreGuts (BinStream &stream)
 Read this message's payload from a stream.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Additional Inherited Members

Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Detailed Description

Progress or result of a transfer of a remix, NetLobby::UploadRemix() or NetLobby::DownloadRemix().

The RTTI includes the class name and records Message as the base. Only the members its readers here use are declared.

Member Enumeration Documentation

◆ Status

Values of mStatus.

Enumerator
kStatusFailed 

The transfer failed.

kStatusAlreadyExists 

The remix is already stored.

kStatusDone 

The transfer finished.

kStatusProgress 

mProgress reports the part transferred.

Constructor & Destructor Documentation

◆ ~RepoRemixStatusMsg()

RepoRemixStatusMsg::~RepoRemixStatusMsg ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0039f060
Ghidra address:
PAL: 0x0040dd40

◆ RepoRemixStatusMsg()

RepoRemixStatusMsg::RepoRemixStatusMsg ( int nStatus,
float fProgress )
inline

Construct a message.

Inline.

Parameters
nStatusOne of Status, or another negative error.
fProgressThe part transferred, from 0 to 1.

Member Function Documentation

◆ operator new()

void * RepoRemixStatusMsg::operator new ( size_t nSize)
inline

Allocate a message, billed to the class name.

Parameters
nSizeThe object size the compiler supplies.
Returns
The block.

◆ operator delete()

void RepoRemixStatusMsg::operator delete ( void * pBlock)
inline

Release a message.

Parameters
pBlockThe block.

◆ Clone()

Message * RepoRemixStatusMsg::Clone ( )
inlineoverridevirtual

Produce a heap copy of this message.

Returns
The copy.

Implements Message.

◆ Type()

int RepoRemixStatusMsg::Type ( )
inlineoverridevirtual

Report this message's registered identity.

Returns
g_nRepoRemixStatusMsgType.

Implements Message.

◆ GetName()

const char * RepoRemixStatusMsg::GetName ( ) const
inlineoverridevirtual

Report this message's class name.

Returns
The literal RepoRemixStatusMsg.

Implements Message.

◆ PrintExtra()

void RepoRemixStatusMsg::PrintExtra ( PrnStream & stream) const
overridevirtual

Write the status and the progress.

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

Reimplemented from Message.

◆ GetProgress()

float RepoRemixStatusMsg::GetProgress ( ) const
inline
Returns
The part transferred, from 0 to 1, with kStatusProgress.

◆ GetStatus()

int RepoRemixStatusMsg::GetStatus ( ) const
inline
Returns
One of Status, or another negative error.

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