LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
rcsc::rcg::SerializerV3 Class Reference

rcg data serializer interface class More...

#include <serializer_v3.h>

Inheritance diagram for rcsc::rcg::SerializerV3:
Inheritance graph
[legend]
Collaboration diagram for rcsc::rcg::SerializerV3:
Collaboration graph
[legend]

Public Member Functions

 ~SerializerV3 ()
 destruct all
 
virtual std::ostream & serializeHeader (std::ostream &os) override
 write header More...
 
virtual std::ostream & serializeParam (std::ostream &os, const std::string &msg) override
 write parameter message More...
 
virtual std::ostream & serialize (std::ostream &os, const server_params_t &param) override
 write server param More...
 
virtual std::ostream & serialize (std::ostream &os, const player_params_t &pparam) override
 write player param More...
 
virtual std::ostream & serialize (std::ostream &os, const player_type_t &type) override
 write player type param More...
 
virtual std::ostream & serialize (std::ostream &os, const dispinfo_t &disp) override
 write dispinfo_t. More...
 
virtual std::ostream & serialize (std::ostream &os, const showinfo_t &show) override
 write showinfo_t. More...
 
virtual std::ostream & serialize (std::ostream &os, const showinfo_t2 &show2) override
 write showinfo_t2 More...
 
virtual std::ostream & serialize (std::ostream &os, const short_showinfo_t2 &show2) override
 write short_showinfo_t2. More...
 
virtual std::ostream & serialize (std::ostream &os, const msginfo_t &msg) override
 write message info More...
 
virtual std::ostream & serialize (std::ostream &os, const Int16 board, const std::string &msg) override
 write message info More...
 
virtual std::ostream & serialize (std::ostream &os, const drawinfo_t &draw) override
 write drawinfo_t More...
 
virtual std::ostream & serialize (std::ostream &os, const char playmode) override
 write playmode More...
 
virtual std::ostream & serialize (std::ostream &os, const team_t &team_l, const team_t &team_r) override
 write team info More...
 
virtual std::ostream & serialize (std::ostream &os, const TeamT &team_l, const TeamT &team_r) override
 write team info More...
 
virtual std::ostream & serialize (std::ostream &os, const ShowInfoT &show) override
 write ShowInfoT More...
 
virtual std::ostream & serialize (std::ostream &os, const DispInfoT &disp) override
 write DispInfoT More...
 
- Public Member Functions inherited from rcsc::rcg::Serializer
virtual ~Serializer ()
 virtual destructor
 
virtual std::ostream & serializeHeader (std::ostream &os)=0
 write header More...
 
virtual std::ostream & serializeParam (std::ostream &os, const std::string &msg)=0
 write parameter message More...
 
virtual std::ostream & serialize (std::ostream &os, const server_params_t &param)=0
 write header More...
 
virtual std::ostream & serialize (std::ostream &os, const player_params_t &pparam)=0
 write header More...
 
virtual std::ostream & serialize (std::ostream &os, const player_type_t &type)=0
 write header More...
 
virtual std::ostream & serialize (std::ostream &os, const dispinfo_t &disp)=0
 write dispinfo_t. More...
 
virtual std::ostream & serialize (std::ostream &os, const showinfo_t &show)=0
 write showinfo_t. More...
 
virtual std::ostream & serialize (std::ostream &os, const showinfo_t2 &show2)=0
 write showinfo_t2. More...
 
virtual std::ostream & serialize (std::ostream &os, const short_showinfo_t2 &show2)=0
 write short_showinfo_t2. More...
 
virtual std::ostream & serialize (std::ostream &os, const msginfo_t &msg)=0
 write message info More...
 
virtual std::ostream & serialize (std::ostream &os, const Int16 board, const std::string &msg)=0
 write message info More...
 
virtual std::ostream & serialize (std::ostream &os, const drawinfo_t &draw)=0
 write drawinfo_t More...
 
virtual std::ostream & serialize (std::ostream &os, const char playmode)=0
 write playmode More...
 
virtual std::ostream & serialize (std::ostream &os, const team_t &team_l, const team_t &team_r)=0
 write team info More...
 
virtual std::ostream & serialize (std::ostream &os, const TeamT &team_l, const TeamT &team_r)=0
 write team info More...
 
virtual std::ostream & serialize (std::ostream &os, const ShowInfoT &show)=0
 write ShowInfoT More...
 
virtual std::ostream & serialize (std::ostream &os, const DispInfoT &disp)=0
 write DispInfoT More...
 

Additional Inherited Members

- Public Types inherited from rcsc::rcg::Serializer
typedef std::shared_ptr< SerializerPtr
 rcg serializer pointer type
 
typedef Ptr(* Creator) ()
 rcg serializer creator function
 
typedef rcss::Factory< Creator, int > Creators
 creator function holder
 
- Static Public Member Functions inherited from rcsc::rcg::Serializer
static Creatorscreators ()
 factory holder singleton More...
 
static Ptr create (const int version)
 create a suitable version serializer instance depending on the input version. More...
 
- Protected Member Functions inherited from rcsc::rcg::Serializer
 Serializer ()
 initialize member variables. constructor is accessible only from the derived classes.
 
std::ostream & serializeImpl (std::ostream &os, const int version)
 write header More...
 
std::ostream & serializeImpl (std::ostream &os, const server_params_t &param)
 write server param More...
 
std::ostream & serializeImpl (std::ostream &os, const player_params_t &pparam)
 write player param More...
 
std::ostream & serializeImpl (std::ostream &os, const player_type_t &type)
 write player type param More...
 
std::ostream & serializeImpl (std::ostream &os, const team_t &team_l, const team_t &team_r)
 write team info More...
 
std::ostream & serializeImpl (std::ostream &os, const char pmode)
 write playmode More...
 
std::ostream & serializeImpl (std::ostream &os, const PlayMode pmode)
 write playmode More...
 
std::ostream & serializeImpl (std::ostream &os, const dispinfo_t &disp)
 write dispinfo (version 1 protocol) More...
 
std::ostream & serializeImpl (std::ostream &os, const showinfo_t &show)
 write showinfo (version 2 protocol) More...
 
std::ostream & serializeImpl (std::ostream &os, const showinfo_t2 &show2)
 write showinfo_t2 (version 3 protocol). data is converted to short_showinfo_t2. More...
 
std::ostream & serializeImpl (std::ostream &os, const short_showinfo_t2 &show2)
 write short_showinfo (version 3 protocol) More...
 
std::ostream & serializeImpl (std::ostream &os, const msginfo_t &msg)
 write message info More...
 
std::ostream & serializeImpl (std::ostream &os, const drawinfo_t &draw)
 write draw info More...
 
std::ostream & serializeImpl (std::ostream &os, const dispinfo_t2 &disp2)
 write dispinfo_t2, but data is converted. More...
 
- Protected Attributes inherited from rcsc::rcg::Serializer
char M_playmode
 temporal playmode holder
 
TeamT M_teams [2]
 temporal team info holder
 

Detailed Description

rcg data serializer interface class

Member Function Documentation

◆ serialize() [1/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const char  playmode 
)
overridevirtual

write playmode

Parameters
osreference to the output stream
playmodeplay mode variable
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [2/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const dispinfo_t disp 
)
overridevirtual

write dispinfo_t.

Parameters
osreference to the output stream
dispnetwork byte order data
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [3/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const DispInfoT disp 
)
overridevirtual

write DispInfoT

Parameters
osreference to the output stream
dispdata to be written
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [4/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const drawinfo_t draw 
)
overridevirtual

write drawinfo_t

Parameters
osreference to the output stream
drawdrawinfo_t variable
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [5/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const Int16  board,
const std::string &  msg 
)
overridevirtual

write message info

Parameters
osreference to the output stream
boardmessage board type
msgmessage string
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [6/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const msginfo_t msg 
)
overridevirtual

write message info

Parameters
osreference to the output stream
msgnetwork byte order data
Returns
serialization result

Implements rcsc::rcg::Serializer.

◆ serialize() [7/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const player_params_t pparam 
)
overridevirtual

write player param

Parameters
osreference to the output stream
pparamnetwork byte order data
Returns
serialization result

Implements rcsc::rcg::Serializer.

◆ serialize() [8/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const player_type_t type 
)
overridevirtual

write player type param

Parameters
osreference to the output stream
typenetwork byte order data
Returns
serialization result

Implements rcsc::rcg::Serializer.

◆ serialize() [9/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const server_params_t param 
)
overridevirtual

write server param

Parameters
osreference to the output stream
paramnetwork byte order data
Returns
serialization result

Implements rcsc::rcg::Serializer.

◆ serialize() [10/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const short_showinfo_t2 show2 
)
overridevirtual

write short_showinfo_t2.

Parameters
osreference to the output stream
show2network byte order data
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [11/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const showinfo_t show 
)
overridevirtual

write showinfo_t.

Parameters
osreference to the output stream
shownetwork byte order data
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [12/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const showinfo_t2 show2 
)
overridevirtual

write showinfo_t2

Parameters
osreference to the output stream
show2data to be output
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [13/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const ShowInfoT show 
)
overridevirtual

write ShowInfoT

Parameters
osreference to the output stream
shownetwork byte order data
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [14/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const team_t team_l,
const team_t team_r 
)
overridevirtual

write team info

Parameters
osreference to the output stream
team_lleft team variable
team_rright team variable
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serialize() [15/15]

virtual std::ostream & rcsc::rcg::SerializerV3::serialize ( std::ostream &  os,
const TeamT team_l,
const TeamT team_r 
)
overridevirtual

write team info

Parameters
osreference to the output stream
team_lleft team variable
team_rright team variable
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.

◆ serializeHeader()

virtual std::ostream & rcsc::rcg::SerializerV3::serializeHeader ( std::ostream &  os)
overridevirtual

write header

Parameters
osreference to the output stream
Returns
serialization result

Implements rcsc::rcg::Serializer.

◆ serializeParam()

virtual std::ostream & rcsc::rcg::SerializerV3::serializeParam ( std::ostream &  os,
const std::string &  msg 
)
overridevirtual

write parameter message

Parameters
osreference to the output stream
msgserver parameter message
Returns
reference to the output stream

Implements rcsc::rcg::Serializer.


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