bil::V5BitstreamXMLWriter Class Reference

Writes a Virtex-5 bitstream into XML. More...

#include <bitstream/V5BitstreamXMLWriter.hpp>

Inheritance diagram for bil::V5BitstreamXMLWriter:

Collaboration diagram for bil::V5BitstreamXMLWriter:

List of all members.

Public Member Functions
	V5BitstreamXMLWriter (XMLWriter &xmlWriter)
	Creates a new V5BitstreamXMLWriter instance.
virtual void	visit (const BuswidthPattern &buswidthPattern)
	Visits a BuswidthPattern packet.
virtual void	visit (const DummyWord &dummyWord)
	Visits a DummyWord packet.
virtual void	visit (const SyncWord &syncWord)
	Visits a SyncWord packet.
virtual void	visit (const Type1Packet &type1Packet)
	Visits a Type1Packet packet.
virtual void	visit (const Type2Packet &type2Packet)
	Visits a Type2Packet packet.
Public Member Functions inherited from bil::V5BitstreamSyntaxChecker
	V5BitstreamSyntaxChecker ()
bool	behindSyncWord () const
	Tells, if sync word was passed.
bool	lastPacketWasType1 () const
	Tells, if the last packet processed was a type 1 packet.
RegisterAddress::address_t	lastType1Address () const
	Gets the register address of the last processed type 1 packet.
virtual void	reset ()
	Resets the internal state.
Public Member Functions inherited from bil::V5PacketVisitor
virtual void	visit (const Packet &packet)
	Irrelevant visit() method for Virtex-5 bitstreams.
Public Member Functions inherited from bil::PacketVisitor
virtual	~PacketVisitor ()

Protected Member Functions
void	writePacketTag (const BuswidthPattern &buswidthPattern)
	Writes a BuswidthPattern packet into XML.
void	writePacketTag (const DummyWord &dummyWord)
	Writes a DummyWord packet into XML.
void	writePacketTag (const SyncWord &syncWord)
	Writes a SyncWord packet into XML.
void	writePacketTag (const std::string &tagName, const Type2Packet &type2Packet)
	Writes a Type2Packet packet (and its descendants) into XML.
void	writeData (const boost::uint32_t *words, size_t wordCount)
	Writes packet payload data into XML.

---

Detailed Description

Writes a Virtex-5 bitstream into XML.

Being based on the V5BitstreamSyntaxChecker, V5BitstreamXMLWriter syntax checks the packet sequence and writes every visited packet out to XML using a given XMLWriter.

Definition at line 26 of file V5BitstreamXMLWriter.hpp.

---

Constructor & Destructor Documentation

V5BitstreamXMLWriter::V5BitstreamXMLWriter ( XMLWriter &  xmlWriter )

explicit

Creates a new V5BitstreamXMLWriter instance.

Parameters:

xmlWriter

The XMLWriter instance to be used for writing.

Definition at line 30 of file V5BitstreamXMLWriter.cpp.

---

Member Function Documentation

void V5BitstreamXMLWriter::visit ( const BuswidthPattern &  buswidthPattern )

virtual

Visits a BuswidthPattern packet.

Parameters:

buswidthPattern

BuswidthPattern instance to be visited.

Exceptions:

.

Reimplemented from bil::V5BitstreamSyntaxChecker.

Definition at line 37 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::visit ( const DummyWord &  dummyWord )

virtual

Visits a DummyWord packet.

Parameters:

dummyWord

DummyWord instance to be visited.

Exceptions:

.

Reimplemented from bil::V5BitstreamSyntaxChecker.

Definition at line 44 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::visit ( const SyncWord &  syncWord )

virtual

Visits a SyncWord packet.

Parameters:

syncWord

SyncWord instance to be visited.

Exceptions:

.

Reimplemented from bil::V5BitstreamSyntaxChecker.

Definition at line 51 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::visit ( const Type1Packet &  type1Packet )

virtual

Visits a Type1Packet packet.

Parameters:

type1Packet

Type1Packet instance to be visited.

Exceptions:

.

Reimplemented from bil::V5BitstreamSyntaxChecker.

Definition at line 58 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::visit ( const Type2Packet &  type2Packet )

virtual

Visits a Type2Packet packet.

Parameters:

type2Packet

Type2Packet instance to be visited.

Exceptions:

.

Reimplemented from bil::V5BitstreamSyntaxChecker.

Definition at line 65 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::writePacketTag ( const BuswidthPattern &  buswidthPattern )

protected

Writes a BuswidthPattern packet into XML.

Parameters:

buswidthPattern

BuswidthPattern instance to be written.

Exceptions:

.

Definition at line 72 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::writePacketTag ( const DummyWord &  dummyWord )

protected

Writes a DummyWord packet into XML.

Parameters:

dummyWord

DummyWord instance to be written.

Exceptions:

.

Definition at line 79 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::writePacketTag ( const SyncWord &  syncWord )

protected

Writes a SyncWord packet into XML.

Parameters:

syncWord

SyncWord instance to be written.

Exceptions:

.

Definition at line 87 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::writePacketTag ( const std::string &  tagName, const Type2Packet &  type2Packet  )

protected

Writes a Type2Packet packet (and its descendants) into XML.

Parameters:

tagName	XML tag to use.
type2Packet	Type2Packet instance to be written.

Exceptions:

.

Definition at line 94 of file V5BitstreamXMLWriter.cpp.

void V5BitstreamXMLWriter::writeData ( const boost::uint32_t *  words, size_t  wordCount  )

protected

Writes packet payload data into XML.

Parameters:

words	Pointer to data words to write.
wordCount	Number of data words to write.

Exceptions:

.

Definition at line 127 of file V5BitstreamXMLWriter.cpp.

---

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

• bitstream/V5BitstreamXMLWriter.hpp
• bitstream/V5BitstreamXMLWriter.cpp