bil::DummyWord Class Reference

A word of dummy data. More...

#include <bitstream/DummyWord.hpp>

Inheritance diagram for bil::DummyWord:

Collaboration diagram for bil::DummyWord:

List of all members.

Public Member Functions
	DummyWord ()
	Default constructor.
virtual DummyWord *	clone () const
	Virtual constructor for doing polymorphic copies.
virtual void	accept (PacketVisitor &visitor) const
	Accepts a visitor for dynamic type dependent stuff.
void	value (boost::uint32_t dummyValue)
	Sets the dummy value.
boost::uint32_t	value () const
	Gets the dummy value.
Public Member Functions inherited from bil::Packet
virtual	~Packet ()
	Destructs a Packet instance.

Static Public Attributes
static const boost::uint32_t	NULL_WORD = 0x00000000
	a frequent dummy data value
static const boost::uint32_t	FULL_WORD = 0xffffffff
	a frequent dummy data value

---

Detailed Description

A word of dummy data.

Sometimes it is necessary to insert dummy data into a bitstream; for this purpose serves the DummyWord class. It contains one 32 bit word for holding its dummy value.

Definition at line 23 of file DummyWord.hpp.

---

Constructor & Destructor Documentation

DummyWord::DummyWord

(

)

Default constructor.

Definition at line 12 of file DummyWord.cpp.

---

Member Function Documentation

DummyWord * DummyWord::clone ( ) const

virtual

Virtual constructor for doing polymorphic copies.

Returns:

Pointer to the copied instance.

Implements bil::Packet.

Definition at line 19 of file DummyWord.cpp.

void DummyWord::accept ( PacketVisitor &  visitor ) const

virtual

Accepts a visitor for dynamic type dependent stuff.

Parameters:

visitor

Visitor, which matching method will be called.

Implements bil::Packet.

Definition at line 25 of file DummyWord.cpp.

void DummyWord::value

(

boost::uint32_t

dummyValue

)

Sets the dummy value.

Parameters:

dummyValue

The 32 bit word dummy value.

Definition at line 31 of file DummyWord.cpp.

boost::uint32_t DummyWord::value

(

)

const

Gets the dummy value.

Returns:

The 32 bit dummy value.

Definition at line 37 of file DummyWord.cpp.

---

Member Data Documentation

const boost::uint32_t bil::DummyWord::NULL_WORD = 0x00000000

static

a frequent dummy data value

Definition at line 58 of file DummyWord.hpp.

const boost::uint32_t bil::DummyWord::FULL_WORD = 0xffffffff

static

a frequent dummy data value

Definition at line 61 of file DummyWord.hpp.

---

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

• bitstream/DummyWord.hpp
• bitstream/DummyWord.cpp