-
-
- Generated on Fri Sep 28 2018 21:06:38 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+PIBroadcast Member List
+
+
+This is the complete list of members for PIBroadcast, including all inherited members.
+
+
+
+
diff --git a/doc/html/class_p_i_broadcast.html b/doc/html/class_p_i_broadcast.html
new file mode 100644
index 00000000..5cec2009
--- /dev/null
+++ b/doc/html/class_p_i_broadcast.html
@@ -0,0 +1,650 @@
+
+
+
+
+
+
+
+-
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+
+PIBroadcast Class Reference
+
+
+
+
+
+
+
+
+Broadcast for all interfaces, including loopback. + More...
+
+Inheritance diagram for PIBroadcast:
+
+
+
+[legend]
++Public Types | |
| enum | Channel { Multicast = 0x01, +Broadcast = 0x02, +Loopback = 0x04, +All = 0xFFFF + } |
| PIBroadcast channels, can be used independently More... | |
 Public Types inherited from PIThread | |
| enum | Priority { + piLowerst, +piLow, +piNormal, +piHigh, + + piHighest + + } |
| Priority of thread. More... | |
+Public Member Functions | |
| PIBroadcast (bool send_only=false) | |
| +void | setChannels (Channels ch) |
| Set channels to "ch" and queue to reinit. | |
| +Channels | channels () const |
| Returns channels. | |
| +bool | isSendOnly () const |
| Returns if is send_only. | |
| +void | setMulticastGroup (const PIString &mg) |
| Set multicast IP to "mg" and queue to reinit. | |
| +PIString | multicastGroup () const |
| Returns multicast IP. | |
| +void | setMulticastPort (ushort port) |
| Set multicast port to "port" and queue to reinit. | |
| +ushort | multicastPort () const |
| Returns multicast port. | |
| +void | setMulticastAddress (const PIEthernet::Address &addr) |
| Set multicast address to "addr" and queue to reinit. | |
| +PIEthernet::Address | multicastAddress () const |
| Returns multicast address. | |
| +void | setBroadcastPort (ushort port) |
| Set broadcast port to "port" and queue to reinit. | |
| +ushort | broadcastPort () |
| Returns broadcast port. | |
| +void | setLoopbackPort (ushort port) |
| Set loopback start port to "port" and queue to reinit. | |
| +ushort | loopbackPort () |
| Returns loopback start port. | |
| +void | setLoopbackPortsCount (int count) |
| Set loopback ports count to "count" and queue to reinit. | |
| +int | loopbackPortsCount () const |
| Returns loopback ports count. | |
| +void | startRead () |
| If not send_only starts all threaded reads. | |
| +void | stopRead () |
| Stop all threaded reads. | |
| +void | reinit () |
| Reinit all PIEthernets with current PIEthernet::allAddresses() | |
| +void | send (const PIByteArray &data) |
| Send packet. | |
| Public Member Functions inherited from PIThread | |
| + | PIThread (void *data, ThreadFunc func, bool startNow=false, int loop_delay=-1) |
| Contructs thread with custom data "data", external function "func" and main loop delay "loop_delay". | |
| + | PIThread (bool startNow=false, int loop_delay=-1) |
| Contructs thread with main loop delay "loop_delay". | |
| +void | setData (void *d) |
| Set common data passed to external function. | |
| +void | setSlot (ThreadFunc func) |
| Set external function that will be executed after every run() | |
| +void | setPriority (PIThread::Priority prior) |
| Set priority of thread. | |
| +void * | data () const |
| Returns common data passed to external function. | |
| +PIThread::Priority | priority () const |
| Return priority of thread. | |
| +bool | isRunning () const |
Return true if thread is running. | |
| +void | needLockRun (bool need) |
| Set necessity of lock every run with internal mutex. | |
| +PIMutex & | mutex () |
| Returns internal mutex. | |
| +llong | tid () const |
| Returns thread ID. | |
| bool | start (int timer_delay) |
| Start thread. More... | |
| bool | startOnce () |
| Start thread without internal loop. More... | |
| bool | startOnce (ThreadFunc func) |
| Start thread without internal loop. More... | |
| void | stop (bool wait) |
| Stop thread. More... | |
| void | terminate () |
| Strongly stop thread. More... | |
| bool | waitForStart (int timeout_msecs) |
| Wait for thread start. More... | |
| bool | waitForFinish (int timeout_msecs) |
| Wait for thread finish. More... | |
| +void | lock () |
| Lock internal mutex. | |
| +void | unlock () |
| Unlock internal mutex. | |
| +void | started () |
| Raise on thread start. | |
| +void | stopped () |
| Raise on thread stop. | |
| 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. | |
| Public Member Functions inherited from PIEthUtilBase | |
| +void | setCryptEnabled (bool on) |
| Set crypt layer enabled. | |
| +void | cryptEnable () |
| Enable crypt layer. | |
| +void | cryptDisable () |
| Disable crypt layer. | |
| +bool | isCryptEnabled () const |
| Returns if crypt layer enabled. | |
| +void | setCryptKey (const PIByteArray &k) |
| Set crypt layer key to "k". | |
| void | createCryptKey (const PIString &k) |
| +PIByteArray | cryptKey () const |
| Returns crypt layer key. | |
+Protected Member Functions | |
| +virtual void | received (PIByteArray data) |
| Called when packet received. | |
| Protected Member Functions inherited from PIThread | |
| +virtual void | begin () |
| Function executed once at the start of thread. | |
| +virtual void | end () |
| Function executed once at the end of thread. | |
| 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... | |
| Protected Member Functions inherited from PIEthUtilBase | |
| +PIByteArray | cryptData (const PIByteArray &data) |
| Returns encrypted data if layer enabled, otherwise returns unchanged "data". | |
| +PIByteArray | decryptData (const PIByteArray &data) |
| Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsuccessfull returns empty PIByteArray. | |
+Events | |
| +void | receiveEvent (PIByteArray data) |
| Raise on packet received. | |
+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. | |
| 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
+Broadcast for all interfaces, including loopback.
++Synopsis
+PIBroadcast used as multichannel IO device. It can use multicast, broadcast and loopback ethernet channels to send/receive packets. send() function send packet to all initialized ethernets. receiveEvent() raised on packet received by any ethernet. All multi/broadcast ethernets created for all current addresses, obtained by PIEthernets::allAddresses().
+-
+
- Multicast ethernets use multicastGroup() and multicastPort() +
- Broadcast ethernets use broadcastPort() +
- Loopback ethernet use loopbackPortsCount() started from loopbackPort() +
PIBroadcast starts thread , which every 3 seconds check if current PIEthernet::allAddresses() was changed and call reinit() if it necessary.
+Member Enumeration Documentation
+ +◆ Channel
+ +
+
+
+
+
+
+| enum PIBroadcast::Channel | +
Constructor & Destructor Documentation
+ +◆ PIBroadcast()
+ +
+
+
+
+
+
| PIBroadcast::PIBroadcast | +( | +bool | +send_only = false | ) | ++ |
+
+Contructs PIBroadcast, if "send_only" not set all PIEthernets will be binded to receive data
+ +
+
+
+
diff --git a/doc/html/class_p_i_broadcast.js b/doc/html/class_p_i_broadcast.js
new file mode 100644
index 00000000..19aba59b
--- /dev/null
+++ b/doc/html/class_p_i_broadcast.js
@@ -0,0 +1,31 @@
+var class_p_i_broadcast =
+[
+ [ "Channel", "class_p_i_broadcast.html#a9b82dfae7f970ced83a087400b2d28af", [
+ [ "Multicast", "class_p_i_broadcast.html#a9b82dfae7f970ced83a087400b2d28afac249b9ff91f3f4f36d23de609b9fea57", null ],
+ [ "Broadcast", "class_p_i_broadcast.html#a9b82dfae7f970ced83a087400b2d28afabd8a0123afd20d1cd137b06b29577116", null ],
+ [ "Loopback", "class_p_i_broadcast.html#a9b82dfae7f970ced83a087400b2d28afa801cb241b251a71c682a26fee954b63e", null ],
+ [ "All", "class_p_i_broadcast.html#a9b82dfae7f970ced83a087400b2d28afa424139ae0bca80e7818d26854dbcec3f", null ]
+ ] ],
+ [ "PIBroadcast", "class_p_i_broadcast.html#a12da6494875fa86bbe624b2e38447a00", null ],
+ [ "setChannels", "class_p_i_broadcast.html#a7107d4ffea3a05392e2969830adb8df8", null ],
+ [ "channels", "class_p_i_broadcast.html#a37a6be39ada878c397dc6e827481e801", null ],
+ [ "isSendOnly", "class_p_i_broadcast.html#a115b0622a31293a8144ee7be9925715d", null ],
+ [ "setMulticastGroup", "class_p_i_broadcast.html#ac3d8dc965a8830c6d0640492a185d5be", null ],
+ [ "multicastGroup", "class_p_i_broadcast.html#a7b4aacfd7f3f87360465aa0e1e32b376", null ],
+ [ "setMulticastPort", "class_p_i_broadcast.html#a9472bbaeac10367b6107d85cf9df3115", null ],
+ [ "multicastPort", "class_p_i_broadcast.html#a62f66ec58a70422d6789328d0a73142b", null ],
+ [ "setMulticastAddress", "class_p_i_broadcast.html#a43843c55bd4e4cec54abee05c3e23fbd", null ],
+ [ "multicastAddress", "class_p_i_broadcast.html#a38279fd719f9bf85959bdaefb09fc962", null ],
+ [ "setBroadcastPort", "class_p_i_broadcast.html#a3ca111af059db3815b84fb193515a43e", null ],
+ [ "broadcastPort", "class_p_i_broadcast.html#a203a0c9340ddc4292e94be2b3a2ef318", null ],
+ [ "setLoopbackPort", "class_p_i_broadcast.html#a859baf8562aa91455eacaa2674cb4f79", null ],
+ [ "loopbackPort", "class_p_i_broadcast.html#a5b29dc7f257dafb48c39e94bbe260e79", null ],
+ [ "setLoopbackPortsCount", "class_p_i_broadcast.html#a6968e92f57636874fc2ab898e9be8dbb", null ],
+ [ "loopbackPortsCount", "class_p_i_broadcast.html#a574d5fab394112270d486b7fbef9adc8", null ],
+ [ "startRead", "class_p_i_broadcast.html#ae50d140c2847b8c75abbb0fba3a9c496", null ],
+ [ "stopRead", "class_p_i_broadcast.html#aa29e4609ea569fdadfa85782d36ee7f5", null ],
+ [ "reinit", "class_p_i_broadcast.html#ac75990ac671d44bc348172da3ae147c3", null ],
+ [ "send", "class_p_i_broadcast.html#a762846ae5154d14c25011f40fb2166ac", null ],
+ [ "receiveEvent", "class_p_i_broadcast.html#ac645d45b65eae720637ae5b13e244446", null ],
+ [ "received", "class_p_i_broadcast.html#a8b8c566a3acc390a47b85f69e11ec4b7", null ]
+];
\ No newline at end of file
diff --git a/doc/html/class_p_i_broadcast__inherit__graph.map b/doc/html/class_p_i_broadcast__inherit__graph.map
new file mode 100644
index 00000000..ea58d7d8
--- /dev/null
+++ b/doc/html/class_p_i_broadcast__inherit__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/doc/html/class_p_i_broadcast__inherit__graph.md5 b/doc/html/class_p_i_broadcast__inherit__graph.md5
new file mode 100644
index 00000000..7cc37aca
--- /dev/null
+++ b/doc/html/class_p_i_broadcast__inherit__graph.md5
@@ -0,0 +1 @@
+d3b3574995c344bd0021696a072f357d
\ No newline at end of file
diff --git a/doc/html/class_p_i_broadcast__inherit__graph.png b/doc/html/class_p_i_broadcast__inherit__graph.png
new file mode 100644
index 00000000..28af3d42
Binary files /dev/null and b/doc/html/class_p_i_broadcast__inherit__graph.png differ
diff --git a/doc/html/class_p_i_byte_array-members.html b/doc/html/class_p_i_byte_array-members.html
index 484aa258..1bb25b89 100644
--- a/doc/html/class_p_i_byte_array-members.html
+++ b/doc/html/class_p_i_byte_array-members.html
@@ -27,7 +27,7 @@
-
+
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
Member Function Documentation
- -◆ addVariable() [1/2]
- -
-
-
-
-
-
| void PIConsole::addVariable | -( | -const PIString & | -name, | -
| - | - | const PIProtocol * | -ptr, | -
| - | - | int | -col = 1, |
-
| - | - | FormatFlags | -format = PIConsole::Normal |
-
| - | ) | -- |
-
-
-Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format".
-This function add to column "column" next lines:
-
-
- "protocol <name>" -
- "Rec - receiverDeviceName": PIProtocol::receiverDeviceState -
- "Send - senderDeviceName": PIProtocol::senderDeviceState -
- "Received count": PIProtocol::receiveCount -
- "Invalid count": PIProtocol::wrongCount -
- "Missed count": PIProtocol::missedCount -
- "Sended count": PIProtocol::sendCount -
- "Immediate Frequency, Hz": PIProtocol::immediateFrequency -
- "Integral Frequency, Hz": PIProtocol::integralFrequency -
- "Receive speed": PIProtocol::receiveSpeed -
- "Send speed": PIProtocol::sendSpeed -
- "Receiver history size": PIProtocol::receiverHistorySize -
- "Sender history size": PIProtocol::senderHistorySize -
- "Disconnect Timeout, s": PIProtocol::disconnectTimeout -
- "Quality": PIProtocol::quality -
◆ addVariable() [2/2]
+◆ addVariable()
@@ -912,7 +850,7 @@ Keyboard usage
@@ -116,7 +116,7 @@ $(document).ready(function(){initNavTree('class_p_i_cout.html','');});
@@ -428,7 +428,7 @@ Writing your own output operator
PIP: Member List
+
+
+
+
+
+
+
+
+
+
+
+PIP: PICout::Notifier Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
@@ -207,7 +207,7 @@ $(document).ready(function(){initNavTree('class_p_i_diagnostics.html','');});
@@ -654,7 +654,7 @@ Synopsis
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('class_p_i_dir.html','');});
@@ -233,7 +233,7 @@ Synopsis
PIP: Member List
+
+
+
+
+
+
+
+
+
+
+
+PIP: PIEthUtilBase Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
@@ -323,7 +323,7 @@ $(document).ready(function(){initNavTree('class_p_i_ethernet.html','');});
WEAK_CONNECT3 PIObject related WEAK_CONNECT4 PIObject related write(const void *data, int max_size) PIIODevice inline write(const PIByteArray &data) PIIODevice inline write(PIByteArray data) PIIODevice inline writeDevice(const void *data, int max_size) PIEthernet protectedvirtual WriteOnly enum value PIIODevice writeThreaded(const void *data, int max_size) PIIODevice inline
@@ -548,10 +548,6 @@ int write (const void *data, int max_size)
Write maximum "max_size" bytes of "data" to device.
-int write (const PIByteArray &data) Write "data" to device.
PIByteArray readForTime (double timeout_ms) Read from device for "timeout_ms" milliseconds and return readed data as PIByteArray. Timeout should to be greater than 0.
close ()
Close device.
+int write (PIByteArray data) Write "data" to device.
virtual void flush () Immediate write all buffers.
PIP: Member List
+
+
+
+
+
+
+
+
+
+
+
+PIP: PIEthernet::Address Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
@@ -108,7 +108,7 @@ $(document).ready(function(){initNavTree('class_p_i_ethernet_1_1_interface_list.
@@ -219,7 +219,7 @@ static int
@@ -91,7 +91,7 @@ $(document).ready(function(){initNavTree('class_p_i_evaluator.html','');});
@@ -225,7 +225,7 @@ Example
@@ -291,7 +291,7 @@ $(document).ready(function(){initNavTree('class_p_i_file.html','');});
WEAK_CONNECT3 PIObject related WEAK_CONNECT4 PIObject related write(const void *data, int max_size) PIIODevice inline write(const PIByteArray &data) PIIODevice inline write(PIByteArray data) PIIODevice inline writeBinary(const char v) PIFile inline writeBinary(const short v) PIFile inline writeBinary(const int v) PIFile inline
@@ -479,10 +479,6 @@ int write (const void *data, int max_size)
Write maximum "max_size" bytes of "data" to device.
-int write (const PIByteArray &data) Write "data" to device.
PIByteArray readForTime (double timeout_ms) Read from device for "timeout_ms" milliseconds and return readed data as PIByteArray. Timeout should to be greater than 0.
close ()
Close device.
+int write (PIByteArray data) Write "data" to device.
void opened () Raise if succesfull open.
@@ -124,7 +124,7 @@ $(document).ready(function(){initNavTree('class_p_i_flags.html','');});
@@ -282,7 +282,7 @@ class PIFlags< Enum >
PIP: Member List
+
+
+
+
+
+
+
+
+
+
+
+PIP: PIIOByteArray Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
@@ -237,7 +237,7 @@ $(document).ready(function(){initNavTree('class_p_i_i_o_device.html','');});
WEAK_CONNECT3 PIObject related WEAK_CONNECT4 PIObject related write(const void *data, int max_size) PIIODevice inline write(const PIByteArray &data) PIIODevice inline write(PIByteArray data) PIIODevice inline writeDevice(const void *data, int max_size) PIIODevice inlineprotectedvirtual WriteOnly enum value PIIODevice writeThreaded(const void *data, int max_size) PIIODevice inline
@@ -284,10 +284,6 @@ int write (const void *data, int max_size)
Write maximum "max_size" bytes of "data" to device.
-int write (const PIByteArray &data) Write "data" to device.
PIByteArray readForTime (double timeout_ms) Read from device for "timeout_ms" milliseconds and return readed data as PIByteArray. Timeout should to be greater than 0.
close ()
Close device.
+int write (PIByteArray data) Write "data" to device.
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+PICout::Notifier Member List
+
+
+
+This is the complete list of members for PICout::Notifier, including all inherited members.
+
+
+
+
diff --git a/doc/html/class_p_i_cout_1_1_notifier.html b/doc/html/class_p_i_cout_1_1_notifier.html
new file mode 100644
index 00000000..fd220699
--- /dev/null
+++ b/doc/html/class_p_i_cout_1_1_notifier.html
@@ -0,0 +1,92 @@
+
+
+
+
+
+
+
+-
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+
+PICout::Notifier Class Reference
+
+
+Class for emit notifications of PICout. + More...
+Detailed Description
+Class for emit notifications of PICout.
++Synopsis
+This class used as PICout events emitter. When PICout constructs with external PIString* buffer and some id, last copy of this PICout on delete emit event "finished()" on object Notifier::object(). Sample:
+
+
+
diff --git a/doc/html/class_p_i_diagnostics-members.html b/doc/html/class_p_i_diagnostics-members.html
index 62a69769..dbecbe10 100644
--- a/doc/html/class_p_i_diagnostics-members.html
+++ b/doc/html/class_p_i_diagnostics-members.html
@@ -27,7 +27,7 @@
-
+
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+PIEthUtilBase Member List
+
+
+
+This is the complete list of members for PIEthUtilBase, including all inherited members.
+| createCryptKey(const PIString &k) | PIEthUtilBase | |
| cryptData(const PIByteArray &data) | PIEthUtilBase | protected |
| cryptDisable() | PIEthUtilBase | inline |
| cryptEnable() | PIEthUtilBase | inline |
| cryptKey() const | PIEthUtilBase | inline |
| decryptData(const PIByteArray &data) | PIEthUtilBase | protected |
| isCryptEnabled() const | PIEthUtilBase | inline |
| setCryptEnabled(bool on) | PIEthUtilBase | inline |
| setCryptKey(const PIByteArray &k) | PIEthUtilBase | inline |
+
+
+
diff --git a/doc/html/class_p_i_eth_util_base.html b/doc/html/class_p_i_eth_util_base.html
new file mode 100644
index 00000000..1e4a8d1b
--- /dev/null
+++ b/doc/html/class_p_i_eth_util_base.html
@@ -0,0 +1,169 @@
+
+
+
+
+
+
+
+-
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+
+PIEthUtilBase Class Reference
+
+
+
+
+
+Base class for ethernet utils. + More...
+
+Inheritance diagram for PIEthUtilBase:
+
+
+
+[legend]
++Public Member Functions | |
| +void | setCryptEnabled (bool on) |
| Set crypt layer enabled. | |
| +void | cryptEnable () |
| Enable crypt layer. | |
| +void | cryptDisable () |
| Disable crypt layer. | |
| +bool | isCryptEnabled () const |
| Returns if crypt layer enabled. | |
| +void | setCryptKey (const PIByteArray &k) |
| Set crypt layer key to "k". | |
| void | createCryptKey (const PIString &k) |
| +PIByteArray | cryptKey () const |
| Returns crypt layer key. | |
+Protected Member Functions | |
| +PIByteArray | cryptData (const PIByteArray &data) |
| Returns encrypted data if layer enabled, otherwise returns unchanged "data". | |
| +PIByteArray | decryptData (const PIByteArray &data) |
| Returns decrypted data if layer enabled, otherwise returns unchanged "data". If decryption was unsuccessfull returns empty PIByteArray. | |
Detailed Description
+Base class for ethernet utils.
++Synopsis
+PIEthUtilBase provides crypt layer for derived classes: PIStreamPacker and PIBroadcast. All input and output (sended and received) data can be decrypted/encrypted by this layer.
+By default crypt layer is disabled.
+You can separetely enable it and set ready-to-use key by setCryptEnabled() and setCryptKey(). Or you can use createCryptKey() to generate key from your passphrase and automatic enable crypt layer.
+- Note
- To use crypt layer, PIP should be built with crypt module, otherwise your in/out data will be lost.
You can use this class as base for your own classes. Use cryptData() and decryptData() when send and receive your data.
+Member Function Documentation
+ +◆ createCryptKey()
+ +
+
+
+
+
+
| void PIEthUtilBase::createCryptKey | +( | +const PIString & | +k | ) | ++ |
+
+Generate crypt layer key by PICrypt::hash and set crypt layer enabled
+ +
+
+
+
diff --git a/doc/html/class_p_i_eth_util_base.js b/doc/html/class_p_i_eth_util_base.js
new file mode 100644
index 00000000..67f2239b
--- /dev/null
+++ b/doc/html/class_p_i_eth_util_base.js
@@ -0,0 +1,12 @@
+var class_p_i_eth_util_base =
+[
+ [ "setCryptEnabled", "class_p_i_eth_util_base.html#a935d02f1ad790d9c7c56c295faf933fc", null ],
+ [ "cryptEnable", "class_p_i_eth_util_base.html#a236d43aab3c789aa8e13dbc9891d3f04", null ],
+ [ "cryptDisable", "class_p_i_eth_util_base.html#add574b4867213e919735dc17aaf6a660", null ],
+ [ "isCryptEnabled", "class_p_i_eth_util_base.html#ad05e492bb73b2761000ed35ae8e4e84a", null ],
+ [ "setCryptKey", "class_p_i_eth_util_base.html#a1798e06d39958edc702bd1305bdb891b", null ],
+ [ "createCryptKey", "class_p_i_eth_util_base.html#af767aecb3d1ec67811df1fa4bf98ed5d", null ],
+ [ "cryptKey", "class_p_i_eth_util_base.html#afb42451017033d01487de9e34d9bc1bd", null ],
+ [ "cryptData", "class_p_i_eth_util_base.html#aece8c6e8f3947771371f647f29041c40", null ],
+ [ "decryptData", "class_p_i_eth_util_base.html#a20185c767428c8d1c1d84d687c770164", null ]
+];
\ No newline at end of file
diff --git a/doc/html/class_p_i_eth_util_base__inherit__graph.map b/doc/html/class_p_i_eth_util_base__inherit__graph.map
new file mode 100644
index 00000000..1511035e
--- /dev/null
+++ b/doc/html/class_p_i_eth_util_base__inherit__graph.map
@@ -0,0 +1,4 @@
+
diff --git a/doc/html/class_p_i_eth_util_base__inherit__graph.md5 b/doc/html/class_p_i_eth_util_base__inherit__graph.md5
new file mode 100644
index 00000000..6e93d0fa
--- /dev/null
+++ b/doc/html/class_p_i_eth_util_base__inherit__graph.md5
@@ -0,0 +1 @@
+e1d44175065905c94171903729ecadc4
\ No newline at end of file
diff --git a/doc/html/class_p_i_eth_util_base__inherit__graph.png b/doc/html/class_p_i_eth_util_base__inherit__graph.png
new file mode 100644
index 00000000..0f6548a3
Binary files /dev/null and b/doc/html/class_p_i_eth_util_base__inherit__graph.png differ
diff --git a/doc/html/class_p_i_ethernet-members.html b/doc/html/class_p_i_ethernet-members.html
index affff809..b644803f 100644
--- a/doc/html/class_p_i_ethernet-members.html
+++ b/doc/html/class_p_i_ethernet-members.html
@@ -27,7 +27,7 @@
-
+
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+PIEthernet::Address Member List
+
+
+
+This is the complete list of members for PIEthernet::Address, including all inherited members.
+| Address(uint ip=0, ushort port=0) | PIEthernet::Address | |
| Address(const PIString &ip_port) | PIEthernet::Address | |
| Address(const PIString &ip, ushort port) | PIEthernet::Address | |
| clear() | PIEthernet::Address | |
| ip() const | PIEthernet::Address | inline |
| ipString() const | PIEthernet::Address | |
| isNull() const | PIEthernet::Address | |
| port() const | PIEthernet::Address | inline |
| resolve(const PIString &host_port) | PIEthernet::Address | static |
| resolve(const PIString &host, ushort port) | PIEthernet::Address | static |
| set(const PIString &ip_port) | PIEthernet::Address | |
| set(const PIString &ip, ushort port) | PIEthernet::Address | |
| set(uint ip, ushort port) | PIEthernet::Address | |
| setIP(uint ip) | PIEthernet::Address | |
| setIP(const PIString &ip) | PIEthernet::Address | |
| setPort(ushort port) | PIEthernet::Address | |
| toString() const | PIEthernet::Address |
+
+
+
diff --git a/doc/html/class_p_i_ethernet_1_1_address.html b/doc/html/class_p_i_ethernet_1_1_address.html
new file mode 100644
index 00000000..df9ab4ca
--- /dev/null
+++ b/doc/html/class_p_i_ethernet_1_1_address.html
@@ -0,0 +1,167 @@
+
+
+
+
+
+
+
+-
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+
+PIEthernet::Address Class Reference
+
+
+
+
+
+IPv4 network address, IP and port. + More...
++Public Member Functions | |
| + | Address (uint ip=0, ushort port=0) |
| Contructs Address with binary representation of IP and port. | |
| + | Address (const PIString &ip_port) |
| Contructs Address with string representation "i.i.i.i:p". | |
| + | Address (const PIString &ip, ushort port) |
| Contructs Address with IP string representation "i.i.i.i" and port. | |
| +uint | ip () const |
| Returns binary IP. | |
| +ushort | port () const |
| Returns port. | |
| +PIString | ipString () const |
| Returns string IP. | |
| +PIString | toString () const |
| Returns string representation of IP and port "i.i.i.i:p". | |
| +void | setIP (uint ip) |
| Set address IP. | |
| +void | setIP (const PIString &ip) |
| Set address IP. | |
| +void | setPort (ushort port) |
| Set address port. | |
| +void | set (const PIString &ip_port) |
| Set address IP and port, "i.i.i.i:p". | |
| +void | set (const PIString &ip, ushort port) |
| Set address IP and port, "i.i.i.i". | |
| +void | set (uint ip, ushort port) |
| Set address binary IP and port. | |
| +void | clear () |
| Set IP and port to 0. | |
| +bool | isNull () const |
| Returns if IP and port is 0. | |
+Static Public Member Functions | |
| +static Address | resolve (const PIString &host_port) |
| Resolve hostname "host:port" and return it address or null address on error. | |
| +static Address | resolve (const PIString &host, ushort port) |
| Resolve hostname "host" with port "port" and return it address or null address on error. | |
Detailed Description
+IPv4 network address, IP and port.
+
+
+
+
diff --git a/doc/html/class_p_i_ethernet_1_1_address.js b/doc/html/class_p_i_ethernet_1_1_address.js
new file mode 100644
index 00000000..7ab0b44f
--- /dev/null
+++ b/doc/html/class_p_i_ethernet_1_1_address.js
@@ -0,0 +1,18 @@
+var class_p_i_ethernet_1_1_address =
+[
+ [ "Address", "class_p_i_ethernet_1_1_address.html#a7dca082ab25686fcb54a161d8ca554c2", null ],
+ [ "Address", "class_p_i_ethernet_1_1_address.html#a5351b8aa4937d0ea5e6cf8571e27e24b", null ],
+ [ "Address", "class_p_i_ethernet_1_1_address.html#a8b604dd65ee253ecc4624cd7893f5600", null ],
+ [ "ip", "class_p_i_ethernet_1_1_address.html#a78d03bd64e4a5d1dc4007fe7d3b77fc9", null ],
+ [ "port", "class_p_i_ethernet_1_1_address.html#ab4a632b6cd4cb335a537091790cd3906", null ],
+ [ "ipString", "class_p_i_ethernet_1_1_address.html#a1323343ca5df9238393bcf2709fe977a", null ],
+ [ "toString", "class_p_i_ethernet_1_1_address.html#a70e16923d2c3503f6a0be506daf7a70c", null ],
+ [ "setIP", "class_p_i_ethernet_1_1_address.html#adfcd167320d8301f696bbce9dc6a1e25", null ],
+ [ "setIP", "class_p_i_ethernet_1_1_address.html#a77b1dd28a77ae355da3d84a53ea92baa", null ],
+ [ "setPort", "class_p_i_ethernet_1_1_address.html#a28f62cc70b98299f100701a19a4cc107", null ],
+ [ "set", "class_p_i_ethernet_1_1_address.html#a4b3c892700127416e7d86413dc9916b6", null ],
+ [ "set", "class_p_i_ethernet_1_1_address.html#a33ef7b624bc4fa67f2d3233bed82e9c7", null ],
+ [ "set", "class_p_i_ethernet_1_1_address.html#a7a86f0a0b21a91d58fa506a2edf8feca", null ],
+ [ "clear", "class_p_i_ethernet_1_1_address.html#a344966458950553e9a1a3215267f3396", null ],
+ [ "isNull", "class_p_i_ethernet_1_1_address.html#adb1f8baf80972091b21c992f67feb147", null ]
+];
\ No newline at end of file
diff --git a/doc/html/class_p_i_ethernet_1_1_interface_list-members.html b/doc/html/class_p_i_ethernet_1_1_interface_list-members.html
index b56fbd75..9a5ff19d 100644
--- a/doc/html/class_p_i_ethernet_1_1_interface_list-members.html
+++ b/doc/html/class_p_i_ethernet_1_1_interface_list-members.html
@@ -27,7 +27,7 @@
-
+
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+PIIOByteArray Member List
+
+
+
+This is the complete list of members for PIIOByteArray, including all inherited members.
+| BlockingRead enum value | PIIODevice | |
| BlockingWrite enum value | PIIODevice | |
| byteArray() const | PIIOByteArray | inline |
| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIIODevice | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| clear() | PIIOByteArray | inline |
| clearThreadedWriteQueue() | PIIODevice | inline |
| close() | PIIODevice | inline |
| closed() | PIIODevice | |
| closeDevice() | PIIODevice | inlineprotectedvirtual |
| configure(const PIString &config_file, const PIString §ion, bool parent_section=false) | PIIODevice | |
| configureDevice(const void *e_main, const void *e_parent=0) | PIIODevice | inlineprotectedvirtual |
| configureFromFullPath(const PIString &full_path) | PIIODevice | |
| configureFromFullPathDevice(const PIString &full_path) | PIIODevice | inlineprotectedvirtual |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| CONNECTU_QUEUED | PIObject | related |
| constructFullPath() const | PIIODevice | |
| constructFullPathDevice() const | PIIODevice | inlineprotectedvirtual |
| createFromFullPath(const PIString &full_path) | PIIODevice | static |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| deleted() | PIObject | protected |
| DeviceInfoFlag enum name | PIIODevice | |
| deviceInfoFlags() const | PIIOByteArray | inlineprotectedvirtual |
| DeviceMode enum name | PIIODevice | |
| DeviceOption enum name | PIIODevice | |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| emitter() const | PIObject | inlineprotected |
| EVENT | PIObject | related |
| EVENT0 | PIObject | related |
| EVENT1 | PIObject | related |
| EVENT2 | PIObject | related |
| EVENT3 | PIObject | related |
| EVENT4 | PIObject | related |
| EVENT_HANDLER | PIObject | related |
| EVENT_HANDLER0 | PIObject | related |
| EVENT_HANDLER1 | PIObject | related |
| EVENT_HANDLER2 | PIObject | related |
| EVENT_HANDLER3 | PIObject | related |
| EVENT_HANDLER4 | PIObject | related |
| EVENT_VHANDLER | PIObject | related |
| EVENT_VHANDLER0 | PIObject | related |
| EVENT_VHANDLER1 | PIObject | related |
| EVENT_VHANDLER2 | PIObject | related |
| EVENT_VHANDLER3 | PIObject | related |
| EVENT_VHANDLER4 | PIObject | related |
| findByName(const PIString &name) | PIObject | inlinestatic |
| flush() | PIIODevice | inlinevirtual |
| fullPathPrefix() const | PIIODevice | inlinevirtual |
| HANDLER | PIObject | related |
| infoFlags() const | PIIODevice | inline |
| init() | PIIODevice | inlineprotectedvirtual |
| isClosed() const | PIIODevice | inline |
| isEnd() const | PIIOByteArray | inline |
| isOpened() const | PIIODevice | inline |
| isOptionSet(DeviceOption o) const | PIIODevice | inline |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isReadable() const | PIIODevice | inline |
| isReopenEnabled() const | PIIODevice | inline |
| isRunning() const | PIThread | inline |
| isThreadedRead() const | PIIODevice | inline |
| isThreadedWrite() const | PIIODevice | inline |
| isWriteable() const | PIIODevice | inline |
| lock() | PIThread | inline |
| mode() const | PIIODevice | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| open(PIByteArray *buffer, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIIOByteArray | |
| open(const PIByteArray &buffer) | PIIOByteArray | |
| PIIODevice::open() | PIIODevice | inline |
| PIIODevice::open(const PIString &_path) | PIIODevice | inline |
| openDevice() | PIIOByteArray | protectedvirtual |
| opened() | PIIODevice | |
| options() const | PIIODevice | inline |
| optionsChanged() | PIIODevice | inlineprotectedvirtual |
| parentClassName() const | PIObject | inlinevirtual |
| path() const | PIIODevice | inline |
| piCoutObj | PIObject | related |
| piDisconnect(PIObject *src, const PIString &sig) | PIObject | static |
| piDisconnect(PIObject *src) | PIObject | static |
| piHigh enum value | PIThread | |
| piHighest enum value | PIThread | |
| PIIOByteArray(PIByteArray *buffer=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIIOByteArray | explicit |
| PIIOByteArray(const PIByteArray &buffer) | PIIOByteArray | explicit |
| PIIODEVICE | PIIODevice | related |
| PIIODevice() | PIIODevice | explicit |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | explicit |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | explicit |
| PIOBJECT | PIObject | related |
| PIOBJECT_SUBCLASS | PIObject | related |
| PIThread(void *data, ThreadFunc func, bool startNow=false, int loop_delay=-1) | PIThread | |
| PIThread(bool startNow=false, int loop_delay=-1) | PIThread | |
| priority() const | PIThread | inline |
| Priority enum name | PIThread | |
| properties() const | PIObject | inline |
| propertiesCount() const | PIObject | inline |
| property(const PIString &name) const | PIObject | inline |
| propertyChanged(const PIString &name) | PIObject | inlineprotectedvirtual |
| read(void *read_to, int max_size) | PIIODevice | inline |
| read(int max_size) | PIIODevice | inline |
| readDevice(void *read_to, int size) | PIIOByteArray | protectedvirtual |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| readForTime(double timeout_ms) | PIIODevice | |
| ReadOnly enum value | PIIODevice | |
| ReadWrite enum value | PIIODevice | |
| REGISTER_DEVICE | PIIODevice | related |
| Reliable enum value | PIIODevice | |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| seek(llong position) | PIIOByteArray | inline |
| seekToBegin() | PIIOByteArray | inline |
| seekToEnd() | PIIOByteArray | inline |
| Sequential enum value | PIIODevice | |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setMode(DeviceMode m) | PIIODevice | inline |
| setName(const PIString &name) | PIObject | inline |
| setOption(DeviceOption o, bool yes=true) | PIIODevice | |
| setOptions(DeviceOptions o) | PIIODevice | |
| setPath(const PIString &path) | PIIODevice | inline |
| setPriority(PIThread::Priority prior) | PIThread | |
| setProperty(const PIString &name, const PIVariant &value) | PIObject | inline |
| setReopenEnabled(bool yes=true) | PIIODevice | inline |
| setReopenTimeout(int msecs) | PIIODevice | inline |
| setSlot(ThreadFunc func) | PIThread | inline |
| setThreadedReadBufferSize(int new_size) | PIIODevice | inline |
| setThreadedReadData(void *d) | PIIODevice | inline |
| setThreadedReadSlot(ReadRetFunc func) | PIIODevice | inline |
| start() | PIIODevice | inline |
| PIThread::start(int timer_delay) | PIThread | |
| started() | PIThread | |
| startOnce() | PIThread | |
| startOnce(ThreadFunc func) | PIThread | inline |
| startThreadedRead() | PIIODevice | inline |
| startThreadedRead(ReadRetFunc func) | PIIODevice | inline |
| startThreadedWrite() | PIIODevice | inline |
| stop(bool wait=false) | PIIODevice | inline |
| stopped() | PIThread | |
| stopThreadedRead() | PIIODevice | inline |
| stopThreadedWrite() | PIIODevice | inline |
| threadedRead(uchar *readed, int size) | PIIODevice | protectedvirtual |
| threadedReadBuffer() const | PIIODevice | inline |
| threadedReadBufferSize | PIIODevice | |
| threadedReadBufferSize() const | PIIODevice | inline |
| threadedReadBufferSizeChanged() | PIIODevice | inlineprotectedvirtual |
| threadedReadData() const | PIIODevice | inline |
| threadedReadEvent(uchar *readed, int size) | PIIODevice | |
| threadedWriteEvent(ullong id, int written_size) | PIIODevice | |
| tid() const | PIThread | inline |
| unlock() | PIThread | inline |
| waitForFinish(int timeout_msecs) | PIThread | |
| waitForStart(int timeout_msecs) | PIThread | |
| WEAK_CONNECT | PIObject | related |
| WEAK_CONNECT0 | PIObject | related |
| WEAK_CONNECT1 | PIObject | related |
| WEAK_CONNECT2 | PIObject | related |
| WEAK_CONNECT3 | PIObject | related |
| WEAK_CONNECT4 | PIObject | related |
| write(const void *data, int max_size) | PIIODevice | inline |
| write(PIByteArray data) | PIIODevice | inline |
| writeByteArray(const PIByteArray &ba) | PIIOByteArray | |
| writeDevice(const void *data_, int size) | PIIOByteArray | protectedvirtual |
| WriteOnly enum value | PIIODevice | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice |
+
+
+
diff --git a/doc/html/class_p_i_i_o_byte_array.html b/doc/html/class_p_i_i_o_byte_array.html
new file mode 100644
index 00000000..e14ffca3
--- /dev/null
+++ b/doc/html/class_p_i_i_o_byte_array.html
@@ -0,0 +1,814 @@
+
+
+
+
+
+
+
+-
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+|
+ PIP
+ 1.8.0
+
+ Platform-Independent Primitives
+ |
+
+
+
+
+
+
+
+
+PIIOByteArray Class Reference
+
+
+
+
+
+
+PIIODevice wrapper around PIByteArray. + More...
+
+Inheritance diagram for PIIOByteArray:
+
+
+
+[legend]
++Public Member Functions | |
| + | PIIOByteArray (PIByteArray *buffer=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) |
| Contructs PIIOByteArray with "buffer" content and "mode" open mode. | |
| + | PIIOByteArray (const PIByteArray &buffer) |
| Contructs PIIOByteArray with "buffer" content only for read. | |
| +PIByteArray * | byteArray () const |
| Returns content. | |
| +void | clear () |
| Clear content buffer. | |
| +bool | open (PIByteArray *buffer, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) |
| Open "buffer" content with "mode" open mode. | |
| +bool | open (const PIByteArray &buffer) |
| Open "buffer" content only for read. | |
| +bool | isEnd () const |
| Returns if position is at the end of content. | |
| +void | seek (llong position) |
| Move read/write position to "position". | |
| +void | seekToBegin () |
| Move read/write position to the begin of the string. | |
| +void | seekToEnd () |
| Move read/write position to the end of the string. | |
| +int | writeByteArray (const PIByteArray &ba) |
| Insert data "ba" into content at current position. | |
| Public Member Functions inherited from PIIODevice | |
| + | PIIODevice () |
| Constructs a empty PIIODevice. | |
| PIIODevice (const PIString &path, DeviceMode mode=ReadWrite) | |
| Constructs a PIIODevice with path and mode. More... | |
| +DeviceMode | mode () const |
| Current open mode of device. | |
| +void | setMode (DeviceMode m) |
| Set open mode of device. | |
| +DeviceOptions | options () const |
| Current device options. | |
| +bool | isOptionSet (DeviceOption o) const |
| Current device option "o" state. | |
| +void | setOptions (DeviceOptions o) |
| Set device options. | |
| +bool | setOption (DeviceOption o, bool yes=true) |
| Set device option "o" to "yes" and return previous state. | |
| +DeviceInfoFlags | infoFlags () const |
| Returns device characteristic flags. | |
| +PIString | path () const |
| Current path of device. | |
| +void | setPath (const PIString &path) |
| Set path of device. | |
| +bool | isReadable () const |
| Return true if mode is ReadOnly or ReadWrite. | |
| +bool | isWriteable () const |
| Return true if mode is WriteOnly or ReadWrite. | |
| +bool | isOpened () const |
| Return true if device is successfully opened. | |
| +bool | isClosed () const |
| Return true if device is closed. | |
| +virtual bool | canRead () const |
| Return true if device can read now. | |
| +virtual bool | canWrite () const |
| Return true if device can write now. | |
| +void | setReopenEnabled (bool yes=true) |
| Set execution of open enabled while threaded read on closed device. | |
| +void | setReopenTimeout (int msecs) |
| Set timeout in milliseconds between open tryings if reopen is enabled. | |
| +bool | isReopenEnabled () const |
| Return reopen enable. | |
| +int | reopenTimeout () |
| Return reopen timeout. | |
| void | setThreadedReadSlot (ReadRetFunc func) |
| Set "threaded read slot". More... | |
| +void | setThreadedReadData (void *d) |
| Set custom data that will be passed to "threaded read slot". | |
| void | setThreadedReadBufferSize (int new_size) |
| Set size of threaded read buffer. More... | |
| +int | threadedReadBufferSize () const |
| Return size of threaded read buffer. | |
| +const uchar * | threadedReadBuffer () const |
| Return content of threaded read buffer. | |
| +void * | threadedReadData () const |
| Return custom data that will be passed to "threaded read slot". | |
| +bool | isThreadedRead () const |
| Return true if threaded read is started. | |
| +void | startThreadedRead () |
| Start threaded read. | |
| +void | startThreadedRead (ReadRetFunc func) |
| Start threaded read and assign "threaded read slot" to "func". | |
| +void | stopThreadedRead () |
| Stop threaded read. | |
| +bool | isThreadedWrite () const |
| Return true if threaded write is started. | |
| +void | startThreadedWrite () |
| Start threaded write. | |
| +void | stopThreadedWrite () |
| Stop threaded write. | |
| +void | clearThreadedWriteQueue () |
| Clear threaded write task queue. | |
| +void | start () |
| Start both threaded read and threaded write. | |
| +void | stop (bool wait=false) |
| Stop both threaded read and threaded write and if "wait" block until both threads are stop. | |
| +int | read (void *read_to, int max_size) |
| Read from device maximum "max_size" bytes to "read_to". | |
| +PIByteArray | read (int max_size) |
| Read from device maximum "max_size" bytes and return them as PIByteArray. | |
| +int | write (const void *data, int max_size) |
| Write maximum "max_size" bytes of "data" to device. | |
| +PIByteArray | readForTime (double timeout_ms) |
| Read from device for "timeout_ms" milliseconds and return readed data as PIByteArray. Timeout should to be greater than 0. | |
| +ullong | writeThreaded (const void *data, int max_size) |
| Add task to threaded write queue and return task ID. | |
| +ullong | writeThreaded (const PIByteArray &data) |
| Add task to threaded write queue and return task ID. | |
| +bool | configure (const PIString &config_file, const PIString §ion, bool parent_section=false) |
| Configure device from section "section" of file "config_file", if "parent_section" parent section also will be read. | |
| +virtual PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| +PIString | constructFullPath () const |
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | |
| +void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| +bool | open () |
| Open device. | |
| +bool | open (const PIString &_path) |
| Open device with path "path". | |
| +bool | close () |
| Close device. | |
| +int | write (PIByteArray data) |
| Write "data" to device. | |
| +virtual void | flush () |
| Immediate write all buffers. | |
| +void | opened () |
| Raise if succesfull open. | |
| +void | closed () |
| Raise if succesfull close. | |
| +void | threadedReadEvent (uchar *readed, int size) |
| Raise if read thread succesfull read some data. | |
| +void | threadedWriteEvent (ullong id, int written_size) |
| Raise if write thread successfull write some data of task with ID "id". | |
| Public Member Functions inherited from PIThread | |
| + | PIThread (void *data, ThreadFunc func, bool startNow=false, int loop_delay=-1) |
| Contructs thread with custom data "data", external function "func" and main loop delay "loop_delay". | |
| + | PIThread (bool startNow=false, int loop_delay=-1) |
| Contructs thread with main loop delay "loop_delay". | |
| +void | setData (void *d) |
| Set common data passed to external function. | |
| +void | setSlot (ThreadFunc func) |
| Set external function that will be executed after every run() | |
| +void | setPriority (PIThread::Priority prior) |
| Set priority of thread. | |
| +void * | data () const |
| Returns common data passed to external function. | |
| +PIThread::Priority | priority () const |
| Return priority of thread. | |
| +bool | isRunning () const |
Return true if thread is running. | |
| +void | needLockRun (bool need) |
| Set necessity of lock every run with internal mutex. | |
| +PIMutex & | mutex () |
| Returns internal mutex. | |
| +llong | tid () const |
| Returns thread ID. | |
| bool | start (int timer_delay) |
| Start thread. More... | |
| bool | startOnce () |
| Start thread without internal loop. More... | |
| bool | startOnce (ThreadFunc func) |
| Start thread without internal loop. More... | |
| void | stop (bool wait) |
| Stop thread. More... | |
| void | terminate () |
| Strongly stop thread. More... | |
| bool | waitForStart (int timeout_msecs) |
| Wait for thread start. More... | |
| bool | waitForFinish (int timeout_msecs) |
| Wait for thread finish. More... | |
| +void | lock () |
| Lock internal mutex. | |
| +void | unlock () |
| Unlock internal mutex. | |
| +void | started () |
| Raise on thread start. | |
| +void | stopped () |
| Raise on thread stop. | |
| 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. | |
+Protected Member Functions | |
| +bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable; don't call this function in subclass, use open() | |
| +int | readDevice (void *read_to, int size) |
| Reimplement this function to read from your device. | |
| +int | writeDevice (const void *data_, int size) |
| Reimplement this function to write to your device. | |
| +DeviceInfoFlags | deviceInfoFlags () const |
| Reimplement to return correct DeviceInfoFlags. Default implementation returns 0. | |
| Protected Member Functions inherited from PIIODevice | |
| +virtual bool | init () |
| Function executed before first openDevice() or from constructor. | |
| +virtual bool | configureDevice (const void *e_main, const void *e_parent=0) |
| Reimplement to configure device from entries "e_main" and "e_parent", cast arguments to PIConfig::Entry*. | |
| +virtual bool | closeDevice () |
| Reimplement to close device, inverse return value will be set to "opened_" variable. | |
| +virtual bool | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". | |
| +virtual PIString | constructFullPathDevice () const |
| Reimplement to construct full unambiguous string, describes this device. Default implementation returns path() | |
| +virtual void | configureFromFullPathDevice (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| +virtual void | optionsChanged () |
| Reimplement to apply new device options. | |
| +virtual void | threadedReadBufferSizeChanged () |
| Reimplement to apply new threadedReadBufferSize() | |
| 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... | |
+Additional Inherited Members | |
| Public Types inherited from PIIODevice | |
| enum | DeviceMode { ReadOnly = 0x01, +WriteOnly = 0x02, +ReadWrite = 0x03 + } |
| Open modes for PIIODevice. More... | |
| enum | DeviceOption { BlockingRead = 0x01, +BlockingWrite = 0x02 + } |
| Options for PIIODevice, works with some devices. More... | |
| enum | DeviceInfoFlag { Sequential = 0x01, +Reliable = 0x02 + } |
| Characteristics of PIIODevice subclass. More... | |
| Public Types inherited from PIThread | |
| enum | Priority { + piLowerst, +piLow, +piNormal, +piHigh, + + piHighest + + } |
| Priority of thread. More... | |
| Static Public Member Functions inherited from PIIODevice | |
| static PIIODevice * | createFromFullPath (const PIString &full_path) |
| Try to determine suitable device, create new one, configure it with configureFromFullPath() and returns it. More... | |
| 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. | |
| Public Attributes inherited from PIIODevice | |
| +bool | reopenEnabled |
| setReopenEnabled, default "true" | |
| +int | reopenTimeout |
| setReopenTimeout in ms, default 1000 | |
| +int | threadedReadBufferSize |
| setThreadedReadBufferSize in bytes, default 4096 | |
| Related Functions inherited from PIIODevice | |
| template<typename T > | |
| T | readDeviceSetting (const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) |
| Service function. useful for configuring devices. More... | |
| +#define | REGISTER_DEVICE(class) |
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |
| +#define | PIIODEVICE(class) |
| Use this macro instead of PIOBJECT when describe your own PIIODevice. | |
| 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
+PIIODevice wrapper around PIByteArray.
++Synopsis
+This class sllow you to use PIByteArray as PIIODevice and pass it to, e.g. PIConfig
+
+
+
+
diff --git a/doc/html/class_p_i_i_o_byte_array.js b/doc/html/class_p_i_i_o_byte_array.js
new file mode 100644
index 00000000..6b162709
--- /dev/null
+++ b/doc/html/class_p_i_i_o_byte_array.js
@@ -0,0 +1,18 @@
+var class_p_i_i_o_byte_array =
+[
+ [ "PIIOByteArray", "class_p_i_i_o_byte_array.html#a4ce4dab6c9857c6b8d951e7318b1dc14", null ],
+ [ "PIIOByteArray", "class_p_i_i_o_byte_array.html#abc16f80aa731377f121bd747a6503af1", null ],
+ [ "byteArray", "class_p_i_i_o_byte_array.html#af08ba7d34b8ce7d58ced026805614038", null ],
+ [ "clear", "class_p_i_i_o_byte_array.html#a90d919c6d38e8198a29c518a96cbe9b4", null ],
+ [ "open", "class_p_i_i_o_byte_array.html#a250fdc0635a2d1d94092df36416911e0", null ],
+ [ "open", "class_p_i_i_o_byte_array.html#abac007e16ba6309da7a0503bf76d024c", null ],
+ [ "isEnd", "class_p_i_i_o_byte_array.html#ac470ab0289c4dfa0e1ffe33bbac8aefb", null ],
+ [ "seek", "class_p_i_i_o_byte_array.html#a7d658b7232d6ea9bb356e8e9de322f19", null ],
+ [ "seekToBegin", "class_p_i_i_o_byte_array.html#ad31a666cd3b4f5f8f266ebc84ebc3b0e", null ],
+ [ "seekToEnd", "class_p_i_i_o_byte_array.html#a76097a09ce6bda998dc53ac690e55cc1", null ],
+ [ "writeByteArray", "class_p_i_i_o_byte_array.html#a00f941f549a06e6f150bcaba1c45cdf4", null ],
+ [ "openDevice", "class_p_i_i_o_byte_array.html#a41084c20762e34a864b3a72cbb704a7c", null ],
+ [ "readDevice", "class_p_i_i_o_byte_array.html#a96abeb7fc22a9102240251439b4a71e0", null ],
+ [ "writeDevice", "class_p_i_i_o_byte_array.html#a8f7f14ebe08295970454572408716574", null ],
+ [ "deviceInfoFlags", "class_p_i_i_o_byte_array.html#a9d23538a0cf4ebf0f27a6a3fde9d5774", null ]
+];
\ No newline at end of file
diff --git a/doc/html/class_p_i_i_o_byte_array__inherit__graph.map b/doc/html/class_p_i_i_o_byte_array__inherit__graph.map
new file mode 100644
index 00000000..ae674fd1
--- /dev/null
+++ b/doc/html/class_p_i_i_o_byte_array__inherit__graph.map
@@ -0,0 +1,5 @@
+
diff --git a/doc/html/class_p_i_i_o_byte_array__inherit__graph.md5 b/doc/html/class_p_i_i_o_byte_array__inherit__graph.md5
new file mode 100644
index 00000000..3eeb8c76
--- /dev/null
+++ b/doc/html/class_p_i_i_o_byte_array__inherit__graph.md5
@@ -0,0 +1 @@
+232fd72acc1a9935d2da82e98110a15c
\ No newline at end of file
diff --git a/doc/html/class_p_i_i_o_byte_array__inherit__graph.png b/doc/html/class_p_i_i_o_byte_array__inherit__graph.png
new file mode 100644
index 00000000..5b65a7f4
Binary files /dev/null and b/doc/html/class_p_i_i_o_byte_array__inherit__graph.png differ
diff --git a/doc/html/class_p_i_i_o_device-members.html b/doc/html/class_p_i_i_o_device-members.html
index 0fe25ed4..30ed9089 100644
--- a/doc/html/class_p_i_i_o_device-members.html
+++ b/doc/html/class_p_i_i_o_device-members.html
@@ -27,7 +27,7 @@
-
+
+
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
+
+ 1.8.14
+
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
-
-
- Generated on Fri Sep 28 2018 21:06:37 for PIP by
1.8.14
PIP
- 1.7.1
+ 1.8.0
Platform-Independent Primitives
