diff --git a/CMakeLists.txt b/CMakeLists.txt index 9d2fc5c1..4c4fe507 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,6 @@ project(pip) cmake_minimum_required(VERSION 2.6) +#set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g3") include_directories(${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}) include(CheckFunctionExists) @@ -28,13 +29,13 @@ string(SUBSTRING ${VERSION_REVISION} 0 ${SL} VERSION_REVISION) set(VERSION "${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_REVISION}") set(SOVERSION ${VERSION}) message(STATUS "Building PIP version ${VERSION}${VERSION_SUFFIX}") -file(WRITE "src/pip_version_str.h" "#define __PIP_VERSION_STR__ \"${VERSION}${VERSION_SUFFIX}\"\n") +file(WRITE "src/pip_version_str.h" "// This file was generated by PIP CMake, don`t edit it!\n#define __PIP_VERSION_STR__ \"${VERSION}${VERSION_SUFFIX}\"\n") set(CMAKE_BUILD_TYPE "Release") set(LIBS) # Sources -set(PIP_FOLDERS "." "code" "containers" "core" "io" "math" "system" "thread") +set(PIP_FOLDERS "." "core" "containers" "thread" "system" "io" "console" "math" "code") include_directories("src") foreach(F ${PIP_FOLDERS}) include_directories("src/${F}") @@ -132,11 +133,11 @@ if (${WIN32}) else () set(${CMAKE_CXX_FLAGS} "-O2") if (DEFINED ENV{QNX_HOST}) - list(APPEND LIBS socket) + list(APPEND LIBS socket dl) set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -ftemplate-depth-32") add_library(pip STATIC ${CPPS}) else () - list(APPEND LIBS pthread) + list(APPEND LIBS pthread dl) if (NOT APPLE) list(APPEND LIBS rt) endif() @@ -152,7 +153,7 @@ set(CMAKE_C_FLAGS "${CMAKE_CXX_FLAGS}") # Test program #find_package(Qt4 REQUIRED) #include_directories(${QT_INCLUDES}) -add_executable(pip_test "main.cpp") +add_executable(pip_test "main.cpp" "ccm_kbd.cpp") target_link_libraries(pip_test pip)# ${QT_QTCORE_LIBRARY}) #target_link_libraries(pip_test pip) @@ -177,7 +178,7 @@ if (DEFINED LIB) #list(APPEND HDRS "pip.h.gch") install(FILES "FindPIP.cmake" DESTINATION ${CMAKE_ROOT}/Modules) else () - install(TARGETS pip DESTINATION bin) + install(TARGETS pip DESTINATION ${CMAKE_INSTALL_PREFIX}/bin) message(STATUS "Install to local \"bin\"") endif () @@ -185,3 +186,4 @@ endif () add_subdirectory("utils/system_test") add_subdirectory("utils/remote_console") add_subdirectory("utils/code_model_generator") +add_subdirectory("utils/system_daemon") diff --git a/Doxyfile b/Doxyfile index 2c6d54c5..4f0c0acb 100644 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.8 +# Doxyfile 1.8.9.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -38,7 +38,7 @@ PROJECT_NAME = PIP # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.4.1_alpha3 +PROJECT_NUMBER = 0.5.0_prealpha # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -46,10 +46,10 @@ PROJECT_NUMBER = 0.4.1_alpha3 PROJECT_BRIEF = "Platform-Independent Primitives" -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. PROJECT_LOGO = @@ -60,7 +60,7 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where @@ -93,14 +93,14 @@ ALLOW_UNICODE_NAMES = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the @@ -145,7 +145,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. @@ -215,9 +215,9 @@ MULTILINE_CPP_IS_BRIEF = NO INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO @@ -289,7 +289,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # -# Note For files without extension you can use no_extension as a placeholder. +# Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. @@ -308,8 +308,8 @@ MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES @@ -349,7 +349,7 @@ SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = NO # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. @@ -414,7 +414,7 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. @@ -424,35 +424,35 @@ LOOKUP_CACHE_SIZE = 0 EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local methods, +# This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are +# included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. @@ -477,21 +477,21 @@ HIDE_UNDOC_MEMBERS = YES # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be +# (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these +# documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. @@ -505,7 +505,7 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also +# names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. @@ -514,12 +514,19 @@ INTERNAL_DOCS = NO CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the +# their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -543,18 +550,18 @@ FORCE_LOCAL_INCLUDES = NO # documentation for inline members. # The default value is: YES. -INLINE_INFO = NO +INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. +# name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = NO # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that +# name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. @@ -599,27 +606,25 @@ SORT_BY_SCOPE_NAME = NO STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. # The default value is: YES. -GENERATE_TESTLIST = YES +GENERATE_TESTLIST = NO -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. @@ -644,8 +649,8 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO @@ -709,7 +714,7 @@ CITE_BIB_FILES = QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. @@ -717,7 +722,7 @@ QUIET = NO WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. @@ -734,8 +739,8 @@ WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO @@ -787,11 +792,39 @@ INPUT_ENCODING = UTF-8 # *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ *.cpp \ *.c++ \ + *.d \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ *.h \ + *.hh \ + *.hxx \ *.hpp \ *.h++ \ + *.idl \ + *.odl \ + *.cs \ + *.php \ + *.php3 \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -888,7 +921,7 @@ INPUT_FILTER = FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for +# INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. @@ -948,7 +981,7 @@ REFERENCED_BY_RELATION = NO REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. @@ -995,7 +1028,7 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO -# If the CLANG_ASSISTED_PARSING tag is set to YES, then doxygen will use the +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type @@ -1044,7 +1077,7 @@ IGNORE_PREFIX = # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1110,10 +1143,10 @@ HTML_STYLESHEET = # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. +# standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra stylesheet files is of importance (e.g. the last -# stylesheet in the list overrules the setting of the previous ones in the +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1130,7 +1163,7 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to +# will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 @@ -1173,7 +1206,7 @@ HTML_TIMESTAMP = YES # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_DYNAMIC_SECTIONS = YES +HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand @@ -1258,28 +1291,28 @@ GENERATE_HTMLHELP = NO CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1307,7 +1340,7 @@ GENERATE_QHP = YES # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = pip.qhp +QCH_FILE = pip.qch # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace @@ -1332,7 +1365,7 @@ QHP_VIRTUAL_FOLDER = doc # filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = PIP # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom @@ -1340,14 +1373,14 @@ QHP_CUST_FILTER_NAME = # filters). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = "PIP 0.4.1" # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = "PIP 0.4.1" # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the @@ -1393,7 +1426,7 @@ DISABLE_INDEX = NO # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has @@ -1421,7 +1454,7 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1450,7 +1483,7 @@ FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. @@ -1516,7 +1549,7 @@ MATHJAX_CODEFILE = # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. -SEARCHENGINE = YES +SEARCHENGINE = NO # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There @@ -1536,7 +1569,7 @@ SERVER_BASED_SEARCH = NO # external search engine pointed to by the SEARCHENGINE_URL option to obtain the # search results. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library # Xapian (see: http://xapian.org/). # @@ -1549,7 +1582,7 @@ EXTERNAL_SEARCH = NO # The SEARCHENGINE_URL should point to a search engine hosted by a web server # which will return the search results when EXTERNAL_SEARCH is enabled. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library # Xapian (see: http://xapian.org/). See the section "External Indexing and # Searching" for details. @@ -1587,7 +1620,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1618,7 +1651,7 @@ LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1653,9 +1686,9 @@ EXTRA_PACKAGES = # Note: Only use a user-defined header if you know what you are doing! The # following commands have a special meaning inside the header: $title, # $datetime, $date, $doxygenversion, $projectname, $projectnumber, -# $projectbrief, $projectlogo. Doxygen will replace $title with the empy string, -# for the replacement values of the other commands the user is refered to -# HTML_HEADER. +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = @@ -1671,6 +1704,17 @@ LATEX_HEADER = LATEX_FOOTER = +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands or @@ -1689,7 +1733,7 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a +# the PDF file directly from the LaTeX files. Set this option to YES, to get a # higher quality PDF documentation. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1734,7 +1778,7 @@ LATEX_BIB_STYLE = plain # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -1749,7 +1793,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1786,11 +1830,21 @@ RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1834,7 +1888,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -1848,7 +1902,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -1861,7 +1915,7 @@ XML_PROGRAMLISTING = YES # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -1875,7 +1929,7 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook -# If the DOCBOOK_PROGRAMLISTING tag is set to YES doxygen will include the +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the # program listings (including syntax highlighting and cross-referencing # information) to the DOCBOOK output. Note that enabling this will significantly # increase the size of the DOCBOOK output. @@ -1888,10 +1942,10 @@ DOCBOOK_PROGRAMLISTING = NO # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sf.net) file that captures the +# structure of the code including all documentation. Note that this feature is +# still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO @@ -1900,7 +1954,7 @@ GENERATE_AUTOGEN_DEF = NO # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -1908,7 +1962,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -1916,9 +1970,9 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely # formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the +# understand what is going on. On the other hand, if this tag is set to NO, the # size of the Perl module output will be much smaller and Perl will parse it # just the same. # The default value is: YES. @@ -1938,14 +1992,14 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. # The default value is: NO. @@ -1961,7 +2015,7 @@ MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES the includes files in the +# If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -2044,20 +2098,21 @@ TAGFILES = GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. # The default value is: NO. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. EXTERNAL_GROUPS = YES -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. @@ -2074,7 +2129,7 @@ PERL_PATH = /usr/bin/perl # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to # NO turns the diagrams off. Note that this option also works with HAVE_DOT # disabled, but it is recommended to install and use dot, since it yields more @@ -2099,7 +2154,7 @@ MSCGEN_PATH = DIA_PATH = -# If set to YES, the inheritance and collaboration graphs will hide inheritance +# If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. @@ -2172,7 +2227,7 @@ COLLABORATION_GRAPH = NO GROUP_GRAPHS = NO -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2280,7 +2335,7 @@ DOT_IMAGE_FORMAT = svg # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -INTERACTIVE_SVG = YES +INTERACTIVE_SVG = NO # The DOT_PATH tag can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. @@ -2312,10 +2367,14 @@ DIAFILE_DIRS = # PlantUML is not used or called during a preprocessing step. Doxygen will # generate a warning when it encounters a \startuml command in this case and # will not generate output for the diagram. -# This tag requires that the tag HAVE_DOT is set to YES. PLANTUML_JAR_PATH = +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, doxygen will truncate the graph, which is visualized @@ -2352,14 +2411,14 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support # this, this feature is disabled by default. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_MULTI_TARGETS = NO +DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated @@ -2369,7 +2428,7 @@ DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot # files that are used to generate the various graphs. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. diff --git a/FindPIP.cmake b/FindPIP.cmake index 78a1831d..d80c0c8c 100644 --- a/FindPIP.cmake +++ b/FindPIP.cmake @@ -7,7 +7,8 @@ else () find_library(PIP_LIBRARY pip /usr/lib/) if (${CMAKE_SYSTEM_NAME} STREQUAL "Linux") find_library(PTHREAD_LIBRARY pthread) - list(APPEND PIP_LIBRARY ${PTHREAD_LIBRARY}) + find_library(DL_LIBRARY dl) + list(APPEND PIP_LIBRARY ${PTHREAD_LIBRARY} ${DL_LIBRARY}) endif () set(PIP_INCLUDES /usr/include/pip) set(PIP_CMG /usr/bin/pip_cmg) @@ -29,9 +30,27 @@ if (PIP_FIND_VERSION VERSION_GREATER PIP_VERSION) endif () macro (pip_code_model SRC RESULT) + set(RESULT "") + set(OPTIONS "") + set(_IS_OPT false) + foreach (_A ${ARGN}) + #message(STATUS ${_A}) + if (_IS_OPT) + set (OPTIONS ${_A}) + else () + if ("${_A}" STREQUAL "OPTIONS") + set(_IS_OPT true) + else () + set (RESULT ${_A}) + endif () + endif () + endforeach() + #message(STATUS "src = ${SRC}") + #message(STATUS "result = ${RESULT}") + #message(STATUS "options = ${OPTIONS}") set(NEED_PARSE FALSE CACHE BOOL "NEED_PARSE" FORCE) if (DEFINED CACHE_CMG_FILES) - string(REPLACE " " ";" CMG_LIST_C ${CACHE_CMG_FILES}) + string(REPLACE " " ";" CMG_LIST_C "${CACHE_CMG_FILES}") foreach (CF ${CMG_LIST_C}) file (TIMESTAMP ${CF} ATIME) if (NOT TIME_${CF} STREQUAL ATIME) @@ -47,10 +66,11 @@ macro (pip_code_model SRC RESULT) endif () if (NEED_PARSE) message(STATUS "Creating code model based on \"${SRC}\", please wait ... ") - execute_process(COMMAND ${PIP_CMG} -qP -o ${PROJECT_NAME}_ccm -I${PIP_INCLUDES} ${SRC} OUTPUT_VARIABLE CMG_OUT) + #message(STATUS "exec \"-qP ${OPTIONS} -o ${PROJECT_NAME}_ccm -I${PIP_INCLUDES} ${SRC}\"") + execute_process(COMMAND ${PIP_CMG} -qP ${OPTIONS} -o ${PROJECT_NAME}_ccm -I${PIP_INCLUDES} ${SRC} OUTPUT_VARIABLE CMG_OUT) message(STATUS "Creating code model done, to use it include \"${PROJECT_NAME}_ccm.h\"") - string(REPLACE "\n" ";" CMG_LIST ${CMG_OUT}) - string(REPLACE "\n" " " CMG_LIST_S ${CMG_OUT}) + string(REPLACE "\n" ";" CMG_LIST "${CMG_OUT}") + string(REPLACE "\n" " " CMG_LIST_S "${CMG_OUT}") set(CACHE_CMG_FILES ${CMG_LIST_S} CACHE INTERNAL "CACHE_CMG_FILES" FORCE) foreach (CF ${CMG_LIST}) file (TIMESTAMP ${CF} ATIME) diff --git a/clean b/clean index 8d1dc6eb..c06a0da8 100644 --- a/clean +++ b/clean @@ -7,6 +7,11 @@ VERBOSE=1 make clean rm -rvf ./CMakeFiles rm -vf ./CMakeCache.txt ./Makefile ./cmake_install.cmake ./install_manifest.txt ./*~ ./*cxx ./moc_* ./*.o ./core cd ../../ +cd utils/system_daemon +VERBOSE=1 make clean +rm -rvf ./CMakeFiles +rm -vf ./CMakeCache.txt ./Makefile ./cmake_install.cmake ./install_manifest.txt ./*~ ./*cxx ./moc_* ./*.o ./core +cd ../../ cd utils/remote_console VERBOSE=1 make clean rm -rvf ./CMakeFiles diff --git a/clean.bat b/clean.bat index da83e33d..703d6aa1 100644 --- a/clean.bat +++ b/clean.bat @@ -20,9 +20,3 @@ rmdir /q /s CMakeFiles del /q /f CMakeCache.txt Makefile cmake_install.cmake install_manifest.txt *~ *cxx moc_* *.o *.exe *.a *.dll *.lib core cd .. cd .. -cd utils\system_daemon -del /q /f /s CMakeFiles -rmdir /q /s CMakeFiles -del /q /f CMakeCache.txt Makefile cmake_install.cmake install_manifest.txt *~ *cxx moc_* *.o *.exe *.a *.dll *.lib core -cd .. -cd .. \ No newline at end of file diff --git a/doc/doxygen_sqlite3.db b/doc/doxygen_sqlite3.db index 838dc510..9f528860 100644 Binary files a/doc/doxygen_sqlite3.db and b/doc/doxygen_sqlite3.db differ diff --git a/doc/html/annotated.html b/doc/html/annotated.html index 185aab61..f12dd270 100644 --- a/doc/html/annotated.html +++ b/doc/html/annotated.html @@ -3,23 +3,19 @@
- +| CPIBinaryLog | Class for read and write binary data to logfile, and playback this data in realtime |
| ▼CPIByteArray | Byte array |
| CRawData | Help struct to store/restore custom blocks of data to/from PIByteArray |
| CPIChar | Unicode char |
| CPICLI | Command-line arguments parser |
| CPICollection | Interface to discover element groups |
| ▼CPIConfig | Configuration file |
| CBranch | Branch is a list of entries of configuration file |
| CEntry | Entry of configuration file |
| CPIConnection | Complex Input/Output point |
| CPIConsole | Console output class |
| CPICout | Class for formatted output similar std::cout |
| CPIDiagnostics | Connection quality diagnostics |
| ▼CPIEthernet | Ethernet device |
| CInterface | Network interface descriptor |
| CInterfaceList | Array of Interface with some features |
| CPIEvaluator | This class provide mathematical evaluations of custom expression |
| CPIFile | Local file |
| CPIFlags | This class used as container for bit flags |
| CPIIODevice | Base class for input/output classes |
| CPIKbdListener | Keyboard console input listener |
| CPIMutex | Mutex |
| CPIObject | This is base class for any classes which use events -> handlers mechanism |
| CPIPacketExtractor | Packets extractor |
| CPIProcess | |
| CPIProtocol | |
| CPISerial | Serial device |
| CPISet | Set of any type |
| ▼CPIStateMachine | Base class for custom state machine |
| CRule | Rule of transition between states of machine |
| CState | State of machine |
| CPIString | String class |
| CPIStringList | Strings array class |
| CPISystemTime | System time |
| CPIThread | Thread class |
| CPITimeMeasurer | Time measurements |
| CPITimer | Timer |
| CPIVariant | Variant type |
| CPIVector | Dynamic array of any type |
| CTransferFunction | Differential evaluations |
| ▼CPIBinaryLog | Class for read and write binary data to logfile, and playback this data in realtime, or custom speed |
| CBinLogIndex | Struct contains position, ID and timestamp of record in file |
| CBinLogInfo | Struct contains full information about Binary Log file and about all Records using map of BinLogRecordInfo |
| CBinLogRecordInfo | Struct contains information about all records with same ID |
| ▼CPIByteArray | Byte array |
| CRawData | Help struct to store/restore custom blocks of data to/from PIByteArray |
| CPIChar | Unicode char |
| CPICLI | Command-line arguments parser |
| CPICollection | Interface to discover element groups |
| ▼CPIConfig | Configuration file |
| CBranch | Branch is a list of entries of configuration file |
| CEntry | Entry of configuration file |
| CPIConnection | Complex Input/Output point |
| CPIConsole | Console output class |
| CPICout | Class for formatted output similar std::cout |
| CPIDiagnostics | Connection quality diagnostics |
| CPIDir | Local directory |
| ▼CPIEthernet | Ethernet device |
| CInterface | Network interface descriptor |
| CInterfaceList | Array of Interface with some features |
| CPIEvaluator | This class provide mathematical evaluations of custom expression |
| CPIFile | Local file |
| CPIFlags | This class used as container for bit flags |
| CPIIODevice | Base class for input/output classes |
| CPIIOString | PIIODevice wrapper around PIString |
| ▼CPIKbdListener | Keyboard console input listener |
| CKeyEvent | This struct contains information about pressed keyboard key |
| CPIMutex | Mutex |
| CPIObject | This is base class for any classes which use events -> handlers mechanism |
| CPIPacketExtractor | Packets extractor |
| CPIProcess | |
| CPIProtocol | |
| CPIScreen | Console output class |
| CPISerial | Serial device |
| CPISet | Set of any type |
| ▼CPIStateMachine | Base class for custom state machine |
| CRule | Rule of transition between states of machine |
| CState | State of machine |
| CPIString | String class |
| CPIStringList | Strings array class |
| CPISystemTime | System time |
| CPIThread | Thread class |
| CPITimeMeasurer | Time measurements |
| CPITimer | Timer |
| CPIVariant | Variant type |
| CPIVector | Dynamic array of any type |
| CTransferFunction | Differential evaluations |
1.8.8
1.8.9.1
This is the complete list of members for PIBinaryLog, including all inherited members.
| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIIODevice | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| closeDevice() | PIBinaryLog | protectedvirtual |
| clearThreadedWriteQueue() | PIIODevice | inline |
| close() | PIIODevice | inline |
| closed() | PIIODevice | |
| closeDevice() | PIBinaryLog | protectedvirtual |
| 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) | PIBinaryLog | protectedvirtual |
| CONNECT | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| constructFullPath() const | PIBinaryLog | virtual |
| createFromFullPath(const PIString &full_path) | PIIODevice | static |
| createIndex() | PIBinaryLog | |
| createNewFile() | PIBinaryLog | |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| defaultID() const | PIBinaryLog | inline |
| DeviceMode enum name | PIIODevice | |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| EVENT_VHANDLER2 | PIObject | related |
| EVENT_VHANDLER3 | PIObject | related |
| EVENT_VHANDLER4 | PIObject | related |
| fileEnd() | PIBinaryLog | |
| fileError() | PIBinaryLog | |
| filePrefix() const | PIBinaryLog | inline |
| filterID | PIBinaryLog | |
| findByName(const PIString &name) | PIObject | inlinestatic |
| fullPathPrefix() const | PIBinaryLog | inlineprotectedvirtual |
| flush() | PIIODevice | inlinevirtual |
| fullPathPrefix() const | PIBinaryLog | inlineprotectedvirtual |
| getLogInfo(const PIString &path) | PIBinaryLog | static |
| HANDLER | PIObject | related |
| init() | PIIODevice | inlineprotectedvirtual |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| lock() | PIThread | inline |
| initialize() | PIIODevice | inline |
| isClosed() const | PIIODevice | inline |
| isEmpty() const | PIBinaryLog | inline |
| isEnd() const | PIBinaryLog | 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 |
| lastReadedID() const | PIBinaryLog | inline |
| lock() | PIThread | inline |
| logDir() const | PIBinaryLog | inline |
| logIndex() const | PIBinaryLog | inline |
| logInfo() const | PIBinaryLog | inline |
| logSize() const | PIBinaryLog | inline |
| mode() const | PIIODevice | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| openDevice() | PIBinaryLog | protectedvirtual |
| 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 | related |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | |
| newFile(const PIString &filename) | PIBinaryLog | |
| open() | PIIODevice | inline |
| open(const PIString &_path) | PIIODevice | inline |
| open(const DeviceMode &_mode) | PIIODevice | inline |
| open(const PIString &_path, const DeviceMode &_mode) | PIIODevice | inline |
| openDevice() | PIBinaryLog | 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 | related |
| PIIODevice() | PIIODevice | |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIOBJECT | PIObject | related |
| PIOBJECT_PARENT | 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 |
| PIObject(const PIString &name=PIString()) | PIObject | |
| 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 | |
| playDelay() const | PIBinaryLog | inline |
| playMode() const | PIBinaryLog | inline |
| PlayMode enum name | PIBinaryLog | |
| PlayRealTime enum value | PIBinaryLog | |
| playSpeed() const | PIBinaryLog | inline |
| PlayStaticDelay enum value | PIBinaryLog | |
| PlayVariableSpeed enum value | PIBinaryLog | |
| pos() const | PIBinaryLog | 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 |
| priority() const | PIThread | inline |
| properties() const | PIObject | inline |
| propertiesCount() const | PIObject | inline |
| property(const PIString &name) const | PIObject | inline |
| propertyChanged(const PIString &) | PIBinaryLog | protectedvirtual |
| rapidStart() const | PIBinaryLog | inline |
| read(void *read_to, int max_size) | PIBinaryLog | virtual |
| PIIODevice::read(int max_size) | PIIODevice | inline |
| readBinLog(int id=0) | PIBinaryLog | |
| readBinLog(int id, void *read_to, int max_size) | PIBinaryLog | |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| REGISTER_DEVICE | PIIODevice | related |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| readForTime(double timeout_ms) | PIIODevice | |
| ReadOnly enum value | PIIODevice | |
| ReadWrite enum value | PIIODevice | |
| REGISTER_DEVICE | PIIODevice | related |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| restart() | PIBinaryLog | |
| seek(const PISystemTime &time) | PIBinaryLog | |
| seekTo(int rindex) | PIBinaryLog | |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setDefaultID(int id) | PIBinaryLog | inline |
| setFilePrefix(const PIString &prefix) | PIBinaryLog | inline |
| setLogDir(const PIString &path) | PIBinaryLog | inline |
| setName(const PIString &name) | PIObject | inline |
| setPriority(PIThread::Priority prior) | PIThread | |
| setProperty(const PIString &name, const PIVariant &value) | PIObject | inline |
| setPath(const PIString &path) | PIIODevice | inline |
| setPlayDelay(const PISystemTime &delay) | PIBinaryLog | inline |
| setPlayMode(PlayMode mode) | PIBinaryLog | inline |
| setPlayRealTime() | PIBinaryLog | inline |
| setPlaySpeed(double speed) | PIBinaryLog | inline |
| setPriority(PIThread::Priority prior) | PIThread | |
| setProperty(const PIString &name, const PIVariant &value) | PIObject | inline |
| setRapidStart(bool enabled) | PIBinaryLog | inline |
| setReopenEnabled(bool yes=true) | PIIODevice | inline |
| setReopenTimeout(int msecs) | PIIODevice | inline |
| setSlot(ThreadFunc func) | PIThread | 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 |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| threadedRead(uchar *readed, int size) | PIBinaryLog | protectedvirtual |
| 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 |
| setSplitFileSize(llong size) | PIBinaryLog | inline |
| setSplitMode(SplitMode mode) | PIBinaryLog | inline |
| setSplitRecordCount(int count) | PIBinaryLog | inline |
| setSplitTime(const PISystemTime &time) | PIBinaryLog | inline |
| setThreadedReadBufferSize(int new_size) | PIIODevice | inline |
| setThreadedReadData(void *d) | PIIODevice | inline |
| setThreadedReadSlot(ReadRetFunc func) | PIIODevice | inline |
| SplitCount enum value | PIBinaryLog | |
| splitFileSize() const | PIBinaryLog | inline |
| splitMode() const | PIBinaryLog | inline |
| SplitMode enum name | PIBinaryLog | |
| SplitNone enum value | PIBinaryLog | |
| splitRecordCount() const | PIBinaryLog | inline |
| SplitSize enum value | PIBinaryLog | |
| SplitTime enum value | PIBinaryLog | |
| splitTime() const | PIBinaryLog | 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 |
| superClassName() const | PIObject | inlinevirtual |
| threadedRead(uchar *readed, int size) | PIBinaryLog | protectedvirtual |
| 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 size) | PIBinaryLog | inlinevirtual |
| PIIODevice::write(const PIByteArray &data) | PIIODevice | inline |
| writeBinLog(int id, PIByteArray data) | PIBinaryLog | inline |
| writeBinLog(int id, const void *data, int size) | PIBinaryLog | |
| writeCount() const | PIBinaryLog | inline |
| WriteOnly enum value | PIIODevice | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice |
1.8.8
1.8.9.1
Class for read and write binary data to logfile, and playback this data in realtime. +
Class for read and write binary data to logfile, and playback this data in realtime, or custom speed. More...
-
Inheritance diagram for PIBinaryLog:-Protected Member Functions | |
| -PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| -void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| -bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| -bool | closeDevice () |
| Reimplement to close device, inverse return value will be set to "opened_" variable. | |
| -bool | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". | |
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*. | |
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. | |
+Classes | |
| struct | BinLogIndex |
| Struct contains position, ID and timestamp of record in file. More... | |
| struct | BinLogInfo |
| Struct contains full information about Binary Log file and about all Records using map of BinLogRecordInfo. More... | |
| struct | BinLogRecordInfo |
| Struct contains information about all records with same ID. More... | |
-Additional Inherited Members | |
+Public Types | |
| enum | PlayMode { PlayRealTime, +PlayVariableSpeed, +PlayStaticDelay + } |
| Play modes for PIBinaryLog. More... | |
| enum | SplitMode { SplitNone, +SplitTime, +SplitSize, +SplitCount + } |
| Different split modes for writing PIBinaryLog, which can separate files by size, by time or by records count. More... | |
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, @@ -180,6 +136,355 @@ Additional Inherited Members |
| Priority of thread. More... | |
+Public Member Functions | |
| +PlayMode | playMode () const |
| Current PlayMode. | |
| +SplitMode | splitMode () const |
| Current SplitMode. | |
| +PIString | logDir () const |
| Current directory where billogs wiil be saved. | |
| +PIString | filePrefix () const |
| Returns current file prefix. | |
| +int | defaultID () const |
| Current LogDir, returns directory where billogs wiil be saved. | |
| +double | playSpeed () const |
| Returns current play speed. | |
| +PISystemTime | playDelay () const |
| Returns current play delay. | |
| +PISystemTime | splitTime () const |
| Returns current binlog file split time. | |
| +llong | splitFileSize () const |
| Returns current binlog file split size. | |
| +int | splitRecordCount () const |
| Returns current binlog file split records count. | |
| +bool | rapidStart () const |
| Returns if rapid start enabled. | |
| +void | setPlayMode (PlayMode mode) |
| Set PlayMode. | |
| +void | setSplitMode (SplitMode mode) |
| Set SplitMode. | |
| +void | setLogDir (const PIString &path) |
| Set path to directory where binlogs will be saved. | |
| +void | setFilePrefix (const PIString &prefix) |
| Set file prefix, used to. | |
| +void | setDefaultID (int id) |
| Set defaultID, used in write function. | |
| +void | setRapidStart (bool enabled) |
| If enabled BinLog ThreadedRead starts without delay for first record, i.e. first record will be readed immediately. | |
| void | setPlaySpeed (double speed) |
| void | setPlayDelay (const PISystemTime &delay) |
| +void | setPlayRealTime () |
| Set playMode to PlayRealTime. | |
| void | setSplitTime (const PISystemTime &time) |
| void | setSplitFileSize (llong size) |
| void | setSplitRecordCount (int count) |
| +int | writeBinLog (int id, PIByteArray data) |
| Write one record to BinLog file, with ID = id, id must be greather than 0. | |
| +int | writeBinLog (int id, const void *data, int size) |
| Write one record to BinLog file, with ID = id, id must be greather than 0. | |
| +int | writeCount () const |
| Returns count of writed records. | |
| +PIByteArray | readBinLog (int id=0) |
| Read one record from BinLog file, with ID = id, if id = 0 than any id will be readed. | |
| +int | readBinLog (int id, void *read_to, int max_size) |
| Read one record from BinLog file, with ID = id, if id = 0 than any id will be readed. | |
| +llong | logSize () const |
| Returns binary log file size. | |
| +bool | isEnd () const |
| Return true, if position at the end of BinLog file. | |
| +bool | isEmpty () const |
| Returns if BinLog file is empty. | |
| +int | lastReadedID () const |
| Returns if BinLog file is empty. | |
| int | read (void *read_to, int max_size) |
| Set position in file to reading/playing. More... | |
| +int | write (const void *data, int size) |
| Write one record to BinLog file, with ID = "defaultID". | |
| +void | restart () |
| Go to begin of BinLog file. | |
| +PIString | constructFullPath () const |
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | |
| +BinLogInfo | logInfo () const |
| Get binlog info BinLogInfo. | |
| +const PIVector< BinLogIndex > & | logIndex () const |
| Get binlog index BinLogIndex, need createIndex before getting index. | |
| bool | createIndex () |
| TODO: Think about index positions. More... | |
| +void | seekTo (int rindex) |
| Go to record #index. | |
| +bool | seek (const PISystemTime &time) |
| Go to nearest record. | |
| +int | pos () const |
| Get current record index (position record in file) | |
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. | |
| +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. | |
| +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) | Set object debug active. |
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const |
| Returns properties of the object. | |
| @@ -311,6 +615,16 @@ void | isPropertyExists (const PIString &name) const |
| Returns if property with name "name" exists. | |
+Static Public Member Functions | |
| static BinLogInfo | getLogInfo (const PIString &path) |
| TODO: Think about index positions. 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) | PIObject * | findByName (const PIString &name) |
| Returns PIObject* with name "name" or 0, if there is no object found. | |
+Public Attributes | |
| +PIVector< int > | filterID |
| Array of ID, that BinLog can read from binlog file, when use read function, or in ThreadedRead. | |
Public Attributes inherited from PIIODevice | |
| +bool | reopenEnabled |
| setReopenEnabled, default "true" | |
| +int | reopenTimeout |
| setReopenTimeout in ms, default 1000 | |
| +int | threadedReadBufferSize |
| setThreadedReadBufferSize in bytes, default 4096 | |
+Protected Member Functions | |
| +PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| +void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| +bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| +bool | closeDevice () |
| Reimplement to close device, inverse return value will be set to "opened_" variable. | |
| +void | propertyChanged (const PIString &) |
| Virtual function executes after property with name "name" has been changed. | |
| bool | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". More... | |
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*. | |
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. | |
+Handlers | |
| + | |
| +PIString | createNewFile () |
| Create new binlog file in logDir, if successful returns filename, else returns empty string. Filename is like filePrefix + "yyyy_MM_dd__hh_mm_ss.binlog". | |
+Events | |
| +void | fileEnd () |
| Raise on file end while reading. | |
| +void | fileError () |
| Raise on file creation error. | |
| +void | newFile (const PIString &filename) |
| Raise on new file created. | |
+Additional Inherited Members | |||
Related Functions inherited from PIIODevice | |||
| template<typename T > | |||
| T | readDeviceSetting (const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | ||
| #define | REGISTER_DEVICE(class) | ||
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |||
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |||
| #define | PIIODEVICE(class) | PIOBJECT(name) | |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | |||
| -#define | PIOBJECT_PARENT(name) | ||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | |||
| +#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() | 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) | 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) | 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) | 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) | 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) | |||
| @@ -375,23 +776,23 @@ static PIObject * | EVENT_HANDLER is synonym of EVENT_HANDLER0. | ||
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | |||
| @@ -403,19 +804,19 @@ static PIObject * | declare event "event" with name "name", void name(); | ||
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | |||
| @@ -423,27 +824,27 @@ static PIObject * | EVENT is synonym of EVENT0. | ||
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | |||
| @@ -451,23 +852,23 @@ static PIObject * | CONNECT is synonym of CONNECT0. | ||
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | |||
| @@ -475,23 +876,23 @@ static PIObject * | WEAK_CONNECT is synonym of WEAK_CONNECT0. | ||
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | |||
| @@ -504,22 +905,326 @@ static PIObject * | |||
Class for read and write binary data to logfile, and playback this data in realtime.
+Class for read and write binary data to logfile, and playback this data in realtime, or custom speed.
+TODO: Create static functions to split and join binlog files TODO: Create functions to insert and delete records
Binary Log is a file with simle header, where you can read and write some binary data. Any written data include special header with ID, size and timestamp. This header provides separation different messages from the one file by choosing different IDs. With filterID or special functions, like readBinLog() you can choose IDs what you want to read. With function writeBinLog() or setDefaultID() you can choose ID that mark you data. By default ID = 1, and filterID is empty, that mean you read any ID without filtering. ThreadedRead provide you playback data, with delay that you write data. You can choose realtime playbak or variable speed play back by set PlayMode.
+Binary Log is a file with simple header, where you can read and write some binary data. Any written data include special header with ID, size and timestamp. This header provides separation different messages from the one file by choosing different IDs. With filterID or special functions, like readBinLog() you can choose IDs what you want to read. With function writeBinLog() or setDefaultID() you can choose ID that mark you data. By default ID = 1, and filterID is empty, that mean you read any ID without filtering. ThreadedRead provide you playback data, with delay that you write data. You can choose different playbak modes by set PlayMode.
This class provide all functions of PIIODevice, such open(), close(), read() ,write(), and threaded read/write. function setLogDir() need to set directory for BinLog files function createNewFile() need to create new binlog file function restart() need start from the begining of binlog file
-This class provide all functions of PIIODevice, such open(), close(), read() ,write(), and threaded read/write. function setLogDir() need to set directory for BinLog files function createNewFile() need to create new binlog file function restart() need start from the begining of binlog file
+| enum PIBinaryLog::PlayMode | +
Play modes for PIBinaryLog.
+| enum PIBinaryLog::SplitMode | +
Different split modes for writing PIBinaryLog, which can separate files by size, by time or by records count.
+| Enumerator | |
|---|---|
| SplitNone |
+ Without separate, default mode + |
| SplitTime |
+ Separate files by record time + |
| SplitSize |
+ Separate files by size + |
| SplitCount |
+ Separate files by records count + |
+
|
+ +inline | +
Set play speed to "speed", default value is 1.0x Also this function set playMode to PlayVariableSpeed
+ +
+
|
+ +inline | +
Setting static delay between records, default value is 1 sec Also this function set playMode to PlayStaticDelay
+ +
+
|
+ +inline | +
Set binlog file split time Also this function set splitMode to SplitTime
+ +
+
|
+ +inline | +
Set binlog file split size Also this function set splitMode to SplitSize
+ +
+
|
+ +inline | +
Set binlog file split records count Also this function set splitMode to SplitCount
+ +
+
|
+ +virtual | +
Set position in file to reading/playing.
+Read one message from binlog file, with ID contains in "filterID" or any ID, if "filterID" is empty
+ +Reimplemented from PIIODevice.
+ +| bool PIBinaryLog::createIndex | +( | +) | ++ |
TODO: Think about index positions.
+Create index of current binlog file
+ +
+
|
+ +static | +
TODO: Think about index positions.
+Get binlog info and statistic
+ +
+
|
+ +protectedvirtual | +
Function executed when thread read some data, default implementation execute external slot "ret_func_".
+TODO: Sleep by steps (about 100ms)
+ +Reimplemented from PIIODevice.
+ +
1.8.8
1.8.9.1
1.8.8
1.8.9.1
Or you can descibe stream operator of your own type and store/restore vectors of your type:
For store/restore custom data blocks there is PIByteArray::RawData class. Stream operators of this class simply store/restore data block to/from byte array.
Stream operator of PIByteArray store byte array as vector, not simply append content of byte array. This operators useful to transmit custom data as PIByteArray packed into parent byte array, e.g. to form packet from PIByteArray. To append one byte array to another use funtion append().
1.8.8
1.8.9.1
1.8.8
1.8.9.1
Command-line arguments parser. More...
-
Inheritance diagram for PICLI:@@ -193,8 +153,7 @@ void | Set object debug active. | |||
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const | ||
| Returns properties of the object. | ||||
| @@ -247,28 +206,28 @@ virtual void | PIOBJECT(name) | |||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | ||||
| -#define | PIOBJECT_PARENT(name) | |||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | ||||
| +#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() | 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) | 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) | 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) | 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) | 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) | ||||
| @@ -276,23 +235,23 @@ virtual void | EVENT_HANDLER is synonym of EVENT_HANDLER0. | |||
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | ||||
| @@ -304,19 +263,19 @@ virtual void | declare event "event" with name "name", void name(); | |||
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | ||||
| @@ -324,27 +283,27 @@ virtual void | EVENT is synonym of EVENT0. | |||
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | ||||
| @@ -352,23 +311,23 @@ virtual void | CONNECT is synonym of CONNECT0. | |||
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | ||||
| @@ -376,23 +335,23 @@ virtual void | WEAK_CONNECT is synonym of WEAK_CONNECT0. | |||
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | ||||
|
@@ -417,10 +376,10 @@ Example
cli.addArgument("debug");
cli.addArgument("Value", "v", "value", true);
if (cli.hasArgument("console"))
- piCout << "console active";
+ piCout << "console active";
if (cli.hasArgument("debug"))
- piCout << "debug active";
-
+ piCout << "debug active";
+
return 0;
}
@@ -436,9 +395,9 @@ Example
| ||||
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
||||
1.8.8
1.8.9.1
1.8.8
1.8.9.1
(Note that these are not member functions.)
This class has only static functions so no need to create instance of the PICollection. This class provide macros to add some classes or existing objects to global collection and access to them from any place of the code.
1.8.8
1.8.9.1
| allLeaves() | PIConfig | inline |
| allTree() | PIConfig | inline |
| className() const | PIObject | inlinevirtual |
| clear() | PIConfig | inline |
| closeDevice() | PIFile | protectedvirtual |
| configureDevice(const void *e_main, const void *e_parent=0) | PIIODevice | inlineprotectedvirtual |
| configureFromFullPath(const PIString &full_path) | PIFile | protectedvirtual |
| 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 |
| delimiter() const | PIConfig | inline |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| emitter() const | PIObject | inlineprotected |
| clear() | PIConfig | |
| delimiter() const | PIConfig | inline |
| entriesCount() const | PIConfig | 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 |
| findByName(const PIString &name) | PIObject | inlinestatic |
| fullPathPrefix() const | PIFile | inlineprotectedvirtual |
| getValue(const PIString &vname, const PIString &def=PIString(), bool *exists=0) | PIConfig | |
| getValue(const PIString &vname, const char *def, bool *exists=0) | PIConfig | inline |
| getValue(const PIString &vname, const PIStringList &def, bool *exists=0) | PIConfig | inline |
| getValue(const PIString &vname, const float def, bool *exists=0) | PIConfig | inline |
| getValue(const PIString &vname, const double def, bool *exists=0) | PIConfig | inline |
| getValues(const PIString &vname) | PIConfig | |
| HANDLER | PIObject | related |
| init() | PIIODevice | inlineprotectedvirtual |
| isEntryExists(const PIString &name) const | PIConfig | inline |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| lock() | PIThread | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| openDevice() | PIFile | protectedvirtual |
| PIConfig(const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| 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 | related |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIOBJECT | PIObject | related |
| PIObject(const PIString &name=PIString()) | PIObject | |
| PIOBJECT_PARENT | 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 |
| readAll() | PIConfig | |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| REGISTER_DEVICE | PIIODevice | related |
| rootEntry() | PIConfig | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setDelimiter(const PIString &d) | PIConfig | inline |
| PIFile::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 |
| setValue(const PIString &name, const PIString &value, const PIString &type="s", bool write=true) | PIConfig | |
| setValue(const PIString &name, const PIStringList &value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const char *value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const bool value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const short value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const int value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const long value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const uchar value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const ushort value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const uint value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const ulong value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const float value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const double value, bool write=true) | PIConfig | 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 |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| threadedRead(uchar *readed, int size) | PIIODevice | inlineprotectedvirtual |
| 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 |
| open(const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| open(PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| PIConfig(const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| PIConfig(PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| PIConfig(PIIODevice *device=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig | |
| readAll() | PIConfig | |
| rootEntry() | PIConfig | inline |
| setDelimiter(const PIString &d) | PIConfig | inline |
| setValue(const PIString &name, const PIString &value, const PIString &type="s", bool write=true) | PIConfig | |
| setValue(const PIString &name, const PIStringList &value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const char *value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const bool value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const short value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const int value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const long value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const uchar value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const ushort value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const uint value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const ulong value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const float value, bool write=true) | PIConfig | inline |
| setValue(const PIString &name, const double value, bool write=true) | PIConfig | inline |
| writeAll() | PIConfig |
1.8.8
1.8.9.1
Configuration file. More...
-
Inheritance diagram for PIConfig:Classes | |||
Public Member Functions | |||
| - | PIConfig (const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIConfig (const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | |
| Contructs and read configuration file at path "path" in mode "mode". | |||
| + | PIConfig (PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | ||
| Contructs and read configuration string "string" in mode "mode". | |||
| + | PIConfig (PIIODevice *device=0, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | ||
| Contructs and read configuration from custom device "device" in mode "mode". | |||
| +bool | open (const PIString &path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | ||
| Read configuration file at path "path" in mode "mode". | |||
| +bool | open (PIString *string, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | ||
| Read configuration string "string" in mode "mode". | |||
| Entry & | getValue (const PIString &vname, const PIString &def=PIString(), bool *exists=0) | ||
| Returns top-level entry with name "vname", if doesn`t exists return entry with value "def" and set *exist to false. | |||
| Returns top-level entries with names with substrings "vname". | |||
| -void | setValue (const PIString &name, const PIString &value, const PIString &type="s", bool write=true) | setValue (const PIString &name, const PIString &value, const PIString &type="s", bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "type" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const PIStringList &value, bool write=true) | setValue (const PIString &name, const PIStringList &value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "l" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const char *value, bool write=true) | setValue (const PIString &name, const char *value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "s" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const bool value, bool write=true) | setValue (const PIString &name, const bool value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "b" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const short value, bool write=true) | setValue (const PIString &name, const short value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const int value, bool write=true) | setValue (const PIString &name, const int value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const long value, bool write=true) | setValue (const PIString &name, const long value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const uchar value, bool write=true) | setValue (const PIString &name, const uchar value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const ushort value, bool write=true) | setValue (const PIString &name, const ushort value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const uint value, bool write=true) | setValue (const PIString &name, const uint value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const ulong value, bool write=true) | setValue (const PIString &name, const ulong value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "n" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const float value, bool write=true) | setValue (const PIString &name, const float value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "f" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| -void | setValue (const PIString &name, const double value, bool write=true) | setValue (const PIString &name, const double value, bool write=true) | |
| Set top-level entry with name "name" value to "value", type to "f" and if "write" immediate write to file. Add new entry if there is no suitable exists. | |||
| @@ -258,7 +229,7 @@ int | Returns top-level entries count. | ||
| -bool | isEntryExists (const PIString &name) const | isEntryExists (const PIString &name) const | |
| Returns if top-level entry with name "name" exists. | |||
| @@ -271,15 +242,15 @@ bool | |||
| void | clear () | ||
| Remove all tree and file content. | |||
| Remove all tree and device content. | |||
| void | readAll () | ||
| Parse file and build internal tree. | |||
| Parse device and build internal tree. | |||
| void | writeAll () | ||
| Write all internal tree to file. | |||
| Write all internal tree to device. | |||
| const PIString & | delimiter () const | setDelimiter (const PIString &d) | |
| Set current tree delimiter. | |||
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. | |||
-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 PIFile | |
| -PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| -void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| -bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| -bool | closeDevice () |
| Reimplement to close device, inverse 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 | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". | |
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. | |
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_PARENT(name) |
| 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". | |
Configuration file.
@@ -676,12 +271,12 @@ SynopsisPIConfig supports also INI-style files with sections "[section]". In this case line with section name interpret as prefix to the next lines. For example, these configs are equal:
Each node of internal tree has type PIConfig::Entry. PIConfig has one root element rootEntry(). Any entry of configuration file is a child of this element.
@@ -691,9 +286,9 @@ Concepts
1.8.8
1.8.9.1
Branch is a list of entries of configuration file More...
-
Inheritance diagram for PIConfig::Branch:Branch is a list of entries of configuration file
@@ -131,9 +91,9 @@ $(document).ready(function(){initNavTree('class_p_i_config_1_1_branch.html','');
1.8.8
1.8.9.1
Returns full name, i.e. name as it looks in file.
-In case of default entry full name always is empty
In case of default entry full name always is empty
1.8.8
1.8.9.1
Complex Input/Output point. More...
-
Inheritance diagram for PIConnection:@@ -141,14 +101,21 @@ Public Member Functions | PIConnection (const PIString &config, const PIString &name) |
| Constructs connection and configure it from config file "config" from section "name". | |
| + | PIConnection (PIString *string, const PIString &name) |
| Constructs connection and configure it from config content "string" from section "name". | |
| bool | configureFromConfig (const PIString &config, const PIString &name) |
| Configure connection from config file "config" from section "name". Returns if configuration was successful. More... | |
| bool | configureFromString (PIString *string, const PIString &name) |
| Configure connection from config content "string" from section "name". Returns if configuration was successful. More... | |
| PIString | makeConfig () const |
| Returns config file section of current connection configuration. | |
| PIIODevice * | addDevice (const PIString &full_path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite, bool start=false) |
| PIIODevice * | addDevice (const PIString &full_path, PIIODevice::DeviceMode mode=PIIODevice::ReadWrite, bool start=false) |
| Add device with full path "full_path", open mode "mode" to Device pool and connection. More... | |
| bool | removeDevice (const PIString &full_path) |
| void | removeAllDevices () |
| Remove all device from connection. More... | |
| -PIIODevice * | device (const PIString &full_path) const |
| Returns device with full path "full_path" or null if there is no such device. | |
| +PIIODevice * | deviceByFullPath (const PIString &full_path) const |
| Returns device with full path "full_path" or null if there is no such device. | |
| +PIIODevice * | deviceByName (const PIString &name) const |
| Returns device with name "name" or null if there is no such device. | |
| PIVector< PIIODevice * > | boundedDevices () const |
| Returns all devices bounded to this connection. | Remove from connection all channels. |
|
-PIVector< PIPair< PIString, -PIString > > | channels () const | channels () const |
| Returns all channels of this connection as full pathes or filter names pair array (from, to) | |
| void | addSender (const PIString &name, const PIString &full_path, float frequency, bool start=false) |
| PIDiagnostics * | diagnostic (const PIString &full_path_name) const |
| Returns PIDiagnostics * assosiated with device with full path "full_path_name" or filter "full_path_name". | |
| Returns PIDiagnostics * assosiated with device with full path "full_path_name", name "full_path_name" or filter "full_path_name". | |
| PIDiagnostics * | diagnostic (const PIIODevice *dev) const |
| Returns PIDiagnostics * assosiated with device or filter "dev". | |
| -int | write (const PIString &full_path, const PIByteArray &data) |
| Write data "data" to device with full path "full_path" and returns result of write() function of device. | |
| -int | write (const PIIODevice *dev, const PIByteArray &data) |
| Write data "data" to device "dev" and returns result of write() function of device. | |
| +int | writeByFullPath (const PIString &full_path, const PIByteArray &data) |
| Write data "data" to device with full path "full_path" and returns result of write() function of device. | |
| +int | writeByName (const PIString &name, const PIByteArray &data) |
| Write data "data" to device with name "name" and returns result of write() function of device. | |
| +int | write (PIIODevice *dev, const PIByteArray &data) |
| Write data "data" to device "dev" and returns result of write() function of device. | |
Public Member Functions inherited from PIObject | |
| PIObject (const PIString &name=PIString()) | Set object debug active. |
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const |
| Returns properties of the object. | |
| @@ -416,6 +389,14 @@ static PIVector< PIVector< PIIODevice * > | allDevices () |
| Returns all devices in Device pool. | |
| +static bool | setFakeMode (bool yes) |
| Set Device pool fake mode to "yes" and returns previous mode. | |
| +static bool | isFakeMode () |
| Returns if Device pool works in fake mode. | |
Static Public Member Functions inherited from PIObject | |
| static void | piDisconnect (PIObject *src, const PIString &sig) | packetReceivedEvent (const PIString &from, const PIByteArray &data) |
| Raise on packet received from filter with name "from". | |
| +void | qualityChanged (const PIIODevice *dev, PIDiagnostics::Quality new_quality, PIDiagnostics::Quality old_quality) |
| Raise on diagnostic quality of device "device" changed from "old_quality" to "new_quality". | |
Additional Inherited Members | PIOBJECT(name) | |||||||||||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | ||||||||||||
| -#define | PIOBJECT_PARENT(name) | |||||||||||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | ||||||||||||
| +#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() | 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) | 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) | 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) | 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) | 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) | ||||||||||||
| @@ -517,23 +502,23 @@ Additional Inherited Members | ||||||||||||
| EVENT_HANDLER is synonym of EVENT_HANDLER0. | ||||||||||||
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | ||||||||||||
| @@ -545,19 +530,19 @@ Additional Inherited Members | ||||||||||||
| declare event "event" with name "name", void name(); | ||||||||||||
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | ||||||||||||
| @@ -565,27 +550,27 @@ Additional Inherited Members | ||||||||||||
| EVENT is synonym of EVENT0. | ||||||||||||
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | ||||||||||||
| @@ -593,23 +578,23 @@ Additional Inherited Members | ||||||||||||
| CONNECT is synonym of CONNECT0. | ||||||||||||
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | ||||||||||||
| @@ -617,23 +602,23 @@ Additional Inherited Members | ||||||||||||
| WEAK_CONNECT is synonym of WEAK_CONNECT0. | ||||||||||||
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | ||||||||||||
@@ -662,7 +647,7 @@ Filters
Diagnostics-PIConnection create PIDiagnostics for each device or filter. You can access to these objects with functions diagnostic(). +PIConnection create PIDiagnostics for each device or filter. You can access to these objects with functions diagnostic(). SendersPIConnection can send data to devices with named timers ("senders"). You can create sender or add device to sender with function addSender(). Each sender has internal timer and every tick execute virtual function senderData(). Returns value of this function sended to bounded devices. You can assign fixed send data to sender with function setSenderFixedData(). In this case sender will NOT execute senderData(), but send assigned data.
@@ -702,6 +687,35 @@ Configuration
+
+
+Configure connection from config file "config" from section "name". Returns if configuration was successful. Warning: all devices, filters and channels removed before configure! +
+
@@ -717,8 +731,8 @@ Configuration
+
+
+
Configure connection from config content "string" from section "name". Returns if configuration was successful. +Warning: all devices, filters and channels removed before configure! + | ||||||||||||
| - | PIIODevice::DeviceMode | -mode = PIIODevice::ReadWrite, |
+ PIIODevice::DeviceMode | +mode = PIIODevice::ReadWrite, |
||||||||
| @@ -956,7 +970,7 @@ Configuration | ||||||||||||
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
||||||||||||
This is the complete list of members for PIConsole, including all inherited members.
| addBitVariable(const PIString &name, const void *ptr, int fromBit, int bitsCount, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addBitVariable(const PIString &name, const void *ptr, int fromBit, int bitsCount, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addCustomStatus(const PIString &str) | PIConsole | inline |
| addEmptyLine(int column=1, uint count=1) | PIConsole | |
| addString(const PIString &name, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addString(const PIString &name, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addTab(const PIString &name, char bind_key=0) | PIConsole | |
| addVariable(const PIString &name, const PIString *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const char *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const bool *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const short *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const int *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const long *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const llong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const uchar *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ushort *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const uint *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ulong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ullong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const float *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const double *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PISystemTime *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PIProtocol *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PIDiagnostics *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PIString *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const char *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const bool *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const short *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const int *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const long *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const llong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const uchar *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ushort *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const uint *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ulong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const ullong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const float *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const double *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PISystemTime *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PIProtocol *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| addVariable(const PIString &name, const PIDiagnostics *ptr, int column=1, FormatFlags format=PIConsole::Normal) | PIConsole | |
| Alignment enum name | PIConsole | |
| BackBlack enum value | PIConsole | |
| BackBlue enum value | PIConsole | |
| Bold enum value | PIConsole | |
| className() const | PIObject | inlinevirtual |
| clearCustomStatus() | PIConsole | inline |
| clearTab(uint index) | PIConsole | |
| clearTab(const PIString &name) | PIConsole | |
| clearTabs(bool clearScreen=true) | PIConsole | inline |
| clearVariables(bool clearScreen) | PIConsole | inline |
| clearVariables(bool clearScreen) | PIConsole | |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| currentTab() const | PIConsole | inline |
| Cyan enum value | PIConsole | |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| Dec enum value | PIConsole | |
| defaultAlignment() const | PIConsole | inline |
| disableExitCapture() | PIConsole | inline |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| emitter() const | PIObject | inlineprotected |
| enableExitCapture(char key= 'Q') | PIConsole | inline |
| end() | PIThread | inlineprotectedvirtual |
| 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 | PIConsole | inline |
| exitKey() const | PIConsole | inline |
| findByName(const PIString &name) | PIObject | inlinestatic |
| Format enum name | PIConsole | |
| Green enum value | PIConsole | |
| HANDLER | PIObject | related |
| Hex enum value | PIConsole | |
| Inverse enum value | PIConsole | |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| keyPressed(char key, void *data) | PIConsole | |
| Left enum value | PIConsole | |
| lock() | PIThread | inline |
| Magenta enum value | PIConsole | |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| Normal enum value | PIConsole | |
| Nothing enum value | PIConsole | |
| Oct enum value | PIConsole | |
| PIConsole(bool startNow=true, KBFunc slot=0) | PIConsole | |
| 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_PARENT | 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 |
| currentTabIndex() const | PIConsole | inline |
| Cyan enum value | PIConsole | |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| Dec enum value | PIConsole | |
| defaultAlignment() const | PIConsole | inline |
| disableExitCapture() | PIConsole | inline |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| emitter() const | PIObject | inlineprotected |
| enableExitCapture(char key= 'Q') | PIConsole | inline |
| end() | PIThread | inlineprotectedvirtual |
| 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 | PIConsole | inline |
| exitKey() const | PIConsole | inline |
| findByName(const PIString &name) | PIObject | inlinestatic |
| Format enum name | PIConsole | |
| Green enum value | PIConsole | |
| HANDLER | PIObject | related |
| Hex enum value | PIConsole | |
| Inverse enum value | PIConsole | |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| keyPressed(PIKbdListener::KeyEvent key, void *data) | PIConsole | |
| Left enum value | PIConsole | |
| lock() | PIThread | inline |
| Magenta enum value | PIConsole | |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| Normal enum value | PIConsole | |
| Nothing enum value | PIConsole | |
| Oct enum value | PIConsole | |
| PIConsole(bool startNow=true, PIKbdListener::KBFunc slot=0) | PIConsole | |
| 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 |
| 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 | |
| properties() const | PIObject | inline |
| propertiesCount() const | PIObject | inline |
| property(const PIString &name) const | PIObject | inline |
| propertyChanged(const PIString &name) | PIObject | inlineprotectedvirtual |
| Red enum value | PIConsole | |
| removeTab(uint index) | PIConsole | |
| removeTab(const PIString &name) | PIConsole | |
| Right enum value | PIConsole | |
| Scientific enum value | PIConsole | |
| setColumnAlignment(int col, Alignment align) | PIConsole | inline |
| setColumnAlignmentToAll(Alignment align) | PIConsole | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setDefaultAlignment(Alignment align) | PIConsole | 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 |
| setTab(uint index) | PIConsole | |
| setTab(const PIString &name) | PIConsole | |
| setTabBindKey(uint index, char bind_key) | PIConsole | |
| setTabBindKey(const PIString &name, char bind_key) | PIConsole | |
| start(bool wait) | PIConsole | 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) | PIConsole | |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| SystemTimeSeconds enum value | PIConsole | |
| SystemTimeSplit enum value | PIConsole | |
| tabsCount() const | PIConsole | inline |
| terminate() | PIThread | |
| Underline enum value | PIConsole | |
| unlock() | PIThread | inline |
| waitForFinish() | PIConsole | inline |
| 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 |
| White enum value | PIConsole | |
| Yellow enum value | PIConsole | |
| 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 |
| Red enum value | PIConsole | |
| removeTab(uint index) | PIConsole | |
| removeTab(const PIString &name) | PIConsole | |
| Right enum value | PIConsole | |
| Scientific enum value | PIConsole | |
| setColumnAlignment(int col, Alignment align) | PIConsole | inline |
| setColumnAlignmentToAll(Alignment align) | PIConsole | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setDefaultAlignment(Alignment align) | PIConsole | 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 |
| setTab(uint index) | PIConsole | |
| setTab(const PIString &name) | PIConsole | |
| setTabBindKey(uint index, char bind_key) | PIConsole | |
| setTabBindKey(const PIString &name, char bind_key) | PIConsole | |
| start(bool wait) | PIConsole | 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) | PIConsole | |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| SystemTimeSeconds enum value | PIConsole | |
| SystemTimeSplit enum value | PIConsole | |
| tabsCount() const | PIConsole | inline |
| terminate() | PIThread | |
| Underline enum value | PIConsole | |
| unlock() | PIThread | inline |
| waitForFinish() | PIConsole | inline |
| 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 |
| White enum value | PIConsole | |
| Yellow enum value | PIConsole |
1.8.8
1.8.9.1
Console output class. More...
-
Inheritance diagram for PIConsole:@@ -188,84 +148,84 @@ Public Types |
Public Member Functions | |||||||||||||||
| - | PIConsole (bool startNow=true, KBFunc slot=0) | ||||||||||||||
| Constructs PIConsole with key handler "slot" and if "startNow" start it. | |||||||||||||||
| -void | addString (const PIString &name, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" string "name" with format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const PIString *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const char *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const bool *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const short *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const int *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const long *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const llong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const uchar *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const ushort *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const uint *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const ulong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const ullong *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const float *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const double *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| -void | addVariable (const PIString &name, const PISystemTime *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| void | addVariable (const PIString &name, const PIProtocol *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". More... | |||||||||||||||
| void | addVariable (const PIString &name, const PIDiagnostics *ptr, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". More... | |||||||||||||||
| -void | addBitVariable (const PIString &name, const void *ptr, int fromBit, int bitsCount, int column=1, PIFlags< PIConsole::Format > format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" bits field with label "name", pointer "ptr" and format "format". | |||||||||||||||
| + | PIConsole (bool startNow=true, PIKbdListener::KBFunc slot=0) | ||||||||||||||
| Constructs PIConsole with key handler "slot" and if "startNow" start it. | |||||||||||||||
| +void | addString (const PIString &name, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" string "name" with format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const PIString *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const char *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const bool *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const short *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const int *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const long *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const llong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const uchar *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const ushort *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const uint *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const ulong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const ullong *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const float *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const double *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| +void | addVariable (const PIString &name, const PISystemTime *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". | |||||||||||||||
| void | addVariable (const PIString &name, const PIProtocol *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". More... | |||||||||||||||
| void | addVariable (const PIString &name, const PIDiagnostics *ptr, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" variable with label "name", pointer "ptr" and format "format". More... | |||||||||||||||
| +void | addBitVariable (const PIString &name, const void *ptr, int fromBit, int bitsCount, int column=1, FormatFlags format=PIConsole::Normal) | ||||||||||||||
| Add to current tab to column "column" bits field with label "name", pointer "ptr" and format "format". | |||||||||||||||
| void | addEmptyLine (int column=1, uint count=1) | ||||||||||||||
| Add to current tab to column "column" "count" empty lines. | PIString | currentTab () const | |||||||||||||
| Returns current tab name. | |||||||||||||||
| +int | currentTabIndex () const | ||||||||||||||
| Returns current tab index. | |||||||||||||||
| int | addTab (const PIString &name, char bind_key=0) | ||||||||||||||
| Add new tab with name "name", bind key "bind_key" and returns this tab index. | removeTab (const PIString &name) | ||||||||||||||
| Remove tab with name "name". | |||||||||||||||
| +void | clearTab (uint index) | ||||||||||||||
| Clear content of tab with index "index". | |||||||||||||||
| +void | clearTab (const PIString &name) | ||||||||||||||
| Clear content of tab with name "name". | |||||||||||||||
| bool | setTab (uint index) | ||||||||||||||
| Set current tab to tab with index "index", returns if tab exists. | Set object debug active. |
||||||||||||||
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const | |||||||||||||
| Returns properties of the object. | |||||||||||||||
| @@ -503,10 +474,10 @@ void |
Events
-void | keyPressed (char key, void *data) | | Raise on key "key" pressed, "data" is pointer to PIConsole object. | |
+void | keyPressed (PIKbdListener::KeyEvent key, void *data) | | Raise on key "key" pressed, "data" is pointer to PIConsole object. | | | ||||
Additional Inherited Members | PIOBJECT(name) | ||||||||||||||||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | |||||||||||||||||
| -#define | PIOBJECT_PARENT(name) | ||||||||||||||||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | |||||||||||||||||
| +#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() | 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) | 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) | 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) | 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) | 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) | |||||||||||||||||
| @@ -575,23 +546,23 @@ virtual void | EVENT_HANDLER is synonym of EVENT_HANDLER0. | ||||||||||||||||
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | |||||||||||||||||
| @@ -603,19 +574,19 @@ virtual void | declare event "event" with name "name", void name(); | ||||||||||||||||
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | |||||||||||||||||
| @@ -623,27 +594,27 @@ virtual void | EVENT is synonym of EVENT0. | ||||||||||||||||
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | |||||||||||||||||
| @@ -651,23 +622,23 @@ virtual void | CONNECT is synonym of CONNECT0. | ||||||||||||||||
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | |||||||||||||||||
| @@ -675,23 +646,23 @@ virtual void | WEAK_CONNECT is synonym of WEAK_CONNECT0. | ||||||||||||||||
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | |||||||||||||||||
|
@@ -710,7 +681,7 @@ Synopsis
This class provides output to console with automatic alignment and update. It supports tabs, keyboard listening, formats and colors. Layout-PIConsole 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:
+
PIConsole 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: @@ -843,7 +814,7 @@ Keyboard usageMember Function Documentation- +
@@ -91,20 +68,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
$(document).ready(function(){initNavTree('class_p_i_cout.html','');});
-
-
- All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
-
-
-
-
-
-
PICout Member List
1.8.9.1
|
@@ -39,10 +35,7 @@
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
@@ -91,20 +68,6 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
$(document).ready(function(){initNavTree('class_p_i_cout.html','');});
-
-
- All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
-
-
-
-
-
-
Public Member Functions |
@@ -121,7 +84,7 @@ $(document).ready(function(){initNavTree('class_p_i_cout.html','');});
Public Member Functions
- | PICout (PIFlags< PICoutControl > controls=AddSpaces|AddNewLine) | | PICout (PIFlags< PICoutControl > controls=AddSpaces|AddNewLine) | |||||||||||||
| Default constructor with default features (AddSpaces and AddNewLine) | |||||||||||||||||
| @@ -193,22 +156,22 @@ Public Member Functions | |||||||||||||||||
| Output operator for PIObject and ancestors. | |||||||||||||||||
| -PICout | operator<< (const PICoutSpecialChar v) | operator<< (const PICoutSpecialChar v) | |||||||||||||||
| Output operator for PICoutSpecialChar values. | |||||||||||||||||
| -PICout | operator<< (const PIFlags< PICoutFormat > v) | operator<< (const PIFlags< PICoutFormat > v) | |||||||||||||||
| Output operator for PIFlags<PICoutFormat> values. | |||||||||||||||||
| -PICout | operator<< (const PICoutFormat v) | operator<< (const PICoutFormat v) | |||||||||||||||
| Output operator for PICoutFormat values. | |||||||||||||||||
| PICout | operator<< (const PICoutAction v) | ||||||||||||||||
| PICout | operator<< (const PICoutAction v) | ||||||||||||||||
| Do some action. More... | |||||||||||||||||
| -PICout & | setControl (PICoutControl c, bool on=true) | setControl (PICoutControl c, bool on=true) | |||||||||||||||
| Set control flag "c" is "on" state. | |||||||||||||||||
@@ -260,13 +223,13 @@ Features
Usageint a = 10, b = 32, c = 11;
-
+
// 10 20 1011
-
+
// this is green word
-
+
// "tab and" "quotes"
Writing your own output operator@@ -293,7 +256,7 @@ Writing your own output operator | |||||||||||||||||
| PICout PICout::operator<< | ( | -const PICoutAction | +const PICoutAction | v | ) | ||||||||||||
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
|||||||||||||||||
1.8.8
1.8.9.1
Connection quality diagnostics. More...
-
Inheritance diagram for PIDiagnostics:@@ -288,28 +248,28 @@ Additional Inherited Members | PIOBJECT(name) |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | |
| -#define | PIOBJECT_PARENT(name) |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | |
| +#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() | 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) | 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) | 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) | 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) | 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) | |
| @@ -317,23 +277,23 @@ Additional Inherited Members | |
| EVENT_HANDLER is synonym of EVENT_HANDLER0. | |
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | |
| @@ -345,19 +305,19 @@ Additional Inherited Members | |
| declare event "event" with name "name", void name(); | |
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | |
| @@ -365,27 +325,27 @@ Additional Inherited Members | |
| EVENT is synonym of EVENT0. | |
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | |
| @@ -393,23 +353,23 @@ Additional Inherited Members | |
| CONNECT is synonym of CONNECT0. | |
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | |
| @@ -417,23 +377,23 @@ Additional Inherited Members | |
| WEAK_CONNECT is synonym of WEAK_CONNECT0. | |
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | |
@@ -488,9 +448,9 @@ Synopsis
1.8.9.1
| |
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
|
| allAddresses() | PIEthernet | static |
| Broadcast enum value | PIEthernet | |
| broadcast | PIEthernet | |
| className() const | PIObject | inlinevirtual |
| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIEthernet | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| clearThreadedWriteQueue() | PIIODevice | inline |
| close() | PIIODevice | inline |
| closed() | PIIODevice | |
| closeDevice() | PIEthernet | protectedvirtual |
| configureDevice(const void *e_main, const void *e_parent=0) | PIEthernet | protectedvirtual |
| configureFromFullPath(const PIString &full_path) | PIEthernet | protectedvirtual |
| connect() | PIEthernet | |
| connect(const PIString &ip, int port) | PIEthernet | inline |
| connect(const PIString &ip_port) | PIEthernet | inline |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| connected() | PIEthernet | |
| CONNECTU | PIObject | related |
| constructFullPath() const | PIEthernet | virtual |
| configure(const PIString &config_file, const PIString §ion, bool parent_section=false) | PIIODevice | |
| configureDevice(const void *e_main, const void *e_parent=0) | PIEthernet | protectedvirtual |
| configureFromFullPath(const PIString &full_path) | PIEthernet | protectedvirtual |
| connect() | PIEthernet | |
| connect(const PIString &ip, int port) | PIEthernet | inline |
| connect(const PIString &ip_port) | PIEthernet | inline |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| connected() | PIEthernet | |
| CONNECTU | PIObject | related |
| constructFullPath() const | PIEthernet | virtual |
| createFromFullPath(const PIString &full_path) | PIIODevice | static |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| disconnected(bool withError) | PIEthernet | |
| 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 |
| DeviceMode enum name | PIIODevice | |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| DISCONNECT2 | PIObject | related |
| DISCONNECT3 | PIObject | related |
| DISCONNECT4 | PIObject | related |
| disconnected(bool withError) | PIEthernet | |
| 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 | PIEthernet | inlineprotectedvirtual |
| HANDLER | PIObject | related |
| ifActive enum value | PIEthernet | |
| ifPTP enum value | PIEthernet | |
| ifRunning enum value | PIEthernet | |
| init() | PIEthernet | protectedvirtual |
| InterfaceFlag enum name | PIEthernet | |
| InterfaceFlags typedef | PIEthernet | |
| interfaces() | PIEthernet | static |
| ip | PIEthernet | |
| initialize() | PIIODevice | inline |
| InterfaceFlag enum name | PIEthernet | |
| InterfaceFlags typedef | PIEthernet | |
| interfaces() | PIEthernet | static |
| ip | PIEthernet | |
| isClosed() const | PIIODevice | inline |
| isConnected() const | PIEthernet | inline |
| isParameterSet(PIEthernet::Parameters parameter) const | PIEthernet | inline |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| isOpened() const | PIIODevice | inline |
| isParameterSet(PIEthernet::Parameters parameter) const | PIEthernet | 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 |
| joinMulticastGroup(const PIString &group) | PIEthernet | |
| leaveMulticastGroup(const PIString &group) | PIEthernet | |
| listen(bool threaded=false) | PIEthernet | |
| listen(const PIString &ip, int port, bool threaded=false) | PIEthernet | inline |
| listen(const PIString &ip_port, bool threaded=false) | PIEthernet | inline |
| lock() | PIThread | inline |
| lastReadAddress() const | PIEthernet | inline |
| lastReadIP() const | PIEthernet | inline |
| lastReadPort() const | PIEthernet | inline |
| leaveMulticastGroup(const PIString &group) | PIEthernet | |
| listen(bool threaded=false) | PIEthernet | |
| listen(const PIString &ip, int port, bool threaded=false) | PIEthernet | inline |
| listen(const PIString &ip_port, bool threaded=false) | PIEthernet | inline |
| lock() | PIThread | inline |
| mode() const | PIIODevice | inline |
| multicastGroups() const | PIEthernet | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| newConnection(PIEthernet *client) | PIEthernet | |
| openDevice() | PIEthernet | protectedvirtual |
| MulticastLoop enum value | PIEthernet | |
| multicastTTL | PIEthernet | |
| multicastTTL() const | PIEthernet | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| newConnection(PIEthernet *client) | PIEthernet | |
| open() | PIIODevice | inline |
| open(const PIString &_path) | PIIODevice | inline |
| open(const DeviceMode &_mode) | PIIODevice | inline |
| open(const PIString &_path, const DeviceMode &_mode) | PIIODevice | inline |
| openDevice() | PIEthernet | protectedvirtual |
| opened() | PIIODevice | |
| Parameters enum name | PIEthernet | |
| parameters | PIEthernet | |
| parameters() const | PIEthernet | inline |
| Parameters enum name | PIEthernet | |
| 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 | related |
| PIIODevice() | PIIODevice | |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIOBJECT | PIObject | related |
| PIObject(const PIString &name=PIString()) | PIObject | |
| PIOBJECT_PARENT | 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 | |
| port | PIEthernet | |
| property(const PIString &name) const | PIObject | inline |
| propertyChanged(const PIString &name) | PIEthernet | protectedvirtual |
| read(void *read_to, int max_size) | PIEthernet | virtual |
| readAddress() const | PIEthernet | inline |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| PIIODevice::read(int max_size) | PIIODevice | inline |
| readAddress() const | PIEthernet | inline |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| readForTime(double timeout_ms) | PIIODevice | |
| readIP() const | PIEthernet | inline |
| readPort() const | PIEthernet | inline |
| ReadOnly enum value | PIIODevice | |
| readPort() const | PIEthernet | inline |
| readTimeout | PIEthernet | |
| readTimeout() const | PIEthernet | inline |
| received(const void *data, int size) | PIEthernet | inlineprotectedvirtual |
| REGISTER_DEVICE | PIIODevice | related |
| ReadWrite enum value | PIIODevice | |
| received(const void *data, int size) | PIEthernet | inlineprotectedvirtual |
| REGISTER_DEVICE | PIIODevice | related |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| ReuseAddress enum value | PIEthernet | |
| reuseAddress | PIEthernet | |
| send(const void *data, int size, bool threaded=false) | PIEthernet | inline |
| send(const PIString &ip, int port, const void *data, int size, bool threaded=false) | PIEthernet | inline |
| send(const PIString &ip_port, const void *data, int size, bool threaded=false) | PIEthernet | inline |
| send(const void *data, int size, bool threaded=false) | PIEthernet | inline |
| send(const PIByteArray &data, bool threaded=false) | PIEthernet | inline |
| sendAddress() const | PIEthernet | inline |
| sendIP() const | PIEthernet | inline |
| sendPort() const | PIEthernet | inline |
| send(const PIByteArray &data, bool threaded=false) | PIEthernet | inline |
| send(const PIString &ip, int port, const PIByteArray &data, bool threaded=false) | PIEthernet | inline |
| send(const PIString &ip_port, const PIByteArray &data, bool threaded=false) | PIEthernet | inline |
| sendAddress() const | PIEthernet | inline |
| sendIP() const | PIEthernet | inline |
| sendPort() const | PIEthernet | inline |
| SeparateSockets enum value | PIEthernet | |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setName(const PIString &name) | PIObject | inline |
| setParameter(PIEthernet::Parameters parameter, bool on=true) | PIEthernet | |
| setParameters(PIFlags< PIEthernet::Parameters > parameters_) | PIEthernet | inline |
| setMulticastTTL(int ttl) | PIEthernet | inline |
| setName(const PIString &name) | PIObject | inline |
| setParameter(PIEthernet::Parameters parameter, bool on=true) | PIEthernet | |
| setParameters(PIFlags< PIEthernet::Parameters > parameters_) | PIEthernet | inline |
| setPath(const PIString &path) | PIIODevice | inline |
| setPriority(PIThread::Priority prior) | PIThread | |
| setProperty(const PIString &name, const PIVariant &value) | PIObject | inline |
| setReadAddress(const PIString &ip, int port) | PIEthernet | inline |
| setReadIP(const PIString &ip) | PIEthernet | inline |
| setReadPort(int port) | PIEthernet | inline |
| setReadTimeout(double ms) | PIEthernet | inline |
| setReopenEnabled(bool yes=true) | PIIODevice | inline |
| setReopenTimeout(int msecs) | PIIODevice | inline |
| setSendAddress(const PIString &ip, int port) | PIEthernet | inline |
| setSendAddress(const PIString &ip_port) | PIEthernet | inline |
| setSendIP(const PIString &ip) | PIEthernet | inline |
| setSendPort(int port) | PIEthernet | inline |
| setSlot(ThreadFunc func) | PIThread | inline |
| setThreadedReadBufferSize(int new_size) | PIIODevice | inline |
| setThreadedReadData(void *d) | PIIODevice | inline |
| setThreadedReadSlot(ReadRetFunc func) | PIIODevice | inline |
| setTTL(int ttl) | PIEthernet | inline |
| setWriteTimeout(double ms) | PIEthernet | 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 |
| stopped() | PIThread | |
| superClassName() const | PIObject | inlinevirtual |
| TCP_Client enum value | PIEthernet | |
| TCP_Server enum value | PIEthernet | |
| threadedRead(uchar *readed, int size) | PIIODevice | inlineprotectedvirtual |
| type() const | PIEthernet | inline |
| Type enum name | PIEthernet | |
| UDP enum value | PIEthernet | |
| 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) | PIEthernet | virtual |
| write(const PIByteArray &data) | PIEthernet | inline |
| writeTimeout() const | PIEthernet | 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 |
| superClassName() const | PIObject | inlinevirtual |
| TCP_Client enum value | PIEthernet | |
| TCP_Server enum value | PIEthernet | |
| 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 | |
| TTL | PIEthernet | |
| TTL() const | PIEthernet | inline |
| type() const | PIEthernet | inline |
| Type enum name | PIEthernet | |
| UDP enum value | PIEthernet | |
| 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) | PIEthernet | virtual |
| write(const PIByteArray &data) | PIEthernet | inline |
| WriteOnly enum value | PIIODevice | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice | |
| writeTimeout | PIEthernet | |
| writeTimeout() const | PIEthernet | inline |
1.8.8
1.8.9.1
Ethernet device. More...
-
Inheritance diagram for PIEthernet:@@ -147,7 +107,9 @@ Public Types | ||
| Type of PIEthernet. More... | ||
| enum | Parameters { ReuseAddress = 0x1, -Broadcast = 0x2 +Broadcast = 0x2, +SeparateSockets = 0x4, +MulticastLoop = 0x8 } | |
| Parameters of PIEthernet. More... | ||
| InterfaceFlags | ||
| PIFlags of network interface flags | ||
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, @@ -246,6 +215,18 @@ int | sendPort () const |
| Returns send port. | ||
| +PIString | lastReadAddress () const | |
| Returns address of last received UDP packet in format "i.i.i.i:p". | ||
| +PIString | lastReadIP () const | |
| Returns IP of last received UDP packet. | ||
| +int | lastReadPort () const | |
| Returns port of last received UDP packet. | ||
| void | setParameters (PIFlags< PIEthernet::Parameters > parameters_) | |
| Set parameters to "parameters_". You should to reopen PIEthernet to apply them. | setWriteTimeout (double ms) | |
| Set timeout for write. | ||
| +int | TTL () const | |
| Returns TTL (Time To Live) | ||
| +int | multicastTTL () const | |
| Returns multicast TTL (Time To Live) | ||
| +void | setTTL (int ttl) | |
| Set TTL (Time To Live), default is 64. | ||
| +void | setMulticastTTL (int ttl) | |
| Set multicast TTL (Time To Live), default is 1. | ||
| bool | joinMulticastGroup (const PIString &group) | |
| Join to multicast group with address "group". Use only for UDP. | listen (const PIString &ip_port, bool threaded=false) | |
| Start listen for incoming TCP connections on address "ip_port". Use only for TCP_Server. | ||
| +bool | send (const void *data, int size, bool threaded=false) | |
| Send data "data" with size "size" to address sendAddress() for UDP or readAddress() for TCP_Client. | ||
| bool | send (const PIString &ip, int port, const void *data, int size, bool threaded=false) | |
| Send data "data" with size "size" to address "ip":"port". | send (const PIString &ip_port, const void *data, int size, bool threaded=false) | |
| Send data "data" with size "size" to address "ip_port". | ||
| -bool | send (const void *data, int size, bool threaded=false) | |
| Send data "data" with size "size" to address sendAddress() for UDP or readAddress() for TCP_Client. | ||
| bool | send (const PIByteArray &data, bool threaded=false) | |
| Send data "data" to address sendAddress() for UDP or readAddress() for TCP_Client. | ||
| +bool | send (const PIString &ip, int port, const PIByteArray &data, bool threaded=false) | |
| Send data "data" to address "ip":"port" for UDP. | ||
| +bool | send (const PIString &ip_port, const PIByteArray &data, bool threaded=false) | |
| Send data "data" to address "ip_port" for UDP. | ||
| int | read (void *read_to, int max_size) | |
| Wait for some data and read it to "read_to". | write (const PIByteArray &data) | |
| Send data "data" to address sendAddress() for UDP or readAddress() for TCP_Client. | ||
| +virtual bool | canWrite () const | |
| Return true if device can write now. | ||
| PIString | constructFullPath () const | |
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | ||
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | ||
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. | ||
| +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. | ||
| +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. | ||
| +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) | Set object debug active. |
|
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const |
| Returns properties of the object. | ||
| @@ -496,6 +690,10 @@ static Interface static PIStringList | allAddresses () | |
| Returns all system network IP addresses. | ||
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) | port |
| read port, default 0 | ||
| -bool | broadcast | |
| Broadcast parameter, default false. | ||
| -bool | reuseAddress | |
| ReuseAddress parameter, default false. | ||
| +int | parameters | |
| ethernet parameters | ||
| +double | readTimeout | |
| read timeout, default 1000 ms | ||
| +double | writeTimeout | |
| write timeout, default 1000 ms | ||
| +int | TTL | |
| time-to-live, default 64 | ||
| +int | multicastTTL | |
| time-to-live for multicast, default 1 | ||
Additional Inherited Members | |
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) |
| #define | REGISTER_DEVICE(class) |
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |
| #define | PIIODEVICE(class) | PIOBJECT(name) |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | |
| -#define | PIOBJECT_PARENT(name) |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | |
| +#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() | 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) | 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) | 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) | 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) | 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) | |
| @@ -642,23 +865,23 @@ Additional Inherited Members | |
| EVENT_HANDLER is synonym of EVENT_HANDLER0. | |
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | |
| @@ -670,19 +893,19 @@ Additional Inherited Members | |
| declare event "event" with name "name", void name(); | |
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | |
| @@ -690,27 +913,27 @@ Additional Inherited Members | |
| EVENT is synonym of EVENT0. | |
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | |
| @@ -718,23 +941,23 @@ Additional Inherited Members | |
| CONNECT is synonym of CONNECT0. | |
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | |
| @@ -742,23 +965,23 @@ Additional Inherited Members | |
| WEAK_CONNECT is synonym of WEAK_CONNECT0. | |
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | |
| @@ -774,7 +997,7 @@ Additional Inherited Members | |
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
|
1.8.8
1.8.9.1
Array of Interface with some features. More...
-
Inheritance diagram for PIEthernet::InterfaceList:
@@ -152,9 +112,9 @@ const Interface
1.8.9.1
|
PIP
- 0.4.1_alpha3
+ 0.5.0_prealpha
Platform-Independent Primitives
|
@@ -39,10 +35,7 @@
|
1.8.8
1.8.9.1
1.8.8
1.8.9.1
This is the complete list of members for PIFile, including all inherited members.
| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIIODevice | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| clear() | PIFile | inline |
| clearThreadedWriteQueue() | PIIODevice | inline |
| close() | PIIODevice | inline |
| closed() | PIIODevice | |
| closeDevice() | PIFile | protectedvirtual |
| configureDevice(const void *e_main, const void *e_parent=0) | PIIODevice | inlineprotectedvirtual |
| configureFromFullPath(const PIString &full_path) | PIFile | protectedvirtual |
| 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 |
| 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) | PIFile | protectedvirtual |
| CONNECT | PIObject | related |
| CONNECT0 | PIObject | related |
| CONNECT1 | PIObject | related |
| CONNECT2 | PIObject | related |
| CONNECT3 | PIObject | related |
| CONNECT4 | PIObject | related |
| CONNECTU | PIObject | related |
| constructFullPath() const | PIFile | virtual |
| createFromFullPath(const PIString &full_path) | PIIODevice | static |
| data() const | PIThread | inline |
| debug() const | PIObject | inline |
| DeviceMode enum name | PIIODevice | |
| DISCONNECT | PIObject | related |
| DISCONNECT0 | PIObject | related |
| DISCONNECT1 | PIObject | related |
| EVENT_VHANDLER2 | PIObject | related |
| EVENT_VHANDLER3 | PIObject | related |
| EVENT_VHANDLER4 | PIObject | related |
| fileInfo() const | PIFile | inline |
| fileInfo(const PIString &path) | PIFile | static |
| findByName(const PIString &name) | PIObject | inlinestatic |
| fullPathPrefix() const | PIFile | inlineprotectedvirtual |
| HANDLER | PIObject | related |
| init() | PIIODevice | inlineprotectedvirtual |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| flush() | PIFile | inlinevirtual |
| fullPathPrefix() const | PIFile | inlineprotectedvirtual |
| HANDLER | PIObject | related |
| init() | PIIODevice | inlineprotectedvirtual |
| initialize() | PIIODevice | inline |
| isClosed() const | PIIODevice | inline |
| isEmpty() const | PIFile | inline |
| isEnd() const | PIFile | inline |
| isExists(const PIString &path) | PIFile | static |
| 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 |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| openDevice() | PIFile | protectedvirtual |
| mode() const | PIIODevice | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| open() | PIIODevice | inline |
| open(const PIString &_path) | PIIODevice | inline |
| open(const DeviceMode &_mode) | PIIODevice | inline |
| open(const PIString &_path, const DeviceMode &_mode) | PIIODevice | inline |
| openDevice() | PIFile | protectedvirtual |
| opened() | PIIODevice | |
| openTemporary(PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) | PIFile | inlinestatic |
| operator<<(const char v) | PIFile | inline |
| operator<<(const PIString &v) | PIFile | inline |
| operator<<(const PIByteArray &v) | PIFile | inline |
| operator<<(short v) | PIFile | inline |
| operator<<(int v) | PIFile | inline |
| operator<<(long v) | PIFile | inline |
| operator<<(llong v) | PIFile | inline |
| operator<<(uchar v) | PIFile | inline |
| operator<<(ushort v) | PIFile | inline |
| operator<<(uint v) | PIFile | inline |
| operator<<(ulong v) | PIFile | inline |
| operator<<(ullong v) | PIFile | inline |
| operator<<(float v) | PIFile | inline |
| operator<<(double v) | PIFile | inline |
| operator>>(char &v) | PIFile | inline |
| operator>>(short &v) | PIFile | inline |
| operator>>(int &v) | PIFile | inline |
| operator>>(long &v) | PIFile | inline |
| operator>>(llong &v) | PIFile | inline |
| operator>>(uchar &v) | PIFile | inline |
| operator>>(ushort &v) | PIFile | inline |
| operator>>(uint &v) | PIFile | inline |
| operator>>(ulong &v) | PIFile | inline |
| operator>>(ullong &v) | PIFile | inline |
| operator>>(float &v) | PIFile | inline |
| operator>>(double &v) | PIFile | inline |
| path() const | PIIODevice | inline |
| piCoutObj | PIObject | related |
| piDisconnect(PIObject *src, const PIString &sig) | PIObject | static |
| piDisconnect(PIObject *src) | PIObject | static |
| PIFile() | PIFile | |
| PIFile(const PIString &path, DeviceMode mode=ReadWrite) | PIFile | |
| piHigh enum value | PIThread | |
| piHighest enum value | PIThread | |
| PIIODevice() | PIIODevice | |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | |
| PIIODEVICE | PIIODevice | related |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | |
| PIOBJECT | PIObject | related |
| PIOBJECT_PARENT | 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 | |
| pos() const | PIFile | inline |
| precision() const | PIFile | inline |
| 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 |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| REGISTER_DEVICE | PIIODevice | related |
| 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 |
| read(void *read_to, int max_size) | PIFile | inlinevirtual |
| PIIODevice::read(int max_size) | PIIODevice | inline |
| readAll(void *data) | PIFile | |
| readAll(bool forceRead=false) | PIFile | |
| readChar() | PIFile | inline |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| readForTime(double timeout_ms) | PIIODevice | |
| readLine() | PIFile | |
| ReadOnly enum value | PIIODevice | |
| ReadWrite enum value | PIIODevice | |
| REGISTER_DEVICE | PIIODevice | related |
| remove() | PIFile | inline |
| remove(const PIString &path) | PIFile | inlinestatic |
| rename(const PIString &from, const PIString &to) | PIFile | inlinestatic |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| resize(llong new_size) | PIFile | inline |
| resize(llong new_size, uchar fill) | PIFile | |
| seek(llong position) | PIFile | inline |
| seekToBegin() | PIFile | inline |
| seekToEnd() | PIFile | inline |
| seekToLine(llong line) | PIFile | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setName(const PIString &name) | PIObject | inline |
| setPath(const PIString &path) | PIFile | inline |
| setPrecision(int prec) | PIFile | 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 |
| size() const | PIFile | |
| 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 |
| 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_CONNECT2 | PIObject | related |
| WEAK_CONNECT3 | PIObject | related |
| WEAK_CONNECT4 | PIObject | related |
| write(const void *data, int max_size) | PIFile | inlinevirtual |
| PIIODevice::write(const PIByteArray &data) | PIIODevice | inline |
| writeBinary(const char v) | PIFile | inline |
| writeBinary(const short v) | PIFile | inline |
| writeBinary(const int v) | PIFile | inline |
| writeBinary(const long v) | PIFile | inline |
| writeBinary(const llong v) | PIFile | inline |
| writeBinary(const uchar v) | PIFile | inline |
| writeBinary(const ushort v) | PIFile | inline |
| writeBinary(const uint v) | PIFile | inline |
| writeBinary(const ulong v) | PIFile | inline |
| writeBinary(const ullong v) | PIFile | inline |
| writeBinary(const float v) | PIFile | inline |
| writeBinary(const double v) | PIFile | inline |
| WriteOnly enum value | PIIODevice | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice |
1.8.8
1.8.9.1
Local file. More...
-
Inheritance diagram for PIFile:-Protected Member Functions | |
| -PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| -void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| -bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| -bool | closeDevice () |
| Reimplement to close device, inverse 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 | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". | |
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. | |
-Additional Inherited Members | |
Public Types inherited from PIThread | |
| enum | Priority { - piLowerst, -piLow, -piNormal, -piHigh, - - piHighest - - } |
| Priority of thread. More... | |
+Public Member Functions | |
| + | PIFile () |
| Constructs an empty file. | |
| + | PIFile (const PIString &path, DeviceMode mode=ReadWrite) |
| Constructs a file with path "path" nad open mode "type". | |
| +void | flush () |
| Immediate write all buffered data to disk. | |
| +void | seek (llong position) |
| Move read/write position to "position". | |
| +void | seekToBegin () |
| Move read/write position to the begin of the file. | |
| +void | seekToEnd () |
| Move read/write position to the end of the file. | |
| +void | seekToLine (llong line) |
| Move read/write position to text line number "line". | |
| +char | readChar () |
| Read one char and return it. | |
| +PIString | readLine () |
| Read one text line and return it. | |
| +llong | readAll (void *data) |
| Read all file content to "data" and return readed bytes count. Position leaved unchanged. | |
| +PIByteArray | readAll (bool forceRead=false) |
| Read all file content to byte array and return it. Position leaved unchanged. | |
| +void | setPath (const PIString &path) |
| Set file path to "path" and reopen file if need. | |
| +llong | size () const |
| Returns file size. | |
| +llong | pos () const |
| Returns read/write position. | |
| +bool | isEnd () const |
| Returns if position is at the end of file. | |
| +bool | isEmpty () const |
| Returns if file is empty. | |
| +FileInfo | fileInfo () const |
| Returns FileInfo of current file. | |
| +int | precision () const |
| Returns float numbers write precision. | |
| +void | setPrecision (int prec) |
| Set float numbers write precision to "prec_" digits. | |
| +int | read (void *read_to, int max_size) |
| Read from file to "read_to" no more than "max_size" and return readed bytes count. | |
| +int | write (const void *data, int max_size) |
| Write to file "data" with size "max_size" and return written bytes count. | |
| +PIFile & | writeBinary (const char v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const short v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const int v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const long v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const llong v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const uchar v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const ushort v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const uint v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const ulong v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const ullong v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const float v) |
| Write to file binary content of "v". | |
| +PIFile & | writeBinary (const double v) |
| Write to file binary content of "v". | |
| +PIFile & | operator<< (const char v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (const PIString &v) |
| Write to file string "v". | |
| +PIFile & | operator<< (const PIByteArray &v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (short v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (int v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (long v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (llong v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (uchar v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (ushort v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (uint v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (ulong v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (ullong v) |
| Write to file text representation of "v". | |
| +PIFile & | operator<< (float v) |
| Write to file text representation of "v" with precision precision() | |
| +PIFile & | operator<< (double v) |
| Write to file text representation of "v" with precision precision() | |
| +PIFile & | operator>> (char &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (short &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (int &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (long &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (llong &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (uchar &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (ushort &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (uint &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (ulong &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (ullong &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (float &v) |
| Read from file text representation of "v". | |
| +PIFile & | operator>> (double &v) |
| Read from file text representation of "v". | |
| +PIString | constructFullPath () const |
| Reimplement to construct full unambiguous string, describes this device, default returns fullPathPrefix() + "://" + path() | |
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. | |
| +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. | |
| +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. | |
| +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) | Set object debug active. |
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const |
| Returns properties of the object. | |
| @@ -311,6 +645,33 @@ void | isPropertyExists (const PIString &name) const |
| Returns if property with name "name" exists. | |
+Static Public Member Functions | |
| +static PIFile | openTemporary (PIIODevice::DeviceMode mode=PIIODevice::ReadWrite) |
| Returns not opened temporary file with open mode "mode". | |
| +static bool | isExists (const PIString &path) |
| Returns if file with path "path" does exists. | |
| +static bool | remove (const PIString &path) |
| Remove file with path "path" and returns if remove was successful. | |
| +static bool | rename (const PIString &from, const PIString &to) |
| Rename file with path "from" to path "to" and returns if rename was successful. | |
| +static FileInfo | fileInfo (const PIString &path) |
| Returns FileInfo of file or dir with path "path". | |
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) | PIObject * | findByName (const PIString &name) |
| Returns PIObject* with name "name" or 0, if there is no object found. | |
+Protected Member Functions | |
| +PIString | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| +void | configureFromFullPath (const PIString &full_path) |
| Reimplement to configure your device with parameters of full unambiguous string. Default implementation does nothing. | |
| +bool | openDevice () |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| +bool | closeDevice () |
| Reimplement to close device, inverse 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 | threadedRead (uchar *readed, int size) |
| Function executed when thread read some data, default implementation execute external slot "ret_func_". | |
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. | |
+Handlers | |
| +void | clear () |
| Clear content of file. | |
| +void | remove () |
| Remove file. | |
| +void | resize (llong new_size) |
| Resize file to "new_size" with "fill" filling. | |
| +void | resize (llong new_size, uchar fill) |
| Resize file to "new_size" with "fill" filling. | |
+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... | |||
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) | ||
| #define | REGISTER_DEVICE(class) | ||
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |||
| Use this macro to enable automatic creation instances of your class with createFromFullPath() function. | |||
| #define | PIIODEVICE(class) | PIOBJECT(name) | |
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER and correct piCoutObj output | |||
| -#define | PIOBJECT_PARENT(name) | ||
| you should use this macro after class declaration to use EVENT and EVENT_HANDLER of parent class | |||
| +#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() | 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) | 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) | 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) | 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) | 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) | |||
| @@ -375,23 +831,23 @@ static PIObject * | EVENT_HANDLER is synonym of EVENT_HANDLER0. | ||
| -#define | EVENT_VHANDLER0(ret, name) virtual ret name() | 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) | 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) | 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) | 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) | 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) | |||
| @@ -403,19 +859,19 @@ static PIObject * | declare event "event" with name "name", void name(); | ||
| -#define | EVENT1(name, type0, var0) void name(type0 var0); | 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); | 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); | 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); | 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); | |||
| @@ -423,27 +879,27 @@ static PIObject * | EVENT is synonym of EVENT0. | ||
| -#define | CONNECTU(src, event, dest, handler) | 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) | 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) | 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) | 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) | 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) | 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 | |||
| @@ -451,23 +907,23 @@ static PIObject * | CONNECT is synonym of CONNECT0. | ||
| -#define | WEAK_CONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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 | |||
| @@ -475,23 +931,23 @@ static PIObject * | WEAK_CONNECT is synonym of WEAK_CONNECT0. | ||
| -#define | DISCONNECT0(ret, src, event, dest, handler) | 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) | 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) | 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) | 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) | 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" | |||
| @@ -507,19 +963,19 @@ static PIObject * | Local file. Synopsis-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. +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. Position-Each opened file has a read/write position - logical position in the file content you read from or you write to. You can find out current position with function pos(). Function seek(llong position) move position to position "position", seekToBegin() move position to the begin of file, seekToEnd() move position to the end of file. +Each opened file has a read/write position - logical position in the file content you read from or you write to. You can find out current position with function pos(). Function seek(llong position) move position to position "position", seekToBegin() move position to the begin of file, seekToEnd() move position to the end of file. diff --git a/doc/html/class_p_i_file.js b/doc/html/class_p_i_file.js index 265478da..b0786bd3 100644 --- a/doc/html/class_p_i_file.js +++ b/doc/html/class_p_i_file.js @@ -1,5 +1,69 @@ var class_p_i_file = [ + [ "PIFile", "class_p_i_file.html#aa47d6aa20106c6999c653260dbedb73d", null ], + [ "PIFile", "class_p_i_file.html#ad781b8fbbdb6609f6ae3aa298f3b6e13", null ], + [ "flush", "class_p_i_file.html#a132591b54607356c5c31b1cbd81bc46b", null ], + [ "seek", "class_p_i_file.html#aec794c7b80737ce07a192dd754f7f6ba", null ], + [ "seekToBegin", "class_p_i_file.html#ac5a499e6a8629adc2b25e16d26770cde", null ], + [ "seekToEnd", "class_p_i_file.html#a6910e128332374c50b234a0001f13f99", null ], + [ "seekToLine", "class_p_i_file.html#a392dc8d2110572f06d55f4ac6b935766", null ], + [ "readChar", "class_p_i_file.html#a20deee3c201f517138291d6614cd6528", null ], + [ "readLine", "class_p_i_file.html#ad531c12b2f2966aa1c532f5144ed8996", null ], + [ "readAll", "class_p_i_file.html#a114a8e11697f2392152de2f8bab0d0a7", null ], + [ "readAll", "class_p_i_file.html#af5758414d1f4ec29e2344117403d01b5", null ], + [ "setPath", "class_p_i_file.html#a59bc3c9dcb25f279a79233ca7da98844", null ], + [ "size", "class_p_i_file.html#aa39bccaea51998dfeca31ae67218d2f7", null ], + [ "pos", "class_p_i_file.html#a7355172794fe67079f67df4806989fc4", null ], + [ "isEnd", "class_p_i_file.html#aabe0bfca7ac93336637bda487ac84a2b", null ], + [ "isEmpty", "class_p_i_file.html#a06a88f455041ca37c8189e3fb6c37448", null ], + [ "fileInfo", "class_p_i_file.html#a90e511b260b63c6fa9332caebc5b5027", null ], + [ "precision", "class_p_i_file.html#a47d509cdd1fe38785be5e262063778e3", null ], + [ "setPrecision", "class_p_i_file.html#a1b84235bc215aafcf45e1a591b85e5f1", null ], + [ "read", "class_p_i_file.html#a652a5846b2cc664400065aa9f6c8223c", null ], + [ "write", "class_p_i_file.html#aef423b94a8ab5a48748486a6e4017c0c", null ], + [ "writeBinary", "class_p_i_file.html#a0680181eac4908195084695401bd12d2", null ], + [ "writeBinary", "class_p_i_file.html#a56a4c08a94b5ba2b7b8279f1f00057bb", null ], + [ "writeBinary", "class_p_i_file.html#a9e8388339f80dcc4686711002e06a9c1", null ], + [ "writeBinary", "class_p_i_file.html#a40750af98737a62e8161cdba7885e30c", null ], + [ "writeBinary", "class_p_i_file.html#a384cc2d96b3567ce5584b8a9b42a08cb", null ], + [ "writeBinary", "class_p_i_file.html#ad46963b539de21cfcea1396a14dbb581", null ], + [ "writeBinary", "class_p_i_file.html#a6221b5eb71dfd0f4c25af5c4ed5fc1d0", null ], + [ "writeBinary", "class_p_i_file.html#ad967bd65a2cf9d9662199e8f7c977ff4", null ], + [ "writeBinary", "class_p_i_file.html#a2976a441093c402bf89af6e9b2b0fe8f", null ], + [ "writeBinary", "class_p_i_file.html#ac7debdb3e48e3f20c474ed6e8108f5df", null ], + [ "writeBinary", "class_p_i_file.html#af4298d916b479eac3b7069cc8dca54b0", null ], + [ "writeBinary", "class_p_i_file.html#a3ea88685c983bc75df5d862ffb7b9a8b", null ], + [ "operator<<", "class_p_i_file.html#a8d694101504f0c1f3128a811b07fd974", null ], + [ "operator<<", "class_p_i_file.html#ad9821e04e4c9cd2d727c2e1b395c7259", null ], + [ "operator<<", "class_p_i_file.html#ab3cf989bcec6f6af10992564d6b56a5c", null ], + [ "operator<<", "class_p_i_file.html#aba3da16853f563b4a4f8ed20a6cf8e9e", null ], + [ "operator<<", "class_p_i_file.html#aacddb47a02788b092c620f00b9bced1f", null ], + [ "operator<<", "class_p_i_file.html#ac4584960e03dfe01b5e57e6d7a763ee0", null ], + [ "operator<<", "class_p_i_file.html#aeb1343f64549e369d810cdbc1c7eb1a0", null ], + [ "operator<<", "class_p_i_file.html#a7b16aff3aa93290e85a50f60e278503a", null ], + [ "operator<<", "class_p_i_file.html#a8771f38e5f1502a6850f32cf94640409", null ], + [ "operator<<", "class_p_i_file.html#a9b7110b8a47c7d42b4f220adf594b671", null ], + [ "operator<<", "class_p_i_file.html#a50ee5e83900ce0ceed91ddb854286be2", null ], + [ "operator<<", "class_p_i_file.html#ac90f25418bebffe15256a533ca235454", null ], + [ "operator<<", "class_p_i_file.html#a43b554b208cd51086743854104f5ede8", null ], + [ "operator<<", "class_p_i_file.html#abf5d79c712df1610b16f3e9398b5b566", null ], + [ "operator>>", "class_p_i_file.html#a45cb898faa13bcc3680a8744c6241fe7", null ], + [ "operator>>", "class_p_i_file.html#ac0505af1dd53a927a5dfcd21fae020c4", null ], + [ "operator>>", "class_p_i_file.html#a202d92cd37406879007edd5ed30d82e8", null ], + [ "operator>>", "class_p_i_file.html#afb85909f02f3e9cf3bb8a936706fa6d7", null ], + [ "operator>>", "class_p_i_file.html#a29af3786636c78312f150f24c31d40cf", null ], + [ "operator>>", "class_p_i_file.html#a7ca2279dbf97afbed9ff950bbd9bdf21", null ], + [ "operator>>", "class_p_i_file.html#a4f4708b066379b2961c8a499d6ca1e29", null ], + [ "operator>>", "class_p_i_file.html#ad3bdeb0b87ea91d2c93e0c97201a235c", null ], + [ "operator>>", "class_p_i_file.html#aeb7890f1bd63000652f3974fa9abcf4f", null ], + [ "operator>>", "class_p_i_file.html#a9b6f080aa31a09ae0bb8f30cd1324ffd", null ], + [ "operator>>", "class_p_i_file.html#a933239b83e2ca7e5dc6c956efe845432", null ], + [ "operator>>", "class_p_i_file.html#a58141b581e7bb0652b1001f93067bfbd", null ], + [ "constructFullPath", "class_p_i_file.html#a0eddca195c3347e3b1529dfb2c385ca2", null ], + [ "clear", "class_p_i_file.html#a04e1bfdaf3552799b86318dce398d54a", null ], + [ "remove", "class_p_i_file.html#a766e3b5bb5551b407ac05fdd61872611", null ], + [ "resize", "class_p_i_file.html#a8add117ad5c3d48b90c2309ddf9b842a", null ], + [ "resize", "class_p_i_file.html#af8e577fcfec99864b8c0c2fc8f023131", null ], [ "fullPathPrefix", "class_p_i_file.html#a68c53a59d5afef2a7c363f987b1a5e1a", null ], [ "configureFromFullPath", "class_p_i_file.html#a8f98ce9e7a6896b7c1dd0ca49a8eb49a", null ], [ "openDevice", "class_p_i_file.html#aeb972f021b5ef835566764f8bb000976", null ], diff --git a/doc/html/class_p_i_file__inherit__graph.map b/doc/html/class_p_i_file__inherit__graph.map index 05ca8917..912374d7 100644 --- a/doc/html/class_p_i_file__inherit__graph.map +++ b/doc/html/class_p_i_file__inherit__graph.map @@ -1,5 +1,4 @@ | ||
1.8.8
1.8.9.1
This is the complete list of members for PIIODevice, including all inherited members.
| canRead() const | PIIODevice | inlinevirtual |
| canWrite() const | PIIODevice | inlinevirtual |
| className() const | PIObject | inlinevirtual |
| closeDevice() | PIIODevice | inlineprotectedvirtual |
| 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 |
| 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 |
| 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 |
| fullPathPrefix() const | PIIODevice | inlineprotectedvirtual |
| 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 |
| isPropertyExists(const PIString &name) const | PIObject | inline |
| isRunning() const | PIThread | inline |
| initialize() | PIIODevice | inline |
| isClosed() const | PIIODevice | 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 |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| openDevice()=0 | PIIODevice | protectedpure virtual |
| 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 | related |
| piLow enum value | PIThread | |
| piLowerst enum value | PIThread | |
| piNormal enum value | PIThread | |
| PIObject(const PIString &name=PIString()) | PIObject | |
| PIOBJECT | PIObject | related |
| PIOBJECT_PARENT | 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 |
| readDeviceSetting(const PIString &name, const T &def, const PIConfig::Entry *em, const PIConfig::Entry *ep) | PIIODevice | related |
| mode() const | PIIODevice | inline |
| mutex() | PIThread | inline |
| name() const | PIObject | inline |
| needLockRun(bool need) | PIThread | inline |
| open() | PIIODevice | inline |
| open(const PIString &_path) | PIIODevice | inline |
| open(const DeviceMode &_mode) | PIIODevice | inline |
| open(const PIString &_path, const DeviceMode &_mode) | PIIODevice | inline |
| openDevice()=0 | PIIODevice | protectedpure virtual |
| 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 | related |
| PIIODevice() | PIIODevice | |
| PIIODevice(const PIString &path, DeviceMode mode=ReadWrite) | PIIODevice | |
| 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) | PIIODevice | inlinevirtual |
| 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 | |
| ReadOnly enum value | PIIODevice | |
| ReadWrite enum value | PIIODevice | |
| REGISTER_DEVICE | PIIODevice | related |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | inline |
| setName(const PIString &name) | PIObject | inline |
| reopenEnabled | PIIODevice | |
| reopenTimeout | PIIODevice | |
| reopenTimeout() | PIIODevice | inline |
| setData(void *d) | PIThread | inline |
| setDebug(bool debug) | PIObject | 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 |
| 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_CONNECT2 | PIObject | related |
| WEAK_CONNECT3 | PIObject | related |
| WEAK_CONNECT4 | PIObject | related |
| write(const void *data, int max_size) | PIIODevice | inlinevirtual |
| write(const PIByteArray &data) | PIIODevice | inline |
| WriteOnly enum value | PIIODevice | |
| writeThreaded(const void *data, int max_size) | PIIODevice | inline |
| writeThreaded(const PIByteArray &data) | PIIODevice |
1.8.8
1.8.9.1
Base class for input/output classes. More...
-
Inheritance diagram for PIIODevice:-Protected Member Functions | |
| -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 | openDevice ()=0 |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| -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 | fullPathPrefix () const |
| Reimplement to construct full unambiguous string prefix. Creating devices by unambiguous string. | |
| -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. | |
-Related Functions | |
(Note that these are not member functions.) - | |
| 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_PARENT(name) |
| 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". | |
-Additional Inherited Members | |
+Public Types | |
| enum | DeviceMode { ReadOnly = 0x01, +WriteOnly = 0x02, +ReadWrite = 0x03 + } |
| Open modes for PIIODevice. More... | |
Public Types inherited from PIThread | |
| enum | Priority { piLowerst, @@ -362,6 +109,170 @@ Additional Inherited Members |
| Priority of thread. More... | |
+Public Member Functions | |
| + | 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. | |
| +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. | |
| +virtual int | read (void *read_to, int max_size) |
| Reimplement this function to read from your device. | |
| +virtual int | write (const void *data, int max_size) |
| Reimplement this function to write to your device. | |
| +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() | |
Public Member Functions inherited from PIThread | |
| PIThread (void *data, ThreadFunc func, bool startNow=false, int loop_delay=-1) | Set object debug active. |
|
-const PIMap< PIString, -PIVariant > & | properties () const | properties () const |
| Returns properties of the object. | |
| @@ -493,6 +403,12 @@ void | isPropertyExists (const PIString &name) const |
| Returns if property with name "name" exists. | |
+Static Public Member Functions | |
| 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) | PIObject * | findByName (const PIString &name) |
| Returns PIObject* with name "name" or 0, if there is no object found. | |
+Protected Member Functions | |
| +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 | openDevice ()=0 |
| Reimplement to open device, return value will be set to "opened_" variable. | |
| +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. | |
+Related Functions | |
(Note that these are not member functions.) + | |
| 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". | |
+Handlers | |
| +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 handlers | |
| +virtual void | flush () |
| Immediate write all buffers. | |
+Events | |
| +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". | |
+Configurable parameters | |
| +bool | reopenEnabled |
| setReopenEnabled, default "true" | |
| +int | reopenTimeout |
| setReopenTimeout in ms, default 1000 | |
| +int | threadedReadBufferSize |
| setThreadedReadBufferSize in bytes, default 4096 | |
Base class for input/output classes.
This class provide open/close logic, threaded read/write and virtual input/output functions read() and write(). You should implement pure virtual function openDevice() in your subclass.
+This class provide open/close logic, threaded read/write and virtual input/output functions read() and write(). You should implement pure virtual function openDevice() in your subclass.
PIIODevice have boolean variable indicated open status. Returns of functions openDevice() and closeDevice() change this variable.
PIIODevice based on PIThread, so it`s overload run() to exec read() in background thread. If read is successful virtual function threadedRead() is executed. Default implementation of this function execute external static function set by setThreadedReadSlot() with data set by setThreadedReadData(). Extrenal static function should have format
+
PIIODevice based on PIThread, so it`s overload run() to exec read() in background thread. If read is successful virtual function threadedRead() is executed. Default implementation of this function execute external static function set by setThreadedReadSlot() with data set by setThreadedReadData(). Extrenal static function should have format
bool func_name(void * Threaded_read_data, uchar * readed_data, int readed_size)
-Threaded read starts with function startThreadedRead().
PIIODevice aggregate another PIThread to perform a threaded write by function writeThreaded(). This function add task to internal queue and return queue entry ID. You should start write thread by function startThreadedWrite. On successful write event threadedWriteEvent is raised with two arguments - task ID and written bytes count.
+PIIODevice aggregate another PIThread to perform a threaded write by function writeThreaded(). This function add task to internal queue and return queue entry ID. You should start write thread by function startThreadedWrite. On successful write event threadedWriteEvent is raised with two arguments - task ID and written bytes count.
PIIODevice have internal buffer for threaded read, and threadedRead() function receive pointer to this buffer in first argument. You can adjust size of this buffer by function setThreadedReadBufferSize()
+
PIIODevice have internal buffer for threaded read, and threadedRead() function receive pointer to this buffer in first argument. You can adjust size of this buffer by function setThreadedReadBufferSize()
Default size of this buffer is 4096 bytes.
When threaded read is begin its call open() if device is closed. While threaded read running PIIODevice check if device opened every read and if not call open() every reopen timeout if reopen enabled. Reopen timeout is set by setReopenTimeout(), reopen enable is set by setReopenEnabled().
+When threaded read is begin its call open() if device is closed. While threaded read running PIIODevice check if device opened every read and if not call open() every reopen timeout if reopen enabled. Reopen timeout is set by setReopenTimeout(), reopen enable is set by setReopenEnabled().
This is virtual function configureDevice() which executes when configure() executes. This function takes two arguments: "e_main" and "e_parent" as void*. There are pointers to PIConfig::Entry entries of section "section" and their parent. If there is no parent "e_parent" = 0. Function configure() set three parameters of device: "reopenEnabled", "reopenTimeout" and "threadedReadBufferSize", then execute function configureDevice().
+
This is virtual function configureDevice() which executes when configure() executes. This function takes two arguments: "e_main" and "e_parent" as void*. There are pointers to PIConfig::Entry entries of section "section" and their parent. If there is no parent "e_parent" = 0. Function configure() set three parameters of device: "reopenEnabled", "reopenTimeout" and "threadedReadBufferSize", then execute function configureDevice().
Each ancestor of PIIODevice reimlements configureDevice() function to be able to be confured from configuration file. This parameters described at section "Configurable parameters" in the class reference.
Usage example:
Implementation example:
There are some virtual functions to describe child class without its declaration.
fullPathPrefix() should returns unique prefix of device
- constructFullPath() should returns full unambiguous string, contains prefix and all device parameters
+ constructFullPath() should returns full unambiguous string, contains prefix and all device parameters
configureFromFullPath() provide configuring device from full unambiguous string without prefix and "://"
Macro PIIODEVICE should be used instead of PIOBJECT
Macro REGISTER_DEVICE should be used after definition of class, i.e. at the last line of *.cpp file
- If custom I/O device corresponds there rules, it can be returned by function createFromFullPath().
+ If custom I/O device corresponds there rules, it can be returned by function createFromFullPath().
Each PIP I/O device has custom unambiguous string description:
| enum PIIODevice::DeviceMode | +
Open modes for PIIODevice.
+| Enumerator | |
|---|---|
| ReadOnly |
+ Device can only read + |
| WriteOnly |
+ Device can only write + |
| ReadWrite |
+ Device can both read and write + |
| PIIODevice::PIIODevice | +( | +const PIString & | +path, | +
| + | + | PIIODevice::DeviceMode | +mode = ReadWrite |
+
| + | ) | ++ |
Constructs a PIIODevice with path and mode.
+| path | path to device |
| type | mode for open |
+
|
+ +inline | +
Set "threaded read slot".
+Set external static function of threaded read that will be executed at every successful threaded read. Function should have format "bool func(void * data, uchar * readed, int size)"
+ +
+
|
+ +inline | +
Set size of threaded read buffer.
+Default size is 4096 bytes. If your device can read at single read more than 4096 bytes you should use this function to adjust buffer size
+ +
+
|
+ +static | +
Try to determine suitable device, create new one, configure it with configureFromFullPath() and returns it.
+To function configureFromFullPath() "full_path" passed without fullPathPrefix() + "://". See Creating devices by unambiguous string
+ +
1.8.8
1.8.9.1