.. index:: pair: class; EE::System::IOStreamString
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string:

class EE::System::IOStreamString
================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Implementation of a memory stream file using an std::string as a container. :ref:`More...<details-class_e_e_1_1_system_1_1_i_o_stream_string>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <iostreamstring.hpp>
	
	class IOStreamString: public :ref:`EE::System::IOStream<doxid-class_e_e_1_1_system_1_1_i_o_stream>` {
	public:
		// construction
	
		:target:`IOStreamString<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a9c76f40ae0a7362d6f09f0de8b4e85f7>`();
		:target:`IOStreamString<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a1b9b0dd81ce0d39f6b843d5e266b24e3>`(const std::string& filepath);

		// methods
	
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1ada8ab76010e5e98282ef4d322004a5e4>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a339419cdf9ddd67fec3e39581b91166e>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :target:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1af6cb2893f31e4dcf12c3db5504299ef3>`(const std::string& string);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a4632e8179783c6aa98d449ffc8894586>`(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position);
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1adf72cf4f0b5b004c583e5b8ff5c001ad>`();
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a5b67b94205d0d0610cf2b3ffd851cfd3>`();
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a6b6a3d249f1926d8b8520daf69c7ade0>`();
		void :target:`clear<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a2acf0fa97582a675435dc343d8504227>`();
		const char* :ref:`getPositionPointer<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a8768894e6d7d1701112ed1c806b6ed98>`();
		const char* :ref:`getStreamPointer<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a0fa5b7bd3a6dca1aa176e9ebe7ebfb69>`() const;
		const std::string& :target:`getStream<doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1aa7eba81110e47fcbef0bd1008b59b577>`() const;
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// methods
	
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`read<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a673723c6ec387b362ff35e7ee28947e6>`(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`write<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a1c3860c1fe8b8387203c0912b0d222c6>`(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`seek<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a961402e4701874fef9c276e09798dc2c>`(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position) = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`tell<doxid-class_e_e_1_1_system_1_1_i_o_stream_1aeb41a08fa5f58c311192073bd126291b>`() = 0;
		virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` :ref:`getSize<doxid-class_e_e_1_1_system_1_1_i_o_stream_1af2b9d259a0eeb4e839417f7f71b1c117>`() = 0;
		virtual bool :ref:`isOpen<doxid-class_e_e_1_1_system_1_1_i_o_stream_1a1c6877dde5607fe00591ad4b4ce0bbf2>`() = 0;

.. _details-class_e_e_1_1_system_1_1_i_o_stream_string:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

Implementation of a memory stream file using an std::string as a container.

Methods
-------

.. index:: pair: function; read
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1ada8ab76010e5e98282ef4d322004a5e4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` read(char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Read data from the stream.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- Buffer where to copy the read data

	*
		- size

		- Desired number of bytes to read



.. rubric:: Returns:

The number of bytes actually read

.. index:: pair: function; write
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a339419cdf9ddd67fec3e39581b91166e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` write(const char* data, :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` size)

Write data to the virtual file.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- data

		- Data to write in the file

	*
		- size

		- Size of the data that needs to be writed

.. index:: pair: function; seek
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a4632e8179783c6aa98d449ffc8894586:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` seek(:ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` position)

Change the current reading position.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- position

		- The position to seek to, from the beginning



.. rubric:: Returns:

The position actually sought to.

.. index:: pair: function; tell
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1adf72cf4f0b5b004c583e5b8ff5c001ad:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` tell()

Get the current reading position in the stream.



.. rubric:: Returns:

The current position, or -1 on error.

.. index:: pair: function; getSize
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a5b67b94205d0d0610cf2b3ffd851cfd3:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ios_size<doxid-namespace_e_e_1af0588adb61ea368bb77fb86c63c79b3e>` getSize()

Return the size of the stream.



.. rubric:: Returns:

The total number of bytes available in the stream

.. index:: pair: function; isOpen
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a6b6a3d249f1926d8b8520daf69c7ade0:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual bool isOpen()



.. rubric:: Returns:

If the virtual stream file is open

.. index:: pair: function; getPositionPointer
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a8768894e6d7d1701112ed1c806b6ed98:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* getPositionPointer()



.. rubric:: Returns:

Pointer to the current position in the stream

.. index:: pair: function; getStreamPointer
.. _doxid-class_e_e_1_1_system_1_1_i_o_stream_string_1a0fa5b7bd3a6dca1aa176e9ebe7ebfb69:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const char* getStreamPointer() const



.. rubric:: Returns:

The pointer to the beggining of the stream