KM3NETDAQ::JBit Struct Reference

Auxiliary data structure for single bit. More...

#include <JDAQ.hh>

Public Member Functions
	JBit ()
	Default constructor.
	JBit (int __bit)
	Constructor.
int	get () const
	Get bit mask.
void	set (int &mask) const
	Set bit in given bit mask.
void	unset (int &mask) const
	Unset bit in given bit mask.
void	set (int &mask, const bool value) const
	Set bit in given bit mask.
int	write (const int value) const
	Write given value as bit mask.
int	read (const int mask) const
	Read given bit mask as value.
bool	has (const int mask) const
	Test bit.

Public Attributes
int	bit
	bit

Detailed Description

Auxiliary data structure for single bit.

Definition at line 36 of file JDAQ.hh.

Constructor & Destructor Documentation

JBit() [1/2]

KM3NETDAQ::JBit::JBit ( )

inline

Default constructor.

Definition at line 40 of file JDAQ.hh.

           :
      bit(0)
    {}

JBit() [2/2]

KM3NETDAQ::JBit::JBit ( int __bit )

inline

Constructor.

Parameters

__bit

bit [0, 31]

Definition at line 50 of file JDAQ.hh.

                    :
      bit(__bit)
    {
      if (bit < 0 || bit > 31) {
        throw JDAQException("JBit: illegal bit range.");
      }
    }

Member Function Documentation

get()

int KM3NETDAQ::JBit::get ( ) const

inline

Get bit mask.

In the returned mask, the single bit at bit set to 1.

Returns

bit mask

Definition at line 66 of file JDAQ.hh.

    {
      return 1 << bit;
    }

set() [1/2]

void KM3NETDAQ::JBit::set ( int & mask ) const

inline

Set bit in given bit mask.

Parameters

mask	bit mask (I/O)

Definition at line 77 of file JDAQ.hh.

    {
      mask |=  get();
    }

unset()

void KM3NETDAQ::JBit::unset ( int & mask ) const

inline

Unset bit in given bit mask.

Parameters

mask	bit mask (I/O)

Definition at line 88 of file JDAQ.hh.

    {
      mask &= ~get();
    } 

set() [2/2]

void KM3NETDAQ::JBit::set ( int & mask, const bool value ) const

inline

Set bit in given bit mask.

Parameters

mask	bit mask (I/0)
value	bit status

Definition at line 100 of file JDAQ.hh.

    {
      if (value)
        set  (mask);
      else
        unset(mask);
    }

write()

int KM3NETDAQ::JBit::write ( const int value ) const

inline

Write given value as bit mask.

Parameters

value

value

Returns

bit mask

Definition at line 115 of file JDAQ.hh.

    {
      return (value << bit) & get();
    }

read()

int KM3NETDAQ::JBit::read ( const int mask ) const

inline

Read given bit mask as value.

Parameters

mask

bit mask

Returns

value

Definition at line 127 of file JDAQ.hh.

    {
      return (mask & get()) >> bit;
    }

has()

bool KM3NETDAQ::JBit::has ( const int mask ) const

inline

Test bit.

Parameters

mask

bit mask

Returns

true if bit set; else false

Definition at line 139 of file JDAQ.hh.

    {
      return (mask & get()) != 0;
    } 

Member Data Documentation

bit

int KM3NETDAQ::JBit::bit

bit

Definition at line 145 of file JDAQ.hh.

---

The documentation for this struct was generated from the following file:

• JDAQ.hh