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

Visitor base class for Virtex-5 bitstream packets. More...

#include <bitstream/V5PacketVisitor.hpp>

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

List of all members.

Public Member Functions

virtual void visit (const BuswidthPattern &buswidthPattern)
 Relevant visit() method for Virtex-5 bitstreams.
virtual void visit (const DummyWord &dummyWord)
 Relevant visit() method for Virtex-5 bitstreams.
virtual void visit (const SyncWord &syncWord)
 Relevant visit() method for Virtex-5 bitstreams.
virtual void visit (const Type1Packet &type1Packet)
 Relevant visit() method for Virtex-5 bitstreams.
virtual void visit (const Type2Packet &type2Packet)
 Relevant visit() method for Virtex-5 bitstreams.
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 base class for Virtex-5 bitstream packets.

Visitor base class for visiting packets in Virtex-5 bitstreams. Throws an exception when visiting a non Virtex-5 packet. Purpose: if a new packet type is added to PacketVisitor ancestor class, then the corresponding visit() method should be defined in V5PacketVisitor to always throw an exception. So all concrete Virtex-5 visitors are not forced into implementing a from their perspective irrelevant visit() method; and when such a method is called, an exception is thrown.

Definition at line 32 of file V5PacketVisitor.hpp.


Member Function Documentation

void V5PacketVisitor::visit ( const BuswidthPattern buswidthPattern)
virtual

Relevant visit() method for Virtex-5 bitstreams.

This method is empty and should be overridden by concrete visitors to do something useful.

Parameters:
buswidthPatternBuswidthPattern instance to be visited.

Implements bil::PacketVisitor.

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

Definition at line 12 of file V5PacketVisitor.cpp.

void V5PacketVisitor::visit ( const DummyWord dummyWord)
virtual

Relevant visit() method for Virtex-5 bitstreams.

This method is empty and should be overridden by concrete visitors to do something useful.

Parameters:
dummyWordDummyWord instance to be visited.

Implements bil::PacketVisitor.

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

Definition at line 18 of file V5PacketVisitor.cpp.

void V5PacketVisitor::visit ( const SyncWord syncWord)
virtual

Relevant visit() method for Virtex-5 bitstreams.

This method is empty and should be overridden by concrete visitors to do something useful.

Parameters:
syncWordSyncWord instance to be visited.

Implements bil::PacketVisitor.

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

Definition at line 24 of file V5PacketVisitor.cpp.

void V5PacketVisitor::visit ( const Type1Packet type1Packet)
virtual

Relevant visit() method for Virtex-5 bitstreams.

This method is empty and should be overridden by concrete visitors to do something useful.

Parameters:
type1PacketType1Packet instance to be visited.

Implements bil::PacketVisitor.

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

Definition at line 30 of file V5PacketVisitor.cpp.

void V5PacketVisitor::visit ( const Type2Packet type2Packet)
virtual

Relevant visit() method for Virtex-5 bitstreams.

This method is empty and should be overridden by concrete visitors to do something useful.

Parameters:
type2PacketType2Packet instance to be visited.

Implements bil::PacketVisitor.

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

Definition at line 36 of file V5PacketVisitor.cpp.

void V5PacketVisitor::visit ( const Packet packet)
virtual

Irrelevant visit() method for Virtex-5 bitstreams.

This method throws an exception and need not be overridden by concrete visitors.

Parameters:
packetPacket instance to be visited.
Exceptions:
.

Implements bil::PacketVisitor.

Definition at line 42 of file V5PacketVisitor.cpp.


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