KM3NETDAQ::JBits Struct Reference

Auxiliary data structure for range of bits. More...

#include <JDAQ.hh>

Public Member Functions
	JBits ()
	Default constructor.
	JBits (int __lsb, int __msb)
	Constructor.
int	get () const
	Get 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 mask.

Public Attributes
int	lsb
	least significant bit
int	msb
	most significant bit

Detailed Description

Auxiliary data structure for range of bits.

Definition at line 152 of file JDAQ.hh.

Constructor & Destructor Documentation

JBits() [1/2]

KM3NETDAQ::JBits::JBits ( )

inline

Default constructor.

Definition at line 156 of file JDAQ.hh.

            :
      lsb(0),
      msb(0)
    {}

JBits() [2/2]

KM3NETDAQ::JBits::JBits ( int __lsb, int __msb )

inline

Constructor.

Parameters

__lsb	least significant bit [0, 31]
__msb	most significant bit [lsb, 31]

Definition at line 168 of file JDAQ.hh.

                                :
      lsb(__lsb),
      msb(__msb)
    {
      if (lsb < 0   || lsb > 31 ||
          msb < lsb || msb > 31) {
        throw JDAQException("JBits: illegal bit range.");
      }
    }

Member Function Documentation

get()

int KM3NETDAQ::JBits::get ( ) const

inline

Get bit mask.

In the returned mask, the bits from lsb (included) to msb (included) are set to 1.

Returns

bit mask

Definition at line 186 of file JDAQ.hh.

    {
      static const unsigned int mask[] = { 0x00000001,
                                           0x00000003,
                                           0x00000007,
                                           0x0000000F,
                                           
                                           0x0000001F,
                                           0x0000003F,
                                           0x0000007F,
                                           0x000000FF,
                                  
                                           0x000001FF,
                                           0x000003FF,
                                           0x000007FF,
                                           0x00000FFF,
                                           
                                           0x00001FFF,
                                           0x00003FFF,
                                           0x00007FFF,
                                           0x0000FFFF,
                                           
                                           0x0001FFFF,
                                           0x0003FFFF,
                                           0x0007FFFF,
                                           0x000FFFFF,
                                           
                                           0x001FFFFF,
                                           0x003FFFFF,
                                           0x007FFFFF,
                                           0x00FFFFFF,
                                           
                                           0x01FFFFFF,
                                           0x03FFFFFF,
                                           0x07FFFFFF,
                                           0x0FFFFFFF,
                                           
                                           0x1FFFFFFF,
                                           0x3FFFFFFF,
                                           0x7FFFFFFF,
                                           0xFFFFFFFF };
 
      return (int) (mask[msb-lsb] << lsb);
    }

write()

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

inline

Write given value as bit mask.

Parameters

value

value

Returns

bit mask

Definition at line 238 of file JDAQ.hh.

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

read()

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

inline

Read given bit mask as value.

Parameters

mask

bit mask

Returns

value

Definition at line 250 of file JDAQ.hh.

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

has()

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

inline

Test bit mask.

Parameters

mask

bit mask

Returns

true if at least one of the bits is set; else false

Definition at line 262 of file JDAQ.hh.

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

Member Data Documentation

lsb

int KM3NETDAQ::JBits::lsb

least significant bit

Definition at line 268 of file JDAQ.hh.

msb

int KM3NETDAQ::JBits::msb

most significant bit

Definition at line 269 of file JDAQ.hh.

---

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

• JDAQ.hh