Weberni69795
/
BCIgui
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7 Commits
3 Branches
Branch: dev
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'dev'
${ noResults }
BCIgui/Masterarbeit/openvibe/sdk-master/plugins/processing/file-io/doc/Doc_BoxAlgorithm_GenericStr...

Doc_BoxAlgorithm_GenericStreamReader.dox-part 2.7KB
Raw Permalink Blame History

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. /**

  2.  * \page BoxAlgorithm_GenericStreamReader Generic stream reader

  3. __________________________________________________________________

  4. 

  5. Detailed description

  6. __________________________________________________________________

  7. 

  8.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Description|

  9. This box is able to read any file saved with the \ref Doc_BoxAlgorithm_GenericStreamWriter box.

  10. It is interesting to notice that such file can contain a variable number of streams. Therefore,

  11. the user is able to add and modify any output he wants on the box. The box does not supposes

  12. anything on the streams contained in the file during authoring in the designer. The streams of

  13. the file are mapped to created output at runtime in an "intelligent way" depending on there types.

  14.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Description|

  15. __________________________________________________________________

  16. 

  17. Outputs description

  18. __________________________________________________________________

  19. 

  20.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Outputs|

  21. This box can have as many output you want depending on the content of the file.

  22.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Outputs|

  23. 

  24.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Output1|

  25. This is the default output.

  26.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Output1|

  27. __________________________________________________________________

  28. 

  29. Settings description

  30. __________________________________________________________________

  31. 

  32.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Settings|

  33.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Settings|

  34. 

  35.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Setting1|

  36. This setting points to the file to read. This file may contain a variable number of multiplexed

  37. streams. Those streams will be mapped to corresponding outputs at runtime. The mapping is done in

  38. an "intelligent way" because it reorders the streams contained in the file to match the types of

  39. the outputs. If a stream from the file does not find a matching output, a warning is launched.

  40. If an output does not find a matching stream from the file, a warning is also launched.

  41.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Setting1|

  42. __________________________________________________________________

  43. 

  44. Examples description

  45. __________________________________________________________________

  46. 

  47.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Examples|

  48.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Examples|

  49. __________________________________________________________________

  50. 

  51. Miscellaneous description

  52. __________________________________________________________________

  53. 

  54.  * |OVP_DocBegin_BoxAlgorithm_GenericStreamReader_Miscellaneous|

  55.  * |OVP_DocEnd_BoxAlgorithm_GenericStreamReader_Miscellaneous|

  56.  */