rcg data serializer interface class More...

#include <serializer.h>

Inheritance diagram for rcsc::rcg::Serializer:

[legend]

Collaboration diagram for rcsc::rcg::Serializer:

Public Types
typedef std::shared_ptr< Serializer >	Ptr
	rcg serializer pointer type

typedef Ptr(*	Creator) ()
	rcg serializer creator function

typedef rcss::Factory< Creator, int >	Creators
	creator function holder

Public Member Functions
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...

Static Public Member Functions
static Creators &	creators ()
	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
	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
char	M_playmode
	temporal playmode holder

TeamT	M_teams [2]
	temporal team info holder

Detailed Description

rcg data serializer interface class

Member Function Documentation

◆ create()

static Ptr rcsc::rcg::Serializer::create ( const int version )

static

create a suitable version serializer instance depending on the input version.

Parameters

version rcg format version.

Returns: smart pointer to the rcg serializer instance

◆ creators()

static Creators & rcsc::rcg::Serializer::creators ( )

static

factory holder singleton

Returns: reference to the factory holder instance

◆ serialize() [1/15]

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

pure virtual

write playmode

Parameters

os	reference to the output stream
playmode	play mode variable

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [2/15]

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

pure virtual

write dispinfo_t.

Parameters

os	reference to the output stream
disp	network byte order data

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [3/15]

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

pure virtual

write DispInfoT

Parameters

os	reference to the output stream
disp	data to be written

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [4/15]

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

pure virtual

write drawinfo_t

Parameters

os	reference to the output stream
draw	drawinfo_t variable

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [5/15]

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

pure virtual

write message info

Parameters

os	reference to the output stream
board	message board type
msg	message string

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [6/15]

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

pure virtual

write message info

Parameters

os	reference to the output stream
msg	msginfo_t variable by network byte order

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [7/15]

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

pure virtual

write header

Parameters

os	reference to the output stream
pparam	player_params_t variable by network byte order

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [8/15]

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

pure virtual

write header

Parameters

os	reference to the output stream
type	player_type_t variable by network byte order

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [9/15]

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

pure virtual

write header

Parameters

os	reference to the output stream
param	server_params_t variable by network byte order

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [10/15]

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

pure virtual

write short_showinfo_t2.

Parameters

os	reference to the output stream
show2	network byte order data

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [11/15]

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

pure virtual

write showinfo_t.

Parameters

os	reference to the output stream
show	network byte order data

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [12/15]

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

pure virtual

write showinfo_t2.

Parameters

os	reference to the output stream
show2	network byte order data

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [13/15]

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

pure virtual

write ShowInfoT

Parameters

os	reference to the output stream
show	data to be written

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, rcsc::rcg::SerializerV4, rcsc::rcg::SerializerV5, and rcsc::rcg::SerializerV6.

◆ serialize() [14/15]

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

pure virtual

write team info

Parameters

os	reference to the output stream
team_l	left team variable
team_r	right team variable

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serialize() [15/15]

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

pure virtual

write team info

Parameters

os	reference to the output stream
team_l	left team variable
team_r	right team variable

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

◆ serializeHeader()

virtual std::ostream & rcsc::rcg::Serializer::serializeHeader ( std::ostream & os )

pure virtual

write header

Parameters

os	reference to the output stream

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, rcsc::rcg::SerializerV4, rcsc::rcg::SerializerV5, and rcsc::rcg::SerializerV6.

◆ serializeImpl() [1/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const char	pmode
	)

protected

write playmode

Parameters

os	reference to the output stream
pmode	playmode index

Returns: reference to the output stream

◆ serializeImpl() [2/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const dispinfo_t &	disp
	)

protected

write dispinfo (version 1 protocol)

Parameters

os	reference to the output stream
disp	serialized data

Returns: reference to the output stream

◆ serializeImpl() [3/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const dispinfo_t2 &	disp2
	)

protected

write dispinfo_t2, but data is converted.

Parameters

os	reference to the output stream
disp2	serialized data

Returns: reference to the output stream

◆ serializeImpl() [4/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const drawinfo_t &	draw
	)

protected

write draw info

Parameters

os	reference to the output stream
draw	serialized data

Returns: reference to the output stream

◆ serializeImpl() [5/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const int	version
	)

protected

write header

Parameters

os	reference to the output stream
version	log version

Returns: reference to the output stream

◆ serializeImpl() [6/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const msginfo_t &	msg
	)

protected

write message info

Parameters

os	reference to the output stream
msg	serialized data

Returns: reference to the output stream

◆ serializeImpl() [7/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const player_params_t &	pparam
	)

protected

write player param

Parameters

os	reference to the output stream
pparam	plyaer_params_t data

Returns: reference to the output stream

◆ serializeImpl() [8/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const player_type_t &	type
	)

protected

write player type param

Parameters

os	reference to the output stream
type	player_type_t data

Returns: reference to the output stream

◆ serializeImpl() [9/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const PlayMode	pmode
	)

protected

write playmode

Parameters

os	reference to the output stream
pmode	playmode index

Returns: reference to the output stream

◆ serializeImpl() [10/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const server_params_t &	param
	)

protected

write server param

Parameters

os	reference to the output stream
param	server_params_t data

Returns: reference to the output stream

◆ serializeImpl() [11/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const short_showinfo_t2 &	show2
	)

protected

write short_showinfo (version 3 protocol)

Parameters

os	reference to the output stream
show2	serialized data

Returns: reference to the output stream

◆ serializeImpl() [12/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const showinfo_t &	show
	)

protected

write showinfo (version 2 protocol)

Parameters

os	reference to the output stream
show	serialized data

Returns: reference to the output stream

◆ serializeImpl() [13/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const showinfo_t2 &	show2
	)

protected

write showinfo_t2 (version 3 protocol). data is converted to short_showinfo_t2.

Parameters

os	reference to the output stream
show2	serialized data

Returns: reference to the output stream

◆ serializeImpl() [14/14]

std::ostream & rcsc::rcg::Serializer::serializeImpl	(	std::ostream &	os,
		const team_t &	team_l,
		const team_t &	team_r
	)

protected

write team info

Parameters

os	reference to the output stream
team_l	left team data
team_r	right team data

Returns: reference to the output stream

◆ serializeParam()

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

pure virtual

write parameter message

Parameters

os	reference to the output stream
msg	server parameter message

Returns: reference to the output stream

Implemented in rcsc::rcg::SerializerV1, rcsc::rcg::SerializerV2, rcsc::rcg::SerializerV3, and rcsc::rcg::SerializerV4.

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

/home/kali/rc/tools/include/rcsc/rcg/serializer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ create()

◆ creators()

◆ serialize() [1/15]

◆ serialize() [2/15]

◆ serialize() [3/15]

◆ serialize() [4/15]

◆ serialize() [5/15]

◆ serialize() [6/15]

◆ serialize() [7/15]

◆ serialize() [8/15]

◆ serialize() [9/15]

◆ serialize() [10/15]

◆ serialize() [11/15]

◆ serialize() [12/15]

◆ serialize() [13/15]

◆ serialize() [14/15]

◆ serialize() [15/15]

◆ serializeHeader()

◆ serializeImpl() [1/14]

◆ serializeImpl() [2/14]

◆ serializeImpl() [3/14]

◆ serializeImpl() [4/14]

◆ serializeImpl() [5/14]

◆ serializeImpl() [6/14]

◆ serializeImpl() [7/14]

◆ serializeImpl() [8/14]

◆ serializeImpl() [9/14]

◆ serializeImpl() [10/14]

◆ serializeImpl() [11/14]

◆ serializeImpl() [12/14]

◆ serializeImpl() [13/14]

◆ serializeImpl() [14/14]

◆ serializeParam()