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

A type 1 packet. More...

#include <bitstream/Type1Packet.hpp>

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

List of all members.

Public Member Functions

 Type1Packet ()
 Default constructor.
virtual Type1Packetclone () const
 Virtual constructor for doing polymorphic copies.
virtual void accept (PacketVisitor &visitor) const
 Accepts a visitor for dynamic type dependent stuff.
void registerAddress (RegisterAddress::address_t address)
 Sets register address.
RegisterAddress::address_t registerAddress () const
 Gets register address.
virtual void clear ()
 Zeros register address (additionally to inherited behavior).
- Public Member Functions inherited from bil::Type2Packet
 Type2Packet ()
 Default constructor.
void opcode (PacketOpcode::opcode_t opcode)
 Sets packet opcode.
PacketOpcode::opcode_t opcode () const
 Gets packet opcode.
void wordCount (size_t count)
 Sets word count.
size_t wordCount () const
 Gets word count.
boost::uint32_t * dataWords ()
 Gets a pointer to payload data.
const boost::uint32_t * dataWords () const
 Gets a pointer to read only payload data.
- Public Member Functions inherited from bil::Packet
virtual ~Packet ()
 Destructs a Packet instance.

Detailed Description

A type 1 packet.

The type 1 packet carries besides opcode and data a register address. This address tells the configuration logic which register should be read or in which register the packet data should be written.

Definition at line 23 of file Type1Packet.hpp.


Constructor & Destructor Documentation

Type1Packet::Type1Packet ( )

Default constructor.

Definition at line 12 of file Type1Packet.cpp.


Member Function Documentation

Type1Packet * Type1Packet::clone ( ) const
virtual

Virtual constructor for doing polymorphic copies.

Returns:
Pointer to the copied instance.

Reimplemented from bil::Type2Packet.

Definition at line 19 of file Type1Packet.cpp.

void Type1Packet::accept ( PacketVisitor visitor) const
virtual

Accepts a visitor for dynamic type dependent stuff.

Parameters:
visitorVisitor, which matching method will be called.

Reimplemented from bil::Type2Packet.

Definition at line 25 of file Type1Packet.cpp.

void Type1Packet::registerAddress ( RegisterAddress::address_t  address)

Sets register address.

Parameters:
addressNew register address.

Definition at line 31 of file Type1Packet.cpp.

RegisterAddress::address_t Type1Packet::registerAddress ( ) const

Gets register address.

Returns:
Current register address.

Definition at line 37 of file Type1Packet.cpp.

void Type1Packet::clear ( )
virtual

Zeros register address (additionally to inherited behavior).

Reimplemented from bil::Type2Packet.

Definition at line 43 of file Type1Packet.cpp.


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