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

Packet that reports a remix effect switched on or off for a track of a section. More...

#include <fxpacket.h>

Inheritance diagram for FXPacket:
Collaboration diagram for FXPacket:

Public Member Functions

 ~FXPacket () override=default
 Destroy the object.
 FXPacket ()
 Construct a packet with no section and no track.
void * operator new (size_t nSize)
 Allocate a packet, billed to the class name.
void operator delete (void *pBlock)
 Release a packet.
Message * Clone () override
 Produce a heap copy of this packet.
int Type () override
 Report this packet's registered identity.
const char * GetName () const override
 Report this packet's class name.
void PrintExtra (PrnStream &stream) const override
 Write the section, the track, the effect, and the switch to a diagnostic stream.
void saveGuts (BinStream &stream) const override
 Write the payload packed into two bytes.
void restoreGuts (BinStream &stream) override
 Read the two bytes saveGuts() writes back into the fields.
int GetOn () const
void SetOn (int nOn)
int GetSection () const
void SetSection (int nSection)
int GetTrack () const
void SetTrack (int nTrack)
int GetType () const
void SetType (int nType)
Public Member Functions inherited from ExternalPacket
 ExternalPacket (unsigned char nFlags=0, int nReceiver=kAllPeers)
 Construct a packet from an unset sender.
int Route () override
 Report that a received packet goes to the sink of TheNetTransport.
Public Member Functions inherited from Packet
void PrintExtra (PrnStream &stream) const override
 Write the sender and the receiver that are set, as from: and to:.
unsigned char GetFlags () const
int GetReceiver () const
int GetSender () const
void SetSender (int nSender)
Public Member Functions inherited from Message
virtual ~Message ()
 Vtable slot 1.
virtual ~Message ()
virtual void Unused1 ()
 Not called by the control.

Static Public Member Functions

static Message * New ()
 Produce a default-constructed packet on the heap.
Static Public Member Functions inherited from Message
static Message * NewMessage (int nType)
 Produce a message of the identified class through the factory list.

Additional Inherited Members

Public Types inherited from Packet
enum  RouteFlag { kRouteTransport = 1 , kRouteLaunchpad = 2 }
 Bits of Route(). More...
Static Public Attributes inherited from Packet
static constexpr int kUnset = -2
 Value of mSender and mReceiver that marks the member as unset.
static constexpr int kAllPeers = -1
 Value of mReceiver that addresses every peer.
static constexpr unsigned char kFlagOrdered = 1
 Bit of mFlags that LaunchpadRT::Send() turns into the second delivery bit of the session library.
static constexpr unsigned char kFlagGuaranteed = 2
 Bit of mFlags that NetTransport::Send() turns into its guaranteed delivery bit.
Protected Member Functions inherited from Packet
 Packet (unsigned char nFlags, int nReceiver)
 Construct a packet from an unset sender.

Detailed Description

Packet that reports a remix effect switched on or off for a track of a section.

The RTTI records the class as deriving from ExternalPacket. Delivery is guaranteed. The members Clone(), Type(), and GetName() are inline.

Constructor & Destructor Documentation

◆ ~FXPacket()

FXPacket::~FXPacket ( )
overridedefault

Destroy the object.

Ghidra address:
NTSC-U/C: 0x0034bef0
Ghidra address:
PAL: 0x003b9320

◆ FXPacket()

FXPacket::FXPacket ( )
inline

Construct a packet with no section and no track.

Inline. New() expands it.

Member Function Documentation

◆ New()

Message * FXPacket::New ( )
static

Produce a default-constructed packet on the heap.

Returns
The packet.
Ghidra address:
NTSC-U/C: 0x00123310
Ghidra address:
PAL: 0x00124a90

◆ operator new()

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

Allocate a packet, billed to the class name.

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

◆ operator delete()

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

Release a packet.

Parameters
pBlockThe block.

◆ Clone()

Message * FXPacket::Clone ( )
inlineoverridevirtual

Produce a heap copy of this packet.

Returns
The copy.
Ghidra address:
NTSC-U/C: 0x0034bf90
Ghidra address:
PAL: 0x003b93c0

Implements Message.

◆ Type()

int FXPacket::Type ( )
inlineoverridevirtual

Report this packet's registered identity.

Returns
g_nFXPacketType.
Ghidra address:
NTSC-U/C: 0x0034c018
Ghidra address:
PAL: 0x003b9448

Implements Message.

◆ GetName()

const char * FXPacket::GetName ( ) const
inlineoverridevirtual

Report this packet's class name.

Returns
The literal FXPacket.
Ghidra address:
NTSC-U/C: 0x0034c028
Ghidra address:
PAL: 0x003b9458

Implements Message.

◆ PrintExtra()

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

Write the section, the track, the effect, and the switch to a diagnostic stream.

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

Reimplemented from Message.

◆ saveGuts()

void FXPacket::saveGuts ( BinStream & stream) const
overridevirtual

Write the payload packed into two bytes.

The section takes the low four bits, the track the next three, the effect the next two, and the switch the bit after them.

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

Reimplemented from Message.

◆ restoreGuts()

void FXPacket::restoreGuts ( BinStream & stream)
overridevirtual

Read the two bytes saveGuts() writes back into the fields.

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

Reimplemented from Message.

◆ GetOn()

int FXPacket::GetOn ( ) const
inline
Returns
Whether the effect is switched on.

◆ SetOn()

void FXPacket::SetOn ( int nOn)
inline
Parameters
nOnWhether the effect is switched on.

◆ GetSection()

int FXPacket::GetSection ( ) const
inline
Returns
The section.

◆ SetSection()

void FXPacket::SetSection ( int nSection)
inline
Parameters
nSectionThe section.

◆ GetTrack()

int FXPacket::GetTrack ( ) const
inline
Returns
The track.

◆ SetTrack()

void FXPacket::SetTrack ( int nTrack)
inline
Parameters
nTrackThe track.

◆ GetType()

int FXPacket::GetType ( ) const
inline
Returns
The effect.

◆ SetType()

void FXPacket::SetType ( int nType)
inline
Parameters
nTypeThe effect.

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