bil::PIPBitValue Class Reference

The value of a PIPs associated configuration bits. More...

#include <mappingdb/PIPBitValue.hpp>

List of all members.

Public Member Functions
	PIPBitValue ()
	Constructs a new PIPBitValue instance.
void	pipIndex (size_t index)
	Sets PIP index.
size_t	pipIndex () const
	Gets pip index.
void	bitValue (boost::uint32_t value)
	Sets active PIP configuration value.
boost::uint32_t	bitValue () const
	Gets active PIP configuration value.
void	clear ()
	Resets all properties to default values.

Static Public Attributes
static const boost::uint32_t	MAX_BIT_COUNT = 31
	constant for maximum bits in value
static const boost::uint32_t	VALUE_UNUSED = 0x80000000
	bit mask for the used/unused bit flag

Friends
bool	operator== (const PIPBitValue &val1, const PIPBitValue &val2)
	Tests two PIPBitValue instances for memberwise equality.
bool	operator< (const PIPBitValue &val1, const PIPBitValue &val2)
	Tests two PIPBitValue instances for memberwise <.
void	writeBinary (const PIPBitValue &data, std::ostream &outputStream)
	Writes data from a PIPBitValue into a binary stream.
void	readBinary (PIPBitValue &data, std::istream &inputStream)
	Reads data into a PIPBitValue from a binary stream.

---

Detailed Description

The value of a PIPs associated configuration bits.

This class associates a PIP with the value of its configuration bits. Whenever the associated bits resemble this value, this PIP is active.

Definition at line 23 of file PIPBitValue.hpp.

---

Constructor & Destructor Documentation

PIPBitValue::PIPBitValue

(

)

Constructs a new PIPBitValue instance.

Definition at line 11 of file PIPBitValue.cpp.

---

Member Function Documentation

void PIPBitValue::pipIndex

(

size_t

index

)

Sets PIP index.

Parameters:

index

Index of PIP in corresponding Device.

Definition at line 19 of file PIPBitValue.cpp.

size_t PIPBitValue::pipIndex

(

)

const

Gets pip index.

Returns:

Index of PIP in corresponding Device.

Definition at line 25 of file PIPBitValue.cpp.

void PIPBitValue::bitValue

(

boost::uint32_t

value

)

Sets active PIP configuration value.

Parameters:

value

Value of the PIPs configuration bits.

Definition at line 31 of file PIPBitValue.cpp.

boost::uint32_t PIPBitValue::bitValue

(

)

const

Gets active PIP configuration value.

Returns:

Value of the PIPs configuration bits.

Definition at line 37 of file PIPBitValue.cpp.

void PIPBitValue::clear

(

)

Resets all properties to default values.

Definition at line 43 of file PIPBitValue.cpp.

---

Friends And Related Function Documentation

bool operator== ( const PIPBitValue &  val1, const PIPBitValue &  val2  )

friend

Tests two PIPBitValue instances for memberwise equality.

Definition at line 101 of file PIPBitValue.hpp.

bool operator< ( const PIPBitValue &  val1, const PIPBitValue &  val2  )

friend

Tests two PIPBitValue instances for memberwise <.

Definition at line 115 of file PIPBitValue.hpp.

void writeBinary ( const PIPBitValue &  data, std::ostream &  outputStream  )

friend

Writes data from a PIPBitValue into a binary stream.

Parameters:

data	The PIPBitValue to write.
outputStream	The stream to write into.

Exceptions:

.

void readBinary ( PIPBitValue &  data, std::istream &  inputStream  )

friend

Reads data into a PIPBitValue from a binary stream.

Parameters:

data	The PIPBitValue to read into.
inputStream	The stream to read from.

Exceptions:

.

---

Member Data Documentation

const boost::uint32_t bil::PIPBitValue::MAX_BIT_COUNT = 31

static

constant for maximum bits in value

Definition at line 58 of file PIPBitValue.hpp.

const boost::uint32_t bil::PIPBitValue::VALUE_UNUSED = 0x80000000

static

bit mask for the used/unused bit flag

Definition at line 61 of file PIPBitValue.hpp.

---

The documentation for this class was generated from the following files:

• mappingdb/PIPBitValue.hpp
• mappingdb/PIPBitValue.cpp