Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | List of all members
PacketClass Class Reference

#include <packet.h>

Public Member Functions

 PacketClass (short id=0)
 
 PacketClass (char *cur_buf)
 
 ~PacketClass ()
 
void Add_Field (FieldClass *field)
 
void Add_Field (char *field, char data)
 
void Add_Field (char *field, unsigned char data)
 
void Add_Field (char *field, short data)
 
void Add_Field (char *field, unsigned short data)
 
void Add_Field (char *field, long data)
 
void Add_Field (char *field, unsigned long data)
 
void Add_Field (char *field, char *data)
 
void Add_Field (char *field, void *data, int length)
 
FieldClass * Find_Field (char *id)
 
bit8 Get_Field (char *id, int &data)
 
bit8 Get_Field (char *id, char &data)
 
bit8 Get_Field (char *id, unsigned char &data)
 
bit8 Get_Field (char *id, short &data)
 
bit8 Get_Field (char *id, unsigned short &data)
 
bit8 Get_Field (char *id, long &data)
 
bit8 Get_Field (char *id, unsigned long &data)
 
bit8 Get_Field (char *id, unsigned &data)
 
bit8 Get_Field (char *id, char *data)
 
bit8 Get_Field (char *id, void *data, int &length)
 
unsigned short Get_Field_Size (char *id)
 
FieldClass * Get_Field_At (int position)
 
int Get_Num_Fields ()
 
char * Create_Comms_Packet (int &size)
 
 PacketClass (short id=0)
 
 PacketClass (char *cur_buf)
 
 ~PacketClass ()
 
void Add_Field (FieldClass *field)
 
void Add_Field (char *field, char data)
 
void Add_Field (char *field, unsigned char data)
 
void Add_Field (char *field, short data)
 
void Add_Field (char *field, unsigned short data)
 
void Add_Field (char *field, long data)
 
void Add_Field (char *field, unsigned long data)
 
void Add_Field (char *field, char *data)
 
void Add_Field (char *field, void *data, int length)
 
FieldClass * Find_Field (char *id)
 
bit8 Get_Field (char *id, int &data)
 
bit8 Get_Field (char *id, char &data)
 
bit8 Get_Field (char *id, unsigned char &data)
 
bit8 Get_Field (char *id, short &data)
 
bit8 Get_Field (char *id, unsigned short &data)
 
bit8 Get_Field (char *id, long &data)
 
bit8 Get_Field (char *id, unsigned long &data)
 
bit8 Get_Field (char *id, unsigned &data)
 
bit8 Get_Field (char *id, char *data)
 
bit8 Get_Field (char *id, void *data, int &length)
 
unsigned short Get_Field_Size (char *id)
 
FieldClass * Get_Field_At (int position)
 
int Get_Num_Fields ()
 
char * Create_Comms_Packet (int &size)
 

Detailed Description

Definition at line 46 of file packet.h.

Constructor & Destructor Documentation

◆ PacketClass() [1/4]

PacketClass::PacketClass ( short id = 0)
inline

Definition at line 50 of file packet.h.

◆ PacketClass() [2/4]

PacketClass::PacketClass ( char * cur_buf)

Definition at line 105 of file packet.cpp.

◆ ~PacketClass() [1/2]

PacketClass::~PacketClass ( )

Definition at line 62 of file packet.cpp.

◆ PacketClass() [3/4]

PacketClass::PacketClass ( short id = 0)
inline

Definition at line 50 of file packet.h.

◆ PacketClass() [4/4]

PacketClass::PacketClass ( char * cur_buf)

◆ ~PacketClass() [2/2]

PacketClass::~PacketClass ( )

Member Function Documentation

◆ Add_Field() [1/18]

void PacketClass::Add_Field ( char * field,
char * data )
inline

Definition at line 75 of file packet.h.

◆ Add_Field() [2/18]

void PacketClass::Add_Field ( char * field,
char * data )
inline

Definition at line 75 of file packet.h.

◆ Add_Field() [3/18]

void PacketClass::Add_Field ( char * field,
char data )
inline

Definition at line 69 of file packet.h.

◆ Add_Field() [4/18]

void PacketClass::Add_Field ( char * field,
char data )
inline

Definition at line 69 of file packet.h.

◆ Add_Field() [5/18]

void PacketClass::Add_Field ( char * field,
long data )
inline

Definition at line 73 of file packet.h.

◆ Add_Field() [6/18]

void PacketClass::Add_Field ( char * field,
long data )
inline

Definition at line 73 of file packet.h.

◆ Add_Field() [7/18]

void PacketClass::Add_Field ( char * field,
short data )
inline

Definition at line 71 of file packet.h.

◆ Add_Field() [8/18]

void PacketClass::Add_Field ( char * field,
short data )
inline

Definition at line 71 of file packet.h.

◆ Add_Field() [9/18]

void PacketClass::Add_Field ( char * field,
unsigned char data )
inline

Definition at line 70 of file packet.h.

◆ Add_Field() [10/18]

void PacketClass::Add_Field ( char * field,
unsigned char data )
inline

Definition at line 70 of file packet.h.

◆ Add_Field() [11/18]

void PacketClass::Add_Field ( char * field,
unsigned long data )
inline

Definition at line 74 of file packet.h.

◆ Add_Field() [12/18]

void PacketClass::Add_Field ( char * field,
unsigned long data )
inline

Definition at line 74 of file packet.h.

◆ Add_Field() [13/18]

void PacketClass::Add_Field ( char * field,
unsigned short data )
inline

Definition at line 72 of file packet.h.

◆ Add_Field() [14/18]

void PacketClass::Add_Field ( char * field,
unsigned short data )
inline

Definition at line 72 of file packet.h.

◆ Add_Field() [15/18]

void PacketClass::Add_Field ( char * field,
void * data,
int length )
inline

Definition at line 76 of file packet.h.

◆ Add_Field() [16/18]

void PacketClass::Add_Field ( char * field,
void * data,
int length )
inline

Definition at line 76 of file packet.h.

◆ Add_Field() [17/18]

void PacketClass::Add_Field ( FieldClass * field)

Definition at line 87 of file packet.cpp.

◆ Add_Field() [18/18]

void PacketClass::Add_Field ( FieldClass * field)

◆ Create_Comms_Packet() [1/2]

char * PacketClass::Create_Comms_Packet ( int & size)

Definition at line 183 of file packet.cpp.

◆ Create_Comms_Packet() [2/2]

char * PacketClass::Create_Comms_Packet ( int & size)

◆ Find_Field() [1/2]

FieldClass * PacketClass::Find_Field ( char * id)

Definition at line 264 of file packet.cpp.

◆ Find_Field() [2/2]

FieldClass * PacketClass::Find_Field ( char * id)

◆ Get_Field() [1/20]

bit8 PacketClass::Get_Field ( char * id,
char & data )

Definition at line 312 of file packet.cpp.

◆ Get_Field() [2/20]

bit8 PacketClass::Get_Field ( char * id,
char & data )

◆ Get_Field() [3/20]

bit8 PacketClass::Get_Field ( char * id,
char * data )

Definition at line 445 of file packet.cpp.

◆ Get_Field() [4/20]

bit8 PacketClass::Get_Field ( char * id,
char * data )

◆ Get_Field() [5/20]

bit8 PacketClass::Get_Field ( char * id,
int & data )

Definition at line 419 of file packet.cpp.

◆ Get_Field() [6/20]

bit8 PacketClass::Get_Field ( char * id,
int & data )

◆ Get_Field() [7/20]

bit8 PacketClass::Get_Field ( char * id,
long & data )

Definition at line 408 of file packet.cpp.

◆ Get_Field() [8/20]

bit8 PacketClass::Get_Field ( char * id,
long & data )

◆ Get_Field() [9/20]

bit8 PacketClass::Get_Field ( char * id,
short & data )

Definition at line 360 of file packet.cpp.

◆ Get_Field() [10/20]

bit8 PacketClass::Get_Field ( char * id,
short & data )

◆ Get_Field() [11/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned & data )

Definition at line 477 of file packet.cpp.

◆ Get_Field() [12/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned & data )

◆ Get_Field() [13/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned char & data )

Definition at line 336 of file packet.cpp.

◆ Get_Field() [14/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned char & data )

◆ Get_Field() [15/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned long & data )

Definition at line 468 of file packet.cpp.

◆ Get_Field() [16/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned long & data )

◆ Get_Field() [17/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned short & data )

Definition at line 384 of file packet.cpp.

◆ Get_Field() [18/20]

bit8 PacketClass::Get_Field ( char * id,
unsigned short & data )

◆ Get_Field() [19/20]

bit8 PacketClass::Get_Field ( char * id,
void * data,
int & length )

Definition at line 503 of file packet.cpp.

◆ Get_Field() [20/20]

bit8 PacketClass::Get_Field ( char * id,
void * data,
int & length )

◆ Get_Field_At() [1/2]

FieldClass * PacketClass::Get_Field_At ( int position)

Definition at line 275 of file packet.cpp.

◆ Get_Field_At() [2/2]

FieldClass * PacketClass::Get_Field_At ( int position)

◆ Get_Field_Size() [1/2]

unsigned short PacketClass::Get_Field_Size ( char * id)

Definition at line 514 of file packet.cpp.

◆ Get_Field_Size() [2/2]

unsigned short PacketClass::Get_Field_Size ( char * id)

◆ Get_Num_Fields() [1/2]

int PacketClass::Get_Num_Fields ( )

Definition at line 287 of file packet.cpp.

◆ Get_Num_Fields() [2/2]

int PacketClass::Get_Num_Fields ( )
The documentation for this class was generated from the following files: