diff --git a/doc/html/arrowdown.png b/doc/html/arrowdown.png new file mode 100644 index 00000000..22d5cd56 Binary files /dev/null and b/doc/html/arrowdown.png differ diff --git a/doc/html/arrowright.png b/doc/html/arrowright.png new file mode 100644 index 00000000..49ad225c Binary files /dev/null and b/doc/html/arrowright.png differ diff --git a/doc/html/class_p_i_binary_log__inherit__graph.png b/doc/html/class_p_i_binary_log__inherit__graph.png new file mode 100644 index 00000000..686179ba Binary files /dev/null and b/doc/html/class_p_i_binary_log__inherit__graph.png differ diff --git a/doc/html/class_p_i_c_l_i__inherit__graph.png b/doc/html/class_p_i_c_l_i__inherit__graph.png new file mode 100644 index 00000000..b83e8fb2 Binary files /dev/null and b/doc/html/class_p_i_c_l_i__inherit__graph.png differ diff --git a/doc/html/class_p_i_chunk_stream-members.html b/doc/html/class_p_i_chunk_stream-members.html new file mode 100644 index 00000000..b7182d0e --- /dev/null +++ b/doc/html/class_p_i_chunk_stream-members.html @@ -0,0 +1,98 @@ + + +
+ + + +|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIChunkStream, including all inherited members.
+| atEnd() const | PIChunkStream | inline |
| chunk(int id, const T &data) | PIChunkStream | inlinestatic |
| data() const | PIChunkStream | inline |
| getData() const | PIChunkStream | inline |
| getID() | PIChunkStream | inline |
| PIChunkStream(const PIByteArray &data) | PIChunkStream | inline |
| PIChunkStream(PIByteArray *data=0) | PIChunkStream | inline |
| read() | PIChunkStream | inline |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Class for binary serialization. + More...
++Public Member Functions | |
| + | PIChunkStream (const PIByteArray &data) |
| Contructs stream for read from "data". | |
| + | PIChunkStream (PIByteArray *data=0) |
| Contructs stream for read or write to/from "data", or empty stream for write. | |
| +PIByteArray | data () const |
| Returns internal buffer with written data. | |
| +bool | atEnd () const |
| Returns if there is end of stream. | |
| +int | read () |
| Read one chunk from stream and returns its ID. | |
| +int | getID () |
| Returns last readed chunk ID. | |
| +template<typename T > | |
| T | getData () const |
| Returns value of last readed chunk. | |
+Static Public Member Functions | |
| +template<typename T > | |
| static Chunk< T > | chunk (int id, const T &data) |
| Returns chunk with ID "id" and value "data" for write to stream. | |
Class for binary serialization.
+This class provides very handly mechanism to store and restore values to and from PIByteArray. The main advantage of using this class is that your binary data become independent from order and collection of your values.
+PIChunkStream works with items called "chunk". Chunk is an ID and any value that can be stored and restored to PIByteArray with stream operators << and >>. You can place chunks to stream and read chunks from stream.
+To construct PIChunkStream for writing data use any constructor. Empty constructor creates internal empty buffer that can be accessed by function data(). Non-empty constructor works with given byte array.
+To read chunks from byte array use function read() that returns ID of next chunk. Then you can get value of this chunk with function getData(), but you should definitely know type of this value. You can read from byte array while atEnd() if false.
+Prepare your structs to work with PIChunkStream
Writing to PIChunkStream
Reading from PIChunkStream
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIDir, including all inherited members.
+| absolutePath() const | PIDir | |
| allEntries() | PIDir | |
| cleanedPath() const | PIDir | inline |
| cleanPath() | PIDir | |
| entries() | PIDir | |
| isAbsolute() const | PIDir | |
| isExists() const | PIDir | inline |
| isRelative() const | PIDir | inline |
| path() const | PIDir | |
| PIDir(const PIString &dir=PIString()) | PIDir | |
| PIDir(const PIFile &file) | PIDir | |
| relative(const PIString &path) const | PIDir | |
| scanDir() const | PIDir | inline |
| setCurrent() | PIDir | inline |
| setDir(const PIString &path) | PIDir |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Local directory. + More...
++Public Member Functions | |
| + | PIDir (const PIString &dir=PIString()) |
| Constructs directory with path "path". | |
| + | PIDir (const PIFile &file) |
| Constructs directory with "file" directory path "path". | |
| +bool | isExists () const |
| Returns if this directory is exists. | |
| +bool | isAbsolute () const |
| Returns if path of this directory is absolute. | |
| +bool | isRelative () const |
| Returns if path of this directory is relative. | |
| const PIString & | scanDir () const |
| +PIString | path () const |
| Returns path of this directory. | |
| +PIString | absolutePath () const |
| Returns absolute path of this directory. | |
| PIDir & | cleanPath () |
| Simplify path of this directory. More... | |
| +PIDir | cleanedPath () const |
| Returns PIDir with simplified path of this directory. | |
| +PIString | relative (const PIString &path) const |
| Returns relative to this directory path "path". | |
| +PIDir & | setDir (const PIString &path) |
| Set this directory path to simplified "path". | |
| +bool | setCurrent () |
| Set this directory path as current for application. | |
| PIVector< PIFile::FileInfo > | entries () |
| Returns this directory content. More... | |
| PIVector< PIFile::FileInfo > | allEntries () |
| Returns all this directory content. More... | |
Local directory.
+This class provide access to local file. You can manipulate binary content or use this class as text stream. To binary access there are function read(), write(), and many writeBinary() functions. For write variables to file in their text representation threr are many "<<" operators.
+
+
|
+ +inline | +
Returns path of current reading directory. This path valid only while allEntries functions
+ +| PIDir & PIDir::cleanPath | +( | +) | ++ |
Simplify path of this directory.
+This function remove repeatedly separators and resolve ".." in path. E.g. "/home/.//peri4/src/../.." will become "/home"
+ This function returns reference to this PIDir
| PIVector< PIFile::FileInfo > PIDir::entries | +( | +) | ++ |
Returns this directory content.
+Scan this directory and returns all directories and files in one list, sorted alphabetically. This list contains also "." and ".." members. There are absolute pathes in returned list.
| PIVector< PIFile::FileInfo > PIDir::allEntries | +( | +) | ++ |
Returns all this directory content.
+Scan this directory recursively and returns all directories and files in one list, sorted alphabetically. This list doesn`t contains "." and ".." members. There are absolute pathes in returned list, and files placed after directories in this list
+TODO: resolve symlinks
+ +|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIIOString, including all inherited members.
+| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIIODevice | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| clear() | PIIOString | 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 | inlineprotectedvirtual |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| constructFullPath() const | PIIODevice | inlinevirtual |
| createFromFullPath(const PIString &full_path) | PIIODevice | static |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| deleted() | PIObject | protected |
| DeviceMode 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 |
| init() | PIIODevice | inlineprotectedvirtual |
| initialize() | PIIODevice | inline |
| isClosed() const | PIIODevice | inline |
| isEnd() const | PIIOString | inline |
| isOpened() 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(PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIIOString | |
| open(const PIString &string) | PIIOString | |
| PIIODevice::open() | PIIODevice | inline |
| PIIODevice::open(const DeviceMode &_mode) | PIIODevice | inline |
| PIIODevice::open(const PIString &_path, const DeviceMode &_mode) | PIIODevice | inline |
| openDevice() | PIIOString | protectedvirtual |
| opened() | PIIODevice | |
| 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 | |
| PIIODevice() | PIIODevice | |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | |
| PIIODEVICE | PIIODevice | related |
| PIIOString(PIString *string=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIIOString | |
| PIIOString(const PIString &string) | PIIOString | |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | |
| 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 enum name | PIThread | |
| priority() const | PIThread | inline |
| 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) | PIIOString | virtual |
| PIIODevice::read(int max_size) | PIIODevice | inline |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| readForTime(double timeout_ms) | PIIODevice | |
| readLine() | PIIOString | |
| ReadOnly enum value | PIIODevice | |
| ReadWrite enum value | PIIODevice | |
| REGISTER_DEVICE | PIIODevice | related |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| seek(llong position) | PIIOString | inline |
| seekToBegin() | PIIOString | inline |
| seekToEnd() | PIIOString | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setMode(DeviceMode m) | PIIODevice | inline |
| setName(const PIString &name) | PIObject | inline |
| 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 | |
| PIThread::start(ThreadFunc func, int timer_delay) | PIThread | inline |
| 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 |
| string() const | PIIOString | inline |
| superClassName() const | PIObject | inlinevirtual |
| threadedRead(uchar *readed, int size) | PIIODevice | inlineprotectedvirtual |
| threadedReadBuffer() const | PIIODevice | inline |
| threadedReadBufferSize | PIIODevice | |
| threadedReadBufferSize() const | PIIODevice | inline |
| threadedReadData() const | PIIODevice | inline |
| threadedReadEvent(uchar *readed, int size) | PIIODevice | |
| threadedWriteEvent(ullong id, int written_size) | PIIODevice | |
| 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) | PIIOString | virtual |
| PIIODevice::write(const PIByteArray &data) | PIIODevice | inline |
| WriteOnly enum value | PIIODevice | |
| writeString(const PIString &string) | PIIOString | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
PIIODevice wrapper around PIString. + More...
+
+Public Member Functions | |
| + | PIIOString (PIString *string=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) |
| Contructs PIIOString with "string" content and "mode" open mode. | |
| + | PIIOString (const PIString &string) |
| Contructs PIIOString with "string" content only for read. | |
| +PIString * | string () const |
| Returns content. | |
| +void | clear () |
| Clear content string. | |
| +bool | open (PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) |
| Open "string" content with "mode" open mode. | |
| +bool | open (const PIString &string) |
| Open "string" 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. | |
| +PIString | readLine () |
| Read one text line and return it. | |
| +int | read (void *read_to, int max_size) |
| Reimplement this function to read from your device. | |
| +int | write (const void *data, int max_size) |
| Reimplement this function to write to your device. | |
| +int | writeString (const PIString &string) |
| Insert string "string" 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. | |
| +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. | |
| +PIByteArray | read (int max_size) |
| Read from device maximum "max_size" bytes and return them as PIByteArray. | |
| +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. | |
| +int | write (const PIByteArray &data) |
| Write "data" to device. | |
| +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. | |
| +virtual PIString | constructFullPath () const |
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | |
| +bool | open () |
| Open device. | |
| +bool | open (const PIString &_path) |
| Open device with path "path". | |
| +bool | open (const DeviceMode &_mode) |
| Open device with mode "mode". | |
| +bool | open (const PIString &_path, const DeviceMode &_mode) |
| Open device with path "path" and mode "mode". | |
| +bool | close () |
| Close device. | |
| +bool | initialize () |
| Initialize 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 succesfull 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 () |
| Return internal mutex. | |
| bool | start (int timer_delay) |
| Start thread. More... | |
| bool | start (ThreadFunc func, 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 * | superClassName () const |
| Returns object superclass 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. | |
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 void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
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... | |
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 | |
| +#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 | 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". | |
PIIODevice wrapper around PIString.
+This class sllow you to use PIString as PIIODevice and pass it to, e.g. PIConfig
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIScreen, including all inherited members.
+| className() const | PIObject | inlinevirtual |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| deleted() | PIObject | protected |
| disableExitCapture() | PIScreen | inline |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| emitter() const | PIObject | inlineprotected |
| enableExitCapture(int key= 'Q') | PIScreen | inline |
| 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 |
| exitCaptured() const | PIScreen | inline |
| exitKey() const | PIScreen | inline |
| findByName(const PIString &name) | PIObject | inlinestatic |
| HANDLER | PIObject | related |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| keyPressed(PIKbdListener::KeyEvent key, void *data) | PIScreen | |
| lock() | PIThread | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | 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 | |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | |
| PIOBJECT | PIObject | related |
| PIOBJECT_SUBCLASS | PIObject | related |
| PIScreen(bool startNow=true, PIKbdListener::KBFunc slot=0) | PIScreen | |
| 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 |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setName(const PIString &name) | PIObject | inline |
| setPriority(PIThread::Priority prior) | PIThread | |
| setProperty(const PIString &name, const PIVariant &value) | PIObject | inline |
| setSlot(ThreadFunc func) | PIThread | inline |
| start(bool wait) | PIScreen | inline |
| PIThread::start(int timer_delay) | PIThread | |
| PIThread::start(ThreadFunc func, int timer_delay) | PIThread | inline |
| started() | PIThread | |
| startOnce() | PIThread | |
| startOnce(ThreadFunc func) | PIThread | inline |
| stop(bool clear) | PIScreen | |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| terminate() | PIThread | |
| tileEvent(PIScreenTile *tile, PIScreenTypes::TileEvent e) | PIScreen | |
| unlock() | PIThread | inline |
| waitForFinish() | PIScreen | |
| PIThread::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 |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Console output class. + More...
+
+Public Member Functions | |
| + | PIScreen (bool startNow=true, PIKbdListener::KBFunc slot=0) |
| Constructs PIScreen with key handler "slot" and if "startNow" start it. | |
| +void | enableExitCapture (int key= 'Q') |
| Directly call function from PIKbdListener. | |
| +void | disableExitCapture () |
| Directly call function from PIKbdListener. | |
| +bool | exitCaptured () const |
| Directly call function from PIKbdListener. | |
| +int | exitKey () const |
| Directly call function from PIKbdListener. | |
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 () |
| Return internal mutex. | |
| bool | start (int timer_delay) |
| Start thread. More... | |
| bool | start (ThreadFunc func, 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 * | superClassName () const |
| Returns object superclass 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. | |
+Handlers | |
| +void | waitForFinish () |
| block until finished (exit key will be pressed) | |
| +void | start (bool wait) |
| Start console output and if "wait" block until finished (exit key will be pressed) | |
| +void | stop (bool clear) |
| Stop console output and if "clear" clear the screen. | |
+Events | |
| +void | keyPressed (PIKbdListener::KeyEvent key, void *data) |
| Raise on key "key" pressed, "data" is pointer to PIConsole object. | |
| +void | tileEvent (PIScreenTile *tile, PIScreenTypes::TileEvent e) |
| Raise on some event "e" from tile "tile". | |
+Additional Inherited Members | |
Public Types inherited from PIThread | |
| enum | Priority { + piLowerst, +piLow, +piNormal, +piHigh, + + piHighest + + } |
| Priority of thread. 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. | |
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 | |
| +#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 | 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". | |
Console output class.
+This class provides output to console with automatic alignment and update. It supports tabs, keyboard listening, formats and colors.
+PIScreen works with variable pointers. You should add your variables with functions addVariable() which receives label name, pointer to variable and optional column and format. Columns count is dynamically increased if new column used. E.g. if you add variable to empty tab to column 3, columns count will be increased to 3, but two firsts columns will be empty. Each column filled from top to bottom, but you can add just string with function addString() or add empty line with function addEmptyLine(). Layout scheme:
PIScreen should to be single in application. PIScreen aggregate PIKbdListener which grab keyboard and automatic switch tabs by theirs bind keys. If there is no tab binded to pressed key external function "slot" will be called
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIScreenDrawer, including all inherited members.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Console output class. + More...
+Console output class.
+This class provides output to console with automatic alignment and update. It supports tabs, keyboard listening, formats and colors.
+PIScreen works with variable pointers. You should add your variables with functions addVariable() which receives label name, pointer to variable and optional column and format. Columns count is dynamically increased if new column used. E.g. if you add variable to empty tab to column 3, columns count will be increased to 3, but two firsts columns will be empty. Each column filled from top to bottom, but you can add just string with function addString() or add empty line with function addEmptyLine(). Layout scheme:
PIScreen should to be single in application. PIScreen aggregate PIKbdListener which grab keyboard and automatic switch tabs by theirs bind keys. If there is no tab binded to pressed key external function "slot" will be called
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIScreenTile, including all inherited members.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Console output class. + More...
+
+Protected Member Functions | |
| +virtual void | sizeHint (int &w, int &h) const |
| Returns desired tile size in "w" and "h". | |
| +virtual void | resizeEvent (int w, int h) |
| Tile has been resized to "w"x"h". | |
| +virtual void | drawEvent (PIScreenDrawer *d) |
| Draw tile with drawer "d" in world-space coordinates. | |
| +virtual bool | keyEvent (PIKbdListener::KeyEvent key) |
| Return "true" if you process key. | |
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 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 * | superClassName () const |
| Returns object superclass 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. | |
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 | |
| +#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 | 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". | |
Console output class.
+This class provides output to console with automatic alignment and update. It supports tabs, keyboard listening, formats and colors.
+PIScreen works with variable pointers. You should add your variables with functions addVariable() which receives label name, pointer to variable and optional column and format. Columns count is dynamically increased if new column used. E.g. if you add variable to empty tab to column 3, columns count will be increased to 3, but two firsts columns will be empty. Each column filled from top to bottom, but you can add just string with function addString() or add empty line with function addEmptyLine(). Layout scheme:
PIScreen should to be single in application. PIScreen aggregate PIKbdListener which grab keyboard and automatic switch tabs by theirs bind keys. If there is no tab binded to pressed key external function "slot" will be called
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/_unsused | Includes file in src/io |
|---|---|
| pivariable.h | piconfig.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/_unsused | Includes file in src/math |
|---|---|
| pigeometry.h | pimath.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/code | Includes file in src/io |
|---|---|
| picodeparser.h | pifile.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/code | Includes file in src/math |
|---|---|
| picodeparser.h | pievaluator.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/console | Includes file in src/core |
|---|---|
| piscreendrawer.h | pistring.h |
| piscreentypes.h | pivariant.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/console | Includes file in src/io |
|---|---|
| piconsole.cpp | pidiagnostics.h |
| piconsole.cpp | pipeer.h |
| piconsole.cpp | piprotocol.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/console | Includes file in src/io |
|---|---|
| piconsole.cpp | pidiagnostics.h |
| piconsole.cpp | pipeer.h |
| piconsole.cpp | piprotocol.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/console | Includes file in src/thread |
|---|---|
| piconsole.h | pitimer.h |
| pikbdlistener.h | pithread.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/console | Includes file in src/thread |
|---|---|
| piconsole.h | pitimer.h |
| pikbdlistener.h | pithread.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/core | Includes file in src/console |
|---|---|
| picout.cpp | piconsole.h |
| piincludes.cpp | piconsole.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/core | Includes file in src/system |
|---|---|
| piinit.cpp | piprocess.h |
| piinit.cpp | pisignals.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/core | Includes file in src/thread |
|---|---|
| piobject.h | pimutex.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/io | Includes file in src/core |
|---|---|
| piiodevice.h | picollection.h |
| piiodevice.h | piinit.h |
| piiodevice.h | pivariant.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/io | Includes file in src/math |
|---|---|
| pibasetransfer.h | picrc.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/geo | Includes file in src/math |
|---|---|
| piellipsoidmodel.h | pimathbase.h |
| pigeoposition.h | pimathvector.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/io | Includes file in src/thread |
|---|---|
| pibasetransfer.h | pitimer.h |
| pidiagnostics.h | pitimer.h |
| piethernet.h | pitimer.h |
| piiodevice.h | pitimer.h |
| piprotocol.h | pitimer.h |
| piserial.h | pitimer.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/io | Includes file in src/thread |
|---|---|
| pibasetransfer.h | pitimer.h |
| pidiagnostics.h | pitimer.h |
| piethernet.h | pitimer.h |
| piiodevice.h | pitimer.h |
| piprotocol.h | pitimer.h |
| piserial.h | pitimer.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/math | Includes file in src/core |
|---|---|
| picrc.h | pistring.h |
| picrypt.h | pistring.h |
| pievaluator.h | pistring.h |
| pifixedpoint.h | picout.h |
| pimathbase.cpp | pitime.h |
| pimathbase.h | pibytearray.h |
| pimathbase.h | piinit.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/io |
|---|---|
| piprocess.h | pifile.h |
| pisysteminfo.cpp | pidir.h |
| pisystemtests.h | piconfig.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/thread |
|---|---|
| piprocess.h | pithread.h |
| pisystemmonitor.h | pithread.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/containers |
|---|---|
| pisignals.h | picontainers.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/core |
|---|---|
| pilibrary.h | pistring.h |
| pisysteminfo.cpp | pitime.h |
| pisysteminfo.h | pitime.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/io |
|---|---|
| piprocess.h | pifile.h |
| pisysteminfo.cpp | pidir.h |
| pisystemtests.h | piconfig.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/system | Includes file in src/thread |
|---|---|
| piprocess.h | pithread.h |
| pisystemmonitor.h | pithread.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
| File in src/thread | Includes file in src/core |
|---|---|
| pimutex.h | piinit.h |
| pithread.h | piinit.h |
| pithread.h | piobject.h |
| pitimer.h | pitime.h |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+

+Files | |
| file | piconsole.cpp |
| file | piconsole.h |
| Console output class. | |
| file | piconsolemodule.h |
| file | pikbdlistener.cpp |
| file | pikbdlistener.h |
| Keyboard console input listener. | |
| file | piscreen.cpp |
| file | piscreen.h |
| Console output class. | |
| file | piscreendrawer.cpp |
| file | piscreendrawer.h |
| Drawer for PIScreen. | |
| file | piscreentile.cpp |
| file | piscreentile.h |
| Basic PIScreen tile. | |
| file | piscreentiles.cpp |
| file | piscreentiles.h |
| Various tiles for PIScreen. | |
| file | piscreentypes.h |
| Types for PIScreen. | |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+

+Files | |
| file | piellipsoidmodel.cpp |
| file | piellipsoidmodel.h |
| Contains geo ellipsoid models. | |
| file | pigeoposition.cpp |
| file | pigeoposition.h |
| Class for geo position storage and conversions. | |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Base types and functions. +More...
++Macros | |
| +#define | PIP_VERSION ((PIP_VERSION_MAJOR << 16) | (PIP_VERSION_MINOR < 8) | PIP_VERSION_REVISION) |
| Version of PIP in hex - 0x##(Major)##(Minor)##(Revision) | |
| +#define | PIP_VERSION_MAJOR |
| Major value of PIP version. | |
| +#define | PIP_VERSION_MINOR |
| Minor value of PIP version. | |
| +#define | PIP_VERSION_REVISION |
| Revision value of PIP version. | |
| +#define | PIP_VERSION_SUFFIX |
| Suffix of PIP version. | |
| +#define | PIP_DEBUG |
| Macro is defined when compile-time debug is enabled. | |
| +#define | WINDOWS |
| Macro is defined when host is any Windows. | |
| +#define | QNX |
| Macro is defined when host is QNX or Blackberry. | |
| +#define | BLACKBERRY |
| Macro is defined when host is Blackberry. | |
| +#define | FREE_BSD |
| Macro is defined when host is FreeBSD. | |
| +#define | MAC_OS |
| Macro is defined when host is Mac OS. | |
| +#define | ANDROID |
| Macro is defined when host is Android. | |
| +#define | LINUX |
| Macro is defined when host is any Linux. | |
| +#define | CC_GCC |
| Macro is defined when compiler is GCC or MinGW. | |
| +#define | HAS_LOCALE |
| Macro is defined when PIP is decided that host is support language. | |
| +#define | CC_VC |
| Macro is defined when compiler is Visual Studio. | |
| +#define | CC_OTHER |
| Macro is defined when compiler is unknown. | |
| +#define | PIP_TIMER_RT |
| Macro is defined when PIP can use "rt" library for "PITimer::ThreadRT" timers implementation. | |
| +#define | PIP_CONTAINERS_STL |
| Define this macro to use STL implementation of containers, else PIP implementation will be used. | |
| +#define | FOREVER for (;;) |
| Macro used for infinite loop. | |
| +#define | FOREVER_WAIT FOREVER msleep(1); |
| Macro used for infinite wait. | |
| +#define | WAIT_FOREVER FOREVER msleep(1); |
| Macro used for infinite wait. | |
+Functions | |
| template<typename T > | |
| void | piSwap (T &f, T &s) |
| Templated function for swap two values. More... | |
| template<typename T > | |
| void | piSwapBinary (T &f, T &s) |
| Templated function for swap two values without "=". More... | |
| template<typename T > | |
| int | piRound (const T &v) |
| Templated function return round of float falue. More... | |
| template<typename T > | |
| int | piFloor (const T &v) |
| Templated function return floor of float falue. More... | |
| template<typename T > | |
| int | piCeil (const T &v) |
| Templated function return ceil of float falue. More... | |
| template<typename T > | |
| T | piAbs (const T &v) |
| Templated function return absolute of numeric falue. More... | |
| template<typename T > | |
| T | piMin (const T &f, const T &s) |
| Templated function return minimum of two values. More... | |
| template<typename T > | |
| T | piMin (const T &f, const T &s, const T &t) |
| Templated function return minimum of tree values. More... | |
| template<typename T > | |
| T | piMax (const T &f, const T &s) |
| Templated function return maximum of two values. More... | |
| template<typename T > | |
| T | piMax (const T &f, const T &s, const T &t) |
| Templated function return maximum of tree values. More... | |
| template<typename T > | |
| T | piClamp (const T &v, const T &min, const T &max) |
| Templated function return clamped value. More... | |
| +void | piLetobe (void *data, int size) |
| Function inverse byte order in memory block. | |
| +template<typename T > | |
| void | piLetobe (T *v) |
| Templated function that inverse byte order of value "v". | |
| template<typename T > | |
| T | piLetobe (const T &v) |
| Templated function that returns "v" with inversed byte order. More... | |
| ushort | letobe_s (ushort v) |
| Use piLetobe() instead of this function. More... | |
| uint | letobe_i (uint v) |
| Use piLetobe() instead of this function. More... | |
+Variables | |
| +bool | piDebug |
| global variable enabling output to piCout, default is true | |
| double | piMountInfoRefreshIntervalMs |
Base types and functions.
+This file implements first layer above the system and declares some basic useful functions
+
+
|
+ +inline | +
+
|
+ +inline | +
Templated function for swap two values without "=".
+Example:
+
+
|
+ +inline | +
+
|
+ +inline | +
Templated function return floor of float falue.
+Floor is the largest integer that is not greater than value
+There are some macros:
piFloorf for "float"piFloord for "double"Example:
+
+
|
+ +inline | +
+
|
+ +inline | +
Templated function return absolute of numeric falue.
+Absolute is the positive or equal 0 value
+There are some macros:
piAbss for "short"piAbsi for "int"piAbsl for "long"piAbsll for "llong"piAbsf for "float"piAbsd for "double"Example:
+
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Templated function return clamped value.
+Clamped is the not greater than "max" and not lesser than "min" value
+There are some macros:
piClamps for "short"piClampi for "int"piClampl for "long"piClampll for "llong"piClampf for "float"piClampd for "double"Example:
+
+
|
+ +inline | +
Templated function that returns "v" with inversed byte order.
+This function used to convert values between little and big endian
+There are some macros:
piLetobes for "ushort"piLetobei for "uint"piLetobel for "ulong"piLetobell for "ullong"Example:
+| ushort letobe_s | +( | +ushort | +v | ) | ++ |
Use piLetobe() instead of this function.
+ + +| uint letobe_i | +( | +uint | +v | ) | ++ |
Use piLetobe() instead of this function.
+ + +| double piMountInfoRefreshIntervalMs | +
global variable that set minimum real update interval for function PIInit::mountInfo(), default is 10000 ms
+ +|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Base class for reliable send and receive data in fixed packets with error correction, pause and resume. +More...
+Base class for reliable send and receive data in fixed packets with error correction, pause and resume.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Binary serializator. +More...
++Classes | |
| class | PIChunkStream |
| Class for binary serialization. More... | |
Binary serializator.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Universal output to console class. +More...
++Classes | |
| class | PICout |
| Class for formatted output similar std::cout. More... | |
+Namespaces | |
| PICoutManipulators | |
| Namespace contains enums controlled PICout. | |
+Macros | |
| +#define | piCout |
| Macro used for conditional (piDebug) output to PICout. | |
Universal output to console class.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Cryptographic class using lib Sodium. +More...
+Cryptographic class using lib Sodium.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Class for FFT, IFFT and Hilbert transformations. +More...
+Class for FFT, IFFT and Hilbert transformations.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
General flags class. +More...
++Classes | |
| class | PIFlags< Enum > |
| This class used as container for bit flags. More... | |
General flags class.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Class for geo position storage and conversions. +More...
+Class for geo position storage and conversions.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
PIIODevice wrapper around PIString. +More...
++Classes | |
| class | PIIOString |
| PIIODevice wrapper around PIString. More... | |
PIIODevice wrapper around PIString.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Basic mathematical functions and defines. +More...
+Basic mathematical functions and defines.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
PIMathMatrix. +More...
++Macros | |
| #define | PIMM_FOR(r, c) for (uint c = 0; c < Cols; ++c) { for (uint r = 0; r < Rows; ++r) { |
| Matrix templated. More... | |
| #define | PIMM_FOR(c, r) for (uint c = 0; c < cols_; ++c) { for (uint r = 0; r < rows_; ++r) { |
| Matrix templated. More... | |
+Functions | |
| +template<uint CR, uint Rows0, uint Cols1, typename Type > | |
| PIMathMatrixT< Rows0, Cols1, Type > | operator* (const PIMathMatrixT< Rows0, CR, Type > &fm, const PIMathMatrixT< CR, Cols1, Type > &sm) |
| Multiply matrices {Rows0 x CR} on {CR x Cols1}, result is {Rows0 x Cols1}. | |
| +template<uint Cols, uint Rows, typename Type > | |
| PIMathVectorT< Cols, Type > | operator* (const PIMathMatrixT< Rows, Cols, Type > &fm, const PIMathVectorT< Rows, Type > &sv) |
| Multiply matrix {Rows x Cols} on vector {Rows}, result is vector {Cols}. | |
| +template<typename Type > | |
| PIMathMatrix< Type > | operator* (const PIMathMatrix< Type > &fm, const PIMathMatrix< Type > &sm) |
| Multiply matrices {CR x Rows0} on {Cols1 x CR}, result is {Cols1 x Rows0}. | |
| +template<typename Type > | |
| PIMathVector< Type > | operator* (const PIMathMatrix< Type > &fm, const PIMathVector< Type > &sv) |
| Multiply matrix {Cols x Rows} on vector {Cols}, result is vector {Rows}. | |
PIMathMatrix.
+| #define PIMM_FOR | +( | ++ | r, | +
| + | + | + | c | +
| + | ) | +for (uint c = 0; c < Cols; ++c) { for (uint r = 0; r < Rows; ++r) { | +
Matrix templated.
+Matrix.
+ +| #define PIMM_FOR | +( | ++ | c, | +
| + | + | + | r | +
| + | ) | +for (uint c = 0; c < cols_; ++c) { for (uint r = 0; r < rows_; ++r) { | +
Matrix templated.
+Matrix.
+ +|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
PIMathSolver. +More...
++Classes | |
| struct | TransferFunction |
| Differential evaluations. More... | |
PIMathSolver.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
PIMathVector. +More...
++Macros | |
| #define | PIMV_FOR(v, s) for (uint v = s; v < Size; ++v) |
| Vector templated. More... | |
| #define | PIMV_FOR(v, s) for (uint v = s; v < size_; ++v) |
| Vector templated. More... | |
PIMathVector.
+| #define PIMV_FOR | +( | ++ | v, | +
| + | + | + | s | +
| + | ) | +for (uint v = s; v < Size; ++v) | +
Vector templated.
+Vector.
+ +| #define PIMV_FOR | +( | ++ | v, | +
| + | + | + | s | +
| + | ) | +for (uint v = s; v < size_; ++v) | +
Vector templated.
+Vector.
+ +|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
+Classes | |
| class | PIScreenDrawer |
| Console output class. More... | |
Drawer for PIScreen.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
+Classes | |
| class | PIScreenTile |
| Console output class. More... | |
Basic PIScreen tile.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Types for PIScreen.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Class for calculating math statistic in values array. +More...
+Class for calculating math statistic in values array.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIBinaryLog::BinLogIndex, including all inherited members.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Struct contains position, ID and timestamp of record in file. + More...
+Struct contains position, ID and timestamp of record in file.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIBinaryLog::BinLogInfo, including all inherited members.
+| operator<<(PICout s, const PIBinaryLog::BinLogInfo &bi) | PIBinaryLog::BinLogInfo | related |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Struct contains full information about Binary Log file and about all Records using map of BinLogRecordInfo. + More...
++Related Functions | |
(Note that these are not member functions.) + | |
| +PICout | operator<< (PICout s, const PIBinaryLog::BinLogInfo &bi) |
| Output operator to PICout. | |
Struct contains full information about Binary Log file and about all Records using map of BinLogRecordInfo.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIBinaryLog::BinLogRecordInfo, including all inherited members.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
Struct contains information about all records with same ID. + More...
+Struct contains information about all records with same ID.
+|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This is the complete list of members for PIKbdListener::KeyEvent, including all inherited members.
+| key | PIKbdListener::KeyEvent | |
| modifiers | PIKbdListener::KeyEvent |
|
+ PIP
+ 0.5.0_alpha
+
+ Platform-Independent Primitives
+ |
+
This struct contains information about pressed keyboard key. + More...
++Public Attributes | |
| +int | key |
| Pressed key. It can be simple char or special key (see PIKbdListener::SpecialKey) | |
| +KeyModifiers | modifiers |
| Active keyboard modifiers. It contains PIKbdListener::KeyModifier bitfields. | |
This struct contains information about pressed keyboard key.
+