.. index:: pair: class; EE::System::BitOp
.. _doxid-class_e_e_1_1_system_1_1_bit_op:

class EE::System::BitOp
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~




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

	#include <bitop.hpp>
	
	class BitOp {
	public:
		// methods
	
		template <typename T>
		static void :ref:`writeBitKey<doxid-class_e_e_1_1_system_1_1_bit_op_1ad02300de6b95f03165b68c517f0ff101>`(T* Key, unsigned int Pos, unsigned int BitWrite);
	
		template <typename T>
		static bool :ref:`readBitKey<doxid-class_e_e_1_1_system_1_1_bit_op_1ab3d76b4aabf69e5d0751dbeccfd03949>`(T* Key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Pos);
	
		template <typename T>
		static void :ref:`setBitFlagValue<doxid-class_e_e_1_1_system_1_1_bit_op_1a2dd0229159861a1133fda1a3b1f27332>`(T* Key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Val, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` BitWrite);
	
		static :ref:`Uint16<doxid-namespace_e_e_1ae232c183cc9a0c087663cd838c93f0fc>` :ref:`swap16<doxid-class_e_e_1_1_system_1_1_bit_op_1a361b4b056f7b1ed1fda087ef89d43051>`(:ref:`Uint16<doxid-namespace_e_e_1ae232c183cc9a0c087663cd838c93f0fc>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swap32<doxid-class_e_e_1_1_system_1_1_bit_op_1a924c4cc42e6a5f19ef9c8c2aefea2b92>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :ref:`swap64<doxid-class_e_e_1_1_system_1_1_bit_op_1a04e61af102e27ebf50be7c5a1276224c>`(:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapBE16<doxid-class_e_e_1_1_system_1_1_bit_op_1ac72da399b802d92b564060abbcca6c6a>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapLE16<doxid-class_e_e_1_1_system_1_1_bit_op_1a1bc91da04566aa6aa027534df8ed8d59>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapBE32<doxid-class_e_e_1_1_system_1_1_bit_op_1a4402eaf2060a4c8d01da47b93c4f6cd9>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapLE32<doxid-class_e_e_1_1_system_1_1_bit_op_1afac6bc3f75a1f434989b4f9bde015313>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapBE64<doxid-class_e_e_1_1_system_1_1_bit_op_1af5e18f4112814a61c4212f0eaa1459ef>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
		static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` :ref:`swapLE64<doxid-class_e_e_1_1_system_1_1_bit_op_1a0e8ddcbafe404c99ad94527595a66b94>`(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key);
	};
.. _details-class_e_e_1_1_system_1_1_bit_op:

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



Methods
-------

.. index:: pair: function; writeBitKey
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1ad02300de6b95f03165b68c517f0ff101:

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

	template <typename T>
	static void writeBitKey(T* Key, unsigned int Pos, unsigned int BitWrite)

Write a bit into the Key in the position defined.



.. rubric:: Parameters:

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

	*
		- Key

		- The Key to write

	*
		- Pos

		- The Position of the bit

	*
		- BitWrite

		- 0 for write 0, any other to write 1.

.. index:: pair: function; readBitKey
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1ab3d76b4aabf69e5d0751dbeccfd03949:

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

	template <typename T>
	static bool readBitKey(T* Key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Pos)

Read a bit from a 32 bit key, in the position defined



.. rubric:: Parameters:

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

	*
		- Key

		- The Key to read

	*
		- Pos

		- The Position in the key to read



.. rubric:: Returns:

True if the bit is 1

.. index:: pair: function; setBitFlagValue
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a2dd0229159861a1133fda1a3b1f27332:

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

	template <typename T>
	static void setBitFlagValue(T* Key, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Val, :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` BitWrite)

Write a bit flag value



.. rubric:: Parameters:

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

	*
		- Key

		- The Key to write or remove

	*
		- Val

		- The Value to write or remove

	*
		- BitWrite

		- 0 to remove, any value to write

.. index:: pair: function; swap16
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a361b4b056f7b1ed1fda087ef89d43051:

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

	static :ref:`Uint16<doxid-namespace_e_e_1ae232c183cc9a0c087663cd838c93f0fc>` swap16(:ref:`Uint16<doxid-namespace_e_e_1ae232c183cc9a0c087663cd838c93f0fc>` Key)

Swap the bytes order for a 16 bit value

.. index:: pair: function; swap32
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a924c4cc42e6a5f19ef9c8c2aefea2b92:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swap32(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap the bytes order for a 32 bit value

.. index:: pair: function; swap64
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a04e61af102e27ebf50be7c5a1276224c:

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

	static :ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` swap64(:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` Key)

Swap the bytes order for a 64 bit value

.. index:: pair: function; swapBE16
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1ac72da399b802d92b564060abbcca6c6a:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapBE16(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap little endian 16 bit value to big endian

.. index:: pair: function; swapLE16
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a1bc91da04566aa6aa027534df8ed8d59:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapLE16(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap big endian 16 bit value to little endian

.. index:: pair: function; swapBE32
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a4402eaf2060a4c8d01da47b93c4f6cd9:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapBE32(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap little endian 32 bit value to big endian

.. index:: pair: function; swapLE32
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1afac6bc3f75a1f434989b4f9bde015313:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapLE32(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap big endian 32 bit value to little endian

.. index:: pair: function; swapBE64
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1af5e18f4112814a61c4212f0eaa1459ef:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapBE64(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap little endian 64 bit value to big endian

.. index:: pair: function; swapLE64
.. _doxid-class_e_e_1_1_system_1_1_bit_op_1a0e8ddcbafe404c99ad94527595a66b94:

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

	static :ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` swapLE64(:ref:`Uint32<doxid-namespace_e_e_1acb11e434631749f2da0e0004d6038558>` Key)

Swap big endian 64 bit value to little endian