Bitstream Interpretation Library (BIL)  0.1
Public Member Functions
bil::V5BitstreamSyntaxChecker Class Reference

Visitor for checking syntax of a Virtex-5 bitstream. More...

#include <bitstream/V5BitstreamSyntaxChecker.hpp>

Inheritance diagram for bil::V5BitstreamSyntaxChecker:
Inheritance graph
[legend]
Collaboration diagram for bil::V5BitstreamSyntaxChecker:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 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.
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::V5PacketVisitor
virtual void visit (const Packet &packet)
 Irrelevant visit() method for Virtex-5 bitstreams.
- Public Member Functions inherited from bil::PacketVisitor
virtual ~PacketVisitor ()

Detailed Description

Visitor for checking syntax of a Virtex-5 bitstream.

A Packet visitor that checks the syntactical correctness of a Virtex-5 bitstream. That means, that the packets have to be in the right order and number, and have to be of types that are valid for Virtex-5 bitstreams. Every time a packet is given to a V5BitstreamSyntaxChecker instance, it updates its state. In case of a syntax error it throws an exception.

Definition at line 24 of file V5BitstreamSyntaxChecker.hpp.


Constructor & Destructor Documentation

V5BitstreamSyntaxChecker::V5BitstreamSyntaxChecker ( )

Definition at line 12 of file V5BitstreamSyntaxChecker.cpp.


Member Function Documentation

bool V5BitstreamSyntaxChecker::behindSyncWord ( ) const

Tells, if sync word was passed.

Returns:
True if sync word was passed, false otherwise.

Definition at line 18 of file V5BitstreamSyntaxChecker.cpp.

bool V5BitstreamSyntaxChecker::lastPacketWasType1 ( ) const

Tells, if the last packet processed was a type 1 packet.

Returns:
True if last packet was a type 1 packet, false otherwise.

Definition at line 24 of file V5BitstreamSyntaxChecker.cpp.

RegisterAddress::address_t V5BitstreamSyntaxChecker::lastType1Address ( ) const

Gets the register address of the last processed type 1 packet.

Returns:
The register address.

Definition at line 30 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::reset ( )
virtual

Resets the internal state.

Reimplemented in bil::V5PacketProcessor, and bil::V5BitstreamDeviceDetector.

Definition at line 36 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::visit ( const BuswidthPattern buswidthPattern)
virtual

Visits a BuswidthPattern packet.

Parameters:
buswidthPatternBuswidthPattern instance to be visited.
Exceptions:
.

Reimplemented from bil::V5PacketVisitor.

Reimplemented in bil::V5BitstreamXMLWriter.

Definition at line 45 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::visit ( const DummyWord dummyWord)
virtual

Visits a DummyWord packet.

Never throws, since dummy words can be everywhere.

Parameters:
dummyWordDummyWord instance to be visited.

Reimplemented from bil::V5PacketVisitor.

Reimplemented in bil::V5PacketProcessor, and bil::V5BitstreamXMLWriter.

Definition at line 53 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::visit ( const SyncWord syncWord)
virtual

Visits a SyncWord packet.

Parameters:
syncWordSyncWord instance to be visited.
Exceptions:
.

Reimplemented from bil::V5PacketVisitor.

Reimplemented in bil::V5BitstreamXMLWriter.

Definition at line 60 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::visit ( const Type1Packet type1Packet)
virtual

Visits a Type1Packet packet.

Parameters:
type1PacketType1Packet instance to be visited.
Exceptions:
.

Reimplemented from bil::V5PacketVisitor.

Reimplemented in bil::V5BitstreamXMLWriter, bil::V5BitstreamDeviceDetector, and bil::V5PacketProcessor.

Definition at line 69 of file V5BitstreamSyntaxChecker.cpp.

void V5BitstreamSyntaxChecker::visit ( const Type2Packet type2Packet)
virtual

Visits a Type2Packet packet.

Parameters:
type2PacketType2Packet instance to be visited.
Exceptions:
.

Reimplemented from bil::V5PacketVisitor.

Reimplemented in bil::V5BitstreamXMLWriter, bil::V5BitstreamDeviceDetector, and bil::V5PacketProcessor.

Definition at line 79 of file V5BitstreamSyntaxChecker.cpp.


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