DEPRECATED. More...

Inheritance diagram for PIProtocol:

Public Types
enum	Quality { Unknown = 1, Failure = 2, Bad = 3, Average = 4, Good = 5 }
	Connection quality. More...

Public Member Functions
	PIProtocol ()
	Contructs an empty unconfigured protocol.

	PIProtocol (const PIString &config, const PIString &name, void recHeaderPtr=0, int recHeaderSize=0, void recDataPtr=0, int recDataSize=0, void *sendDataPtr=0, int sendDataSize=0)
	DEPRECATED. More...

Public Member Functions inherited from PIObject
	PIObject (const PIString &name=PIString())
	Contructs PIObject with name "name".

PIString	name () const
	Returns object name.

virtual const char *	className () const
	Returns object class name.

virtual const char *	parentClassName () const
	Returns parent object class name.

bool	debug () const
	Return if debug of this object is active.

void	setName (const PIString &name)
	Set object name.

void	setDebug (bool debug)
	Set object debug active.

const PIMap< PIString, PIVariant > &	properties () const
	Returns properties of the object.

int	propertiesCount () const
	Returns properties count of the object.

PIVariant	property (const PIString &name) const
	Returns property with name "name".

void	setProperty (const PIString &name, const PIVariant &value)
	Set property with name "name" to "value". If there is no such property in object it will be added.

bool	isPropertyExists (const PIString &name) const
	Returns if property with name "name" exists.

Additional Inherited Members
Static Public Member Functions inherited from PIObject
static void	piDisconnect (PIObject *src, const PIString &sig)
	Disconnect object "src" from all connections with event name "sig".

static void	piDisconnect (PIObject *src)
	Disconnect object "src" from all connections, i.e. all connections where object "src" is emitter.

static PIObject *	findByName (const PIString &name)
	Returns PIObject* with name "name" or 0, if there is no object found.

Protected Member Functions inherited from PIObject
PIObject *	emitter () const
	Returns PIObject* which has raised an event. This value is correct only in definition of some event handler.

virtual void	propertyChanged (const PIString &name)
	Virtual function executes after property with name "name" has been changed.

void	deleted ()
	Raise before object delete. More...

Related Functions inherited from PIObject
#define	piCoutObj
	Macro used for conditional (piDebug and PIObject::debug()) output to PICout for subclasses of PIObject.

#define	PIOBJECT(name)
	you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output

#define	PIOBJECT_SUBCLASS(name, parent)
	you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class, and scopeList()

#define	EVENT_HANDLER0(ret, name) ret name()
	declare event handler "event" with name "name" and return type "ret", ret name()

#define	EVENT_HANDLER1(ret, name, type0, var0) ret name(type0 var0)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0)

#define	EVENT_HANDLER2(ret, name, type0, var0, type1, var1) ret name(type0 var0, type1 var1)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1)

#define	EVENT_HANDLER3(ret, name, type0, var0, type1, var1, type2, var2) ret name(type0 var0, type1 var1, type2 var2)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_HANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	declare event handler "event" with name "name" and return type "ret", ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_HANDLER EVENT_HANDLER0
	EVENT_HANDLER is synonym of EVENT_HANDLER0.

#define	EVENT_VHANDLER0(ret, name) virtual ret name()
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name()

#define	EVENT_VHANDLER1(ret, name, type0, var0) virtual ret name(type0 var0)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0)

#define	EVENT_VHANDLER2(ret, name, type0, var0, type1, var1) virtual ret name(type0 var0, type1 var1)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1)

#define	EVENT_VHANDLER3(ret, name, type0, var0, type1, var1, type2, var2) virtual ret name(type0 var0, type1 var1, type2 var2)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2)

#define	EVENT_VHANDLER4(ret, name, type0, var0, type1, var1, type2, var2, type3, var3) virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)
	declare virtual event handler "event" with name "name" and return type "ret", virtual ret name(type0 var0, type1 var1, type2 var2, type3 var3)

#define	EVENT_VHANDLER EVENT_VHANDLER0
	EVENT_VHANDLER is synonym of EVENT_VHANDLER0.

#define	EVENT0(name) void name();
	declare event "event" with name "name", void name();

#define	EVENT1(name, type0, var0) void name(type0 var0);
	declare event "event" with name "name", void name(type0 var0);

#define	EVENT2(name, type0, var0, type1, var1) void name(type0 var0, type1 var1);
	declare event "event" with name "name", void name(type0 var0, type1 var1);

#define	EVENT3(name, type0, var0, type1, var1, type2, var2) void name(type0 var0, type1 var1, type2 var2);
	declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2);

#define	EVENT4(name, type0, var0, type1, var1, type2, var2, type3, var3) void name(type0 var0, type1 var1, type2 var2, type3 var3);
	declare event "event" with name "name", void name(type0 var0, type1 var1, type2 var2, type3 var3);

#define	EVENT EVENT0
	EVENT is synonym of EVENT0.

#define	CONNECTU(src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler". "Event" and "handler" must has equal argument lists.

#define	CONNECTU_QUEUED(src, event, dest, handler, performer)
	connect event "event" from object "src" to event handler "handler". Event handler will be executed by "performer". "Event" and "handler" must has equal argument lists.

#define	CONNECT0(ret, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT1(ret, type0, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT2(ret, type0, type1, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" with check of event and handler exists

#define	CONNECT CONNECT0
	CONNECT is synonym of CONNECT0.

#define	WEAK_CONNECT0(ret, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT1(ret, type0, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT2(ret, type0, type1, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	connect event "event" from object "src" to event handler "handler" with return type "ret" from object "dest" without check of event exists

#define	WEAK_CONNECT WEAK_CONNECT0
	WEAK_CONNECT is synonym of WEAK_CONNECT0.

#define	DISCONNECT0(ret, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT1(ret, type0, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT2(ret, type0, type1, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT3(ret, type0, type1, type2, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT4(ret, type0, type1, type2, type3, src, event, dest, handler)
	piDisconnect event "event" from object "src" from event handler "handler" with return type "ret" from object "dest"

#define	DISCONNECT DISCONNECT0
	DISCONNECT is synonym of DISCONNECT0.

#define	HANDLER(handler)
	Returns pointer to events handler "handler".

Detailed Description

DEPRECATED.

events: void receiverStarted() void receiverStopped() void senderStarted() void senderStopped() void received(bool validate_is_ok) void qualityChanged(PIProtocol::Quality old_quality, PIProtocol::Quality new_quality)

handlers: void startReceive(float exp_frequency = -1.f) void stopReceive() void startSend(float frequency = -1.f) void stopSend() void start() void stop() void send() void send(const void * data, int size, bool direct = false)

Synopsis

Member Enumeration Documentation

◆ Quality

enum PIProtocol::Quality

Connection quality.

Enumerator
Unknown	Unknown, no one packet received yet
Failure	No connection, no one correct packet received for last period
Bad	Bad connection, correct packets received <= 20%
Average	Average connection, correct packets received > 20% and <= 80%
Good	Good connection, correct packets received > 80%

Constructor & Destructor Documentation

◆ PIProtocol()

PIProtocol::PIProtocol	(	const PIString &	config,
		const PIString &	name,
		void *	recHeaderPtr = `0`,
		int	recHeaderSize = `0`,
		void *	recDataPtr = `0`,
		int	recDataSize = `0`,
		void *	sendDataPtr = `0`,
		int	sendDataSize = `0`
	)

DEPRECATED.

Contructs protocol configured from file "config", config file section "name"

Public Types