commit a47e80f9302e92215b0671a9a7d41c7a427d2da6 Author: Srivats P Date: Wed Jul 22 19:05:24 2015 +0530 Adding doxydocs diff --git a/doxydocs/class_abstract_protocol-members.html b/doxydocs/class_abstract_protocol-members.html new file mode 100644 index 0000000..b3c4be7 --- /dev/null +++ b/doxydocs/class_abstract_protocol-members.html @@ -0,0 +1,110 @@ + + + + + +Member List + + + + + + + +
+ + + +
+
+
+
AbstractProtocol Member List
+
+
+This is the complete list of members for AbstractProtocol, including all inherited members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
_cacheFlags (defined in AbstractProtocol)AbstractProtocol [protected]
_hasPayloadAbstractProtocol [protected]
AbstractProtocol(StreamBase *stream, AbstractProtocol *parent=0)AbstractProtocol
appendVariableField(const OstProto::VariableField &vf)AbstractProtocol
CacheFlag enum nameAbstractProtocol [protected]
CksumField enum valueAbstractProtocol
CksumIp enum valueAbstractProtocol
CksumIpPseudo enum valueAbstractProtocol
CksumMax enum valueAbstractProtocol
CksumScope enum nameAbstractProtocol
CksumScopeAdjacentProtocol enum valueAbstractProtocol
CksumScopeAllProtocols enum valueAbstractProtocol
CksumTcpUdp enum valueAbstractProtocol
CksumType enum nameAbstractProtocol
ComboProtocol (defined in AbstractProtocol)AbstractProtocol [friend]
commonProtoDataCopyFrom(const OstProto::Protocol &protocol)AbstractProtocol
commonProtoDataCopyInto(OstProto::Protocol &protocol) const AbstractProtocol
createInstance(StreamBase *stream, AbstractProtocol *parent=0)AbstractProtocol [static]
FieldAttrib enum nameAbstractProtocol
FieldBitSize enum valueAbstractProtocol
fieldCount() const AbstractProtocol [virtual]
fieldData(int index, FieldAttrib attrib, int streamIndex=0) const AbstractProtocol [virtual]
FieldFlag enum nameAbstractProtocol
fieldFlags(int index) const AbstractProtocol [virtual]
fieldFrameBitOffset(int index, int streamIndex=0) const AbstractProtocol
FieldFrameBitOffsetCache enum value (defined in AbstractProtocol)AbstractProtocol [protected]
FieldFrameValue enum valueAbstractProtocol
FieldName enum valueAbstractProtocol
FieldTextValue enum valueAbstractProtocol
FieldValue enum valueAbstractProtocol
FrameField enum valueAbstractProtocol
frameFieldCount() const AbstractProtocol [virtual]
gcd(quint64 u, quint64 v) (defined in AbstractProtocol)AbstractProtocol [static]
isProtocolFramePayloadSizeVariable() const AbstractProtocol
isProtocolFramePayloadValueVariable() const AbstractProtocol
isProtocolFrameSizeVariable() const AbstractProtocol [virtual]
isProtocolFrameValueVariable() const AbstractProtocol [virtual]
lcm(quint64 u, quint64 v) (defined in AbstractProtocol)AbstractProtocol [static]
MetaField enum valueAbstractProtocol
metaFieldCount() const AbstractProtocol
mpStreamAbstractProtocol [protected]
mutableVariableField(int index)AbstractProtocol
name() const AbstractProtocol [virtual]
nextAbstractProtocol [protected]
parentAbstractProtocol [protected]
payloadProtocolId(ProtocolIdType type) const AbstractProtocol
prevAbstractProtocol [protected]
protocolFrameCksum(int streamIndex=0, CksumType cksumType=CksumIp) const AbstractProtocol [virtual]
protocolFrameHeaderCksum(int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAdjacentProtocol) const AbstractProtocol
protocolFrameOffset(int streamIndex=0) const AbstractProtocol
protocolFramePayloadCksum(int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAllProtocols) const AbstractProtocol
protocolFramePayloadSize(int streamIndex=0) const AbstractProtocol
protocolFramePayloadVariableCount() const AbstractProtocol
protocolFrameSize(int streamIndex=0) const AbstractProtocol [virtual]
protocolFrameValue(int streamIndex=0, bool forCksum=false) const AbstractProtocol
protocolFrameVariableCount() const AbstractProtocol [virtual]
protocolHasPayload() const AbstractProtocol
protocolId(ProtocolIdType type) const AbstractProtocol [virtual]
ProtocolIdEth enum valueAbstractProtocol
ProtocolIdIp enum valueAbstractProtocol
ProtocolIdLlc enum valueAbstractProtocol
ProtocolIdNone enum valueAbstractProtocol
ProtocolIdTcpUdp enum valueAbstractProtocol
ProtocolIdType enum nameAbstractProtocol
protocolIdType() const AbstractProtocol [virtual]
ProtocolListIterator (defined in AbstractProtocol)AbstractProtocol [friend]
protocolNumber() const AbstractProtocol [virtual]
protoDataCopyFrom(const OstProto::Protocol &protocol)=0AbstractProtocol [pure virtual]
protoDataCopyInto(OstProto::Protocol &protocol) const =0AbstractProtocol [pure virtual]
removeVariableField(int index)AbstractProtocol
setFieldData(int index, const QVariant &value, FieldAttrib attrib=FieldValue)AbstractProtocol [virtual]
shortName() const AbstractProtocol [virtual]
variableField(int index) const AbstractProtocol
variableFieldCount() const AbstractProtocol
~AbstractProtocol()AbstractProtocol [virtual]
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/class_abstract_protocol.html b/doxydocs/class_abstract_protocol.html new file mode 100644 index 0000000..bb1ddd8 --- /dev/null +++ b/doxydocs/class_abstract_protocol.html @@ -0,0 +1,1369 @@ + + + + + +AbstractProtocol Class Reference + + + + + + + +
+ + + +
+
+
+Public Types | +Public Member Functions | +Static Public Member Functions | +Protected Types | +Protected Attributes | +Friends
+
+
AbstractProtocol Class Reference
+
+
+ +

AbstractProtocol is the base abstract class which provides the interface for all protocols. + More...

+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Types

enum  FieldFlag { FrameField = 0x1, +MetaField = 0x2, +CksumField = 0x4 + }
 Properties of a field, can be OR'd. More...
enum  FieldAttrib {
+  FieldName, +FieldValue, +FieldTextValue, +FieldFrameValue, +
+  FieldBitSize +
+ }
 Various attributes of a field. More...
enum  ProtocolIdType {
+  ProtocolIdNone, +ProtocolIdLlc, +ProtocolIdEth, +ProtocolIdIp, +
+  ProtocolIdTcpUdp +
+ }
 Supported Protocol Id types. More...
enum  CksumType { CksumIp, +CksumIpPseudo, +CksumTcpUdp, +CksumMax + }
 Supported checksum types. More...
enum  CksumScope { CksumScopeAdjacentProtocol, +CksumScopeAllProtocols + }
 Supported checksum scopes. More...

+Public Member Functions

 AbstractProtocol (StreamBase *stream, AbstractProtocol *parent=0)
 Constructs an abstract protocol for the given stream and parent.
virtual ~AbstractProtocol ()
 Destroys the abstract protocol.
virtual quint32 protocolNumber () const
 Returns the protocol's field number as defined in message 'Protocol', enum 'k' (file: protocol.proto)
void commonProtoDataCopyInto (OstProto::Protocol &protocol) const
 Copies the common data (not specific to individual protocols) in the protocol member protobuf data into the passed in protocol parameter.
void commonProtoDataCopyFrom (const OstProto::Protocol &protocol)
 Copies the common data (not specific to individual protocols) from the passed in param protocol protobuf into the member protobuf data.
virtual void protoDataCopyInto (OstProto::Protocol &protocol) const =0
 Copy the protocol's protobuf as an extension into the passed in protocol.
virtual void protoDataCopyFrom (const OstProto::Protocol &protocol)=0
 Copy and update the protocol's protobuf member data variable from the passed in protocol.
virtual QString name () const
 Returns the full name of the protocol.
virtual QString shortName () const
 Returns the short name or abbreviation of the protocol.
virtual ProtocolIdType protocolIdType () const
 Returns the protocolIdType for the protocol.
virtual quint32 protocolId (ProtocolIdType type) const
 Returns the protocol id of the protocol for the given type.
quint32 payloadProtocolId (ProtocolIdType type) const
 Returns the protocol id of the payload protocol (the protocol that immediately follows the current one)
virtual int fieldCount () const
 Returns the number of fields in the protocol (both Frame fields and Meta fields)
int metaFieldCount () const
 Returns the number of meta fields.
virtual int frameFieldCount () const
 Returns the number of frame fields.
virtual FieldFlags fieldFlags (int index) const
 Returns the field flags for the passed in field index.
virtual QVariant fieldData (int index, FieldAttrib attrib, int streamIndex=0) const
 Returns the requested field attribute data.
virtual bool setFieldData (int index, const QVariant &value, FieldAttrib attrib=FieldValue)
 Sets the value of a field corresponding to index.
int fieldFrameBitOffset (int index, int streamIndex=0) const
 Returns the bit offset where the specified field starts within the protocolFrameValue()
int variableFieldCount () const
 Returns the count of variableFields in the protocol.
void appendVariableField (const OstProto::VariableField &vf)
 Appends a variableField to the protocol.
void removeVariableField (int index)
 Removes the variableField from the protocol at the specified index.
const OstProto::VariableField & variableField (int index) const
 Returns the variableField at the specified index as a constant Reference i.e.
OstProto::VariableField * mutableVariableField (int index)
 Returns the variableField at the specified index as a mutable pointer.
QByteArray protocolFrameValue (int streamIndex=0, bool forCksum=false) const
 Returns a byte array encoding the protocol (and its fields) which can be inserted into the stream's frame.
virtual int protocolFrameSize (int streamIndex=0) const
 Returns the protocol's size in bytes.
int protocolFrameOffset (int streamIndex=0) const
 Returns the byte offset in the packet where the protocol starts.
int protocolFramePayloadSize (int streamIndex=0) const
 Returns the size of the payload in bytes.
virtual bool isProtocolFrameValueVariable () const
 Returns true if the protocol varies one or more of its fields at run-time, false otherwise.
virtual bool isProtocolFrameSizeVariable () const
 Returns true if the protocol varies its size at run-time, false otherwise.
virtual int protocolFrameVariableCount () const
 Returns the minimum number of frames required for the protocol to vary its fields.
bool isProtocolFramePayloadValueVariable () const
 Returns true if the payload content for a protocol varies at run-time, false otherwise.
bool isProtocolFramePayloadSizeVariable () const
 Returns true if the payload size for a protocol varies at run-time, false otherwise.
int protocolFramePayloadVariableCount () const
 Returns true if the payload size for a protocol varies at run-time, false otherwise.
bool protocolHasPayload () const
 Returns true if the protocol typically contains a payload or other protocols following it e.g.
virtual quint32 protocolFrameCksum (int streamIndex=0, CksumType cksumType=CksumIp) const
 Returns the checksum (of the requested type) of the protocol's contents.
quint32 protocolFrameHeaderCksum (int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAdjacentProtocol) const
 Returns the checksum of the requested type for the protocol's header.
quint32 protocolFramePayloadCksum (int streamIndex=0, CksumType cksumType=CksumIp, CksumScope cksumScope=CksumScopeAllProtocols) const
 Returns the checksum of the requested type for the protocol's payload.

+Static Public Member Functions

static AbstractProtocol * createInstance (StreamBase *stream, AbstractProtocol *parent=0)
 Allocates and returns a new instance of the class.
+static quint64 lcm (quint64 u, quint64 v)
+static quint64 gcd (quint64 u, quint64 v)

+Protected Types

enum  CacheFlag { FieldFrameBitOffsetCache = 0x1 + }
 Caching Control Flags. More...

+Protected Attributes

StreamBase * mpStream
 Stream that this protocol belongs to.
AbstractProtocol * parent
 Parent protocol, if any.
AbstractProtocol * prev
 Protocol preceding this protocol.
AbstractProtocol * next
 Protocol succeeding this protocol.
bool _hasPayload
 Is protocol typically followed by payload or another protocol.
+quint32 _cacheFlags

+Friends

+class ComboProtocol
+class ProtocolListIterator
+

Detailed Description

+

AbstractProtocol is the base abstract class which provides the interface for all protocols.

+

All protocols supported by Ostinato are derived from AbstractProtocol. Apart from defining the interface for a protocol, it also provides sensible default implementations for methods so that the subclasses need not re-implement. It also provides convenience functions for subclasses to use such as methods to retrieve payload size, checksum etc.

+

A subclass typically needs to reimplement the following methods -

+ +

Depending on certain conditions, subclasses may need to reimplement the following additional methods -

+ +

See the description of the methods for more information.

+

Most of the above methods just need some standard boilerplate code - the SampleProtocol implementation includes the boilerplate

+

Member Enumeration Documentation

+ +
+
+ + + + +
enum AbstractProtocol::CacheFlag [protected]
+
+
+ +

Caching Control Flags.

+ +
+
+ +
+
+ + + + +
enum AbstractProtocol::CksumScope
+
+
+ +

Supported checksum scopes.

+
Enumerator:
+ + +
CksumScopeAdjacentProtocol  +

Cksum only the adjacent protocol.

+
CksumScopeAllProtocols  +

Cksum over all the protocols.

+
+
+
+ +
+
+ +
+
+ + + + +
enum AbstractProtocol::CksumType
+
+
+ +

Supported checksum types.

+
Enumerator:
+ + + + +
CksumIp  +

Standard IP Checksum.

+
CksumIpPseudo  +

Standard checksum for Pseudo-IP header.

+
CksumTcpUdp  +

Standard TCP/UDP checksum including pseudo-IP.

+
CksumMax  +

Marker for number of cksum types.

+
+
+
+ +
+
+ +
+
+ + + + +
enum AbstractProtocol::FieldAttrib
+
+
+ +

Various attributes of a field.

+
Enumerator:
+ + + + + +
FieldName  +

name

+
FieldValue  +

value in host byte order (user editable)

+
FieldTextValue  +

value as text

+
FieldFrameValue  +

frame encoded value in network byte order

+
FieldBitSize  +

size in bits

+
+
+
+ +
+
+ +
+
+ + + + +
enum AbstractProtocol::FieldFlag
+
+
+ +

Properties of a field, can be OR'd.

+
Enumerator:
+ + + +
FrameField  +

field appears in frame content

+
MetaField  +

field does not appear in frame, is meta data

+
CksumField  +

field is a checksum and appears in frame content

+
+
+
+ +
+
+ +
+
+ + + + +
enum AbstractProtocol::ProtocolIdType
+
+
+ +

Supported Protocol Id types.

+
Enumerator:
+ + + + + +
ProtocolIdNone  +

Marker representing non-existent protocol id.

+
ProtocolIdLlc  +

LLC (802.2)

+
ProtocolIdEth  +

Ethernet II.

+
ProtocolIdIp  +

IP.

+
ProtocolIdTcpUdp  +

TCP/UDP Port Number.

+
+
+
+ +
+
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
AbstractProtocol::AbstractProtocol (StreamBase * stream,
AbstractProtocol * parent = 0 
)
+
+
+ +

Constructs an abstract protocol for the given stream and parent.

+

parent is typically NULL except for protocols which are part of a ComboProtocol

+ +
+
+ +
+
+ + + + + + + +
AbstractProtocol::~AbstractProtocol () [virtual]
+
+
+ +

Destroys the abstract protocol.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
void AbstractProtocol::appendVariableField (const OstProto::VariableField & vf)
+
+
+ +

Appends a variableField to the protocol.

+ +
+
+ +
+
+ + + + + + + + +
void AbstractProtocol::commonProtoDataCopyFrom (const OstProto::Protocol & protocol)
+
+
+ +

Copies the common data (not specific to individual protocols) from the passed in param protocol protobuf into the member protobuf data.

+

The individual protocol specific protobuf data is copied using protoDataCopyFrom()

+ +
+
+ +
+
+ + + + + + + + +
void AbstractProtocol::commonProtoDataCopyInto (OstProto::Protocol & protocol) const
+
+
+ +

Copies the common data (not specific to individual protocols) in the protocol member protobuf data into the passed in protocol parameter.

+

The individual protocol specific protobuf data is copied using protoDataCopyInto()

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
AbstractProtocol * AbstractProtocol::createInstance (StreamBase * stream,
AbstractProtocol * parent = 0 
) [static]
+
+
+ +

Allocates and returns a new instance of the class.

+

Caller is responsible for freeing up after use. Subclasses MUST implement this function

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::fieldCount () const [virtual]
+
+
+ +

Returns the number of fields in the protocol (both Frame fields and Meta fields)

+

The default implementation returns zero. Subclasses MUST implement this function.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
QVariant AbstractProtocol::fieldData (int index,
FieldAttrib attrib,
int streamIndex = 0 
) const [virtual]
+
+
+ +

Returns the requested field attribute data.

+

Protocols which have meta fields that vary a frame field across streams may use the streamIndex to return the appropriate field value
+ Some field attributes e.g. FieldName may be invariant across streams
+ The FieldTextValue attribute may include additional information about the field's value e.g. a checksum field may include "(correct)" or "(incorrect)" alongwith the actual checksum value.
+

+

The default implementation returns a empty string for FieldName and FieldTextValue; empty byte array of size 0 for FieldFrameValue; 0 for FieldValue; subclasses are expected to return meaning values for all these attributes. The only exception is the 'FieldBitSize' attribute - the default implementation takes the (byte) size of FieldFrameValue, multiplies it with 8 and returns the result - this can be used by subclasses for fields which are an integral multiple of bytes; for fields whose size are a non-integral multiple of bytes or smaller than a byte, subclasses should return the correct value. Also for fields which represent checksums, subclasses should return a value for FieldBitSize - even if it is an integral multiple of bytes.

+
Note:
If a subclass uses any of the below functions to derive FieldFrameValue, the subclass should handle and return a value for FieldBitSize to prevent endless recursion - +
+ +
+
+ +
+
+ + + + + + + + +
AbstractProtocol::FieldFlags AbstractProtocol::fieldFlags (int index) const [virtual]
+
+
+ +

Returns the field flags for the passed in field index.

+

The default implementation assumes all fields to be frame fields and returns 'FrameField'. Subclasses must reimplement this method if they have any meta fields or checksum fields. See the SampleProtocol for an example.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
int AbstractProtocol::fieldFrameBitOffset (int index,
int streamIndex = 0 
) const
+
+
+ +

Returns the bit offset where the specified field starts within the protocolFrameValue()

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::frameFieldCount () const [virtual]
+
+
+ +

Returns the number of frame fields.

+

The default implementation counts and returns the number of fields for which the FrameField flag is set
+ The default implementation caches the count on its first invocation and subsequently returns the cached count

+

Subclasses which export different sets of fields based on a opcode/type (e.g. icmp) should re-implement this function

+ +
+
+ +
+
+ + + + + + + +
bool AbstractProtocol::isProtocolFramePayloadSizeVariable () const
+
+
+ +

Returns true if the payload size for a protocol varies at run-time, false otherwise.

+

This is useful for subclasses which have fields dependent on payload size (e.g. UDP has a checksum field that varies if the payload varies)

+ +
+
+ +
+
+ + + + + + + +
bool AbstractProtocol::isProtocolFramePayloadValueVariable () const
+
+
+ +

Returns true if the payload content for a protocol varies at run-time, false otherwise.

+

This is useful for subclasses which have fields dependent on payload content (e.g. UDP has a checksum field that varies if the payload varies)

+ +
+
+ +
+
+ + + + + + + +
bool AbstractProtocol::isProtocolFrameSizeVariable () const [virtual]
+
+
+ +

Returns true if the protocol varies its size at run-time, false otherwise.

+

The default implmentation returns false. A subclass should reimplement if it varies its size at run-time e.g. a Payload protocol for a stream with incrementing/decrementing frame lengths

+ +
+
+ +
+
+ + + + + + + +
bool AbstractProtocol::isProtocolFrameValueVariable () const [virtual]
+
+
+ +

Returns true if the protocol varies one or more of its fields at run-time, false otherwise.

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::metaFieldCount () const
+
+
+ +

Returns the number of meta fields.

+

The default implementation counts and returns the number of fields for which the MetaField flag is set
+ The default implementation caches the count on its first invocation and subsequently returns the cached count

+ +
+
+ +
+
+ + + + + + + + +
OstProto::VariableField * AbstractProtocol::mutableVariableField (int index)
+
+
+ +

Returns the variableField at the specified index as a mutable pointer.

+

Changes made via the pointer will be reflected in the protocol

+ +
+
+ +
+
+ + + + + + + +
QString AbstractProtocol::name () const [virtual]
+
+
+ +

Returns the full name of the protocol.

+

The default implementation returns a null string

+ +
+
+ +
+
+ + + + + + + + +
quint32 AbstractProtocol::payloadProtocolId (ProtocolIdType type) const
+
+
+ +

Returns the protocol id of the payload protocol (the protocol that immediately follows the current one)

+

A subclass which has a protocol id field, can use this to retrieve the appropriate value

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
quint32 AbstractProtocol::protocolFrameCksum (int streamIndex = 0,
CksumType cksumType = CksumIp 
) const [virtual]
+
+
+ +

Returns the checksum (of the requested type) of the protocol's contents.

+

Useful for protocols which have a checksum field

+
Note:
If a subclass uses protocolFrameCksum() from within fieldData() to derive a cksum field, it MUST handle and return the 'FieldBitSize' attribute also for that particular field instead of using the default AbstractProtocol implementation for 'FieldBitSize' - this is required to prevent infinite recursion
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
quint32 AbstractProtocol::protocolFrameHeaderCksum (int streamIndex = 0,
CksumType cksumType = CksumIp,
CksumScope cksumScope = CksumScopeAdjacentProtocol 
) const
+
+
+ +

Returns the checksum of the requested type for the protocol's header.

+

This is useful for subclasses which needs the header's checksum e.g. TCP/UDP require a "Pseudo-IP" checksum. The checksum is limited to the specified scope.

+

Currently the default implementation supports only type CksumIpPseudo

+
Note:
The default value for cksumScope is different for protocolFrameHeaderCksum() and protocolFramePayloadCksum()
+ +
+
+ +
+
+ + + + + + + + +
int AbstractProtocol::protocolFrameOffset (int streamIndex = 0) const
+
+
+ +

Returns the byte offset in the packet where the protocol starts.

+

This method is useful only for "padding" protocols i.e. protocols which fill up the remaining space for the user defined packet size e.g. the PatternPayload protocol

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
quint32 AbstractProtocol::protocolFramePayloadCksum (int streamIndex = 0,
CksumType cksumType = CksumIp,
CksumScope cksumScope = CksumScopeAllProtocols 
) const
+
+
+ +

Returns the checksum of the requested type for the protocol's payload.

+

This is useful for subclasses which needs the payload's checksum e.g. TCP/UDP require a IP checksum of the payload (to be combined with other checksums to derive the final checksum). The checksum is limited to the specified scope.

+

Currently the default implementation supports only type CksumIp

+
Note:
The default value for cksumScope is different for protocolFrameHeaderCksum() and protocolFramePayloadCksum()
+ +
+
+ +
+
+ + + + + + + + +
int AbstractProtocol::protocolFramePayloadSize (int streamIndex = 0) const
+
+
+ +

Returns the size of the payload in bytes.

+

The payload includes all protocols subsequent to the current

+

This method is useful for protocols which need to fill in a payload size field

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::protocolFramePayloadVariableCount () const
+
+
+ +

Returns true if the payload size for a protocol varies at run-time, false otherwise.

+

This is useful for subclasses which have fields dependent on payload size (e.g. UDP has a checksum field that varies if the payload varies)

+ +
+
+ +
+
+ + + + + + + + +
int AbstractProtocol::protocolFrameSize (int streamIndex = 0) const [virtual]
+
+
+ +

Returns the protocol's size in bytes.

+

The default implementation sums up the individual field bit sizes and returns it. The default implementation calculates the caches the size on the first invocation and subsequently returns the cached size.

+

If the subclass protocol has a varying protocol size, it MUST reimplement this method, otherwise the default implementation is sufficient.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
QByteArray AbstractProtocol::protocolFrameValue (int streamIndex = 0,
bool forCksum = false 
) const
+
+
+ +

Returns a byte array encoding the protocol (and its fields) which can be inserted into the stream's frame.

+

The default implementation forms and returns an ordered concatenation of the FrameValue of all the 'frame' fields of the protocol also taking care of fields which are not an integral number of bytes
+

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::protocolFrameVariableCount () const [virtual]
+
+
+ +

Returns the minimum number of frames required for the protocol to vary its fields.

+

This is the lowest common multiple (LCM) of the counts of all the varying fields in the protocol. Use the AbstractProtocol::lcm() static utility function to calculate the LCM.

+

The default implementation returns the LCM of all variableFields A subclass should reimplement if it has varying fields e.g. an IP protocol that increments/decrements the IP address with every packet.
+ Subclasses should call the base class method to retreive the count and do a LCM with the subclass' own varying fields

+ +
+
+ +
+
+ + + + + + + +
bool AbstractProtocol::protocolHasPayload () const
+
+
+ +

Returns true if the protocol typically contains a payload or other protocols following it e.g.

+

TCP, UDP have payloads, while ARP, IGMP do not

+

The default implementation returns true. If a subclass does not have a payload, it should set the _hasPayload data member to false

+ +
+
+ +
+
+ + + + + + + + +
quint32 AbstractProtocol::protocolId (ProtocolIdType type) const [virtual]
+
+
+ +

Returns the protocol id of the protocol for the given type.

+

The default implementation returns 0. If a subclass represents a protocol which has a particular protocol id, it should return the appropriate value. If a protocol does not have an id for the given type, it should defer to the base class. e.g. IGMP will return 2 for ProtocolIdIp, and defer to the base class for the remaining ProtocolIdTypes; IP will return 0x800 for ProtocolIdEth type, 0x060603 for ProtocolIdLlc and 0x04 for ProtocolIdIp etc.

+ +
+
+ +
+
+ + + + + + + +
AbstractProtocol::ProtocolIdType AbstractProtocol::protocolIdType () const [virtual]
+
+
+ +

Returns the protocolIdType for the protocol.

+

The default implementation returns ProtocolIdNone. If a subclass has a protocolId field it should return the appropriate value e.g. IP protocol will return ProtocolIdIp, Ethernet will return ProtocolIdEth etc.

+ +
+
+ +
+
+ + + + + + + +
quint32 AbstractProtocol::protocolNumber () const [virtual]
+
+
+ +

Returns the protocol's field number as defined in message 'Protocol', enum 'k' (file: protocol.proto)

+

Subclasses MUST implement this function

+ +
+
+ +
+
+ + + + + + + + +
void AbstractProtocol::protoDataCopyFrom (const OstProto::Protocol & protocol) [pure virtual]
+
+
+ +

Copy and update the protocol's protobuf member data variable from the passed in protocol.

+

In the base class this is a pure virtual function. Subclasses MUST implement this function. See the SampleProtocol for an example

+ +
+
+ +
+
+ + + + + + + + +
void AbstractProtocol::protoDataCopyInto (OstProto::Protocol & protocol) const [pure virtual]
+
+
+ +

Copy the protocol's protobuf as an extension into the passed in protocol.

+

In the base class this is a pure virtual function. Subclasses MUST implement this function. See the SampleProtocol for an example

+ +
+
+ +
+
+ + + + + + + + +
void AbstractProtocol::removeVariableField (int index)
+
+
+ +

Removes the variableField from the protocol at the specified index.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool AbstractProtocol::setFieldData (int index,
const QVariant & value,
FieldAttrib attrib = FieldValue 
) [virtual]
+
+
+ +

Sets the value of a field corresponding to index.

+

This method is called by the GUI code to store a user specified value into the protocol's protoBuf. Currently this method is called with FieldAttrib = FieldValue only.

+

Returns true if field is successfully set, false otherwise. The default implementation always returns false. Subclasses should reimplement this method. See SampleProtocol for an example.

+ +
+
+ +
+
+ + + + + + + +
QString AbstractProtocol::shortName () const [virtual]
+
+
+ +

Returns the short name or abbreviation of the protocol.

+

The default implementation forms and returns an abbreviation composed of all the upper case chars in name()
+ The default implementation caches the abbreviation on its first invocation and subsequently returns the cached abbreviation

+ +
+
+ +
+
+ + + + + + + + +
const OstProto::VariableField & AbstractProtocol::variableField (int index) const
+
+
+ +

Returns the variableField at the specified index as a constant Reference i.e.

+

read-only

+ +
+
+ +
+
+ + + + + + + +
int AbstractProtocol::variableFieldCount () const
+
+
+ +

Returns the count of variableFields in the protocol.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
bool AbstractProtocol::_hasPayload [protected]
+
+
+ +

Is protocol typically followed by payload or another protocol.

+ +
+
+ +
+
+ + + + +
StreamBase* AbstractProtocol::mpStream [protected]
+
+
+ +

Stream that this protocol belongs to.

+ +
+
+ +
+
+ + + + +
AbstractProtocol* AbstractProtocol::next [protected]
+
+
+ +

Protocol succeeding this protocol.

+ +
+
+ +
+
+ + + + +
AbstractProtocol* AbstractProtocol::parent [protected]
+
+
+ +

Parent protocol, if any.

+ +
+
+ +
+
+ + + + +
AbstractProtocol* AbstractProtocol::prev [protected]
+
+
+ +

Protocol preceding this protocol.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/class_abstract_protocol_config_form-members.html b/doxydocs/class_abstract_protocol_config_form-members.html new file mode 100644 index 0000000..d4257f4 --- /dev/null +++ b/doxydocs/class_abstract_protocol_config_form-members.html @@ -0,0 +1,42 @@ + + + + + +Member List + + + + + + + +
+ + + +
+
+
+
AbstractProtocolConfigForm Member List
+
+
+This is the complete list of members for AbstractProtocolConfigForm, including all inherited members. + + + + + + + +
AbstractProtocolConfigForm(QWidget *parent=0)AbstractProtocolConfigForm [inline]
createInstance()AbstractProtocolConfigForm [inline, static]
hexStrToUInt(QString text, bool *ok=NULL)AbstractProtocolConfigForm [inline]
hexStrToUInt64(QString text, bool *ok=NULL)AbstractProtocolConfigForm [inline]
loadWidget(AbstractProtocol *)AbstractProtocolConfigForm [inline, virtual]
storeWidget(AbstractProtocol *)AbstractProtocolConfigForm [inline, virtual]
~AbstractProtocolConfigForm()AbstractProtocolConfigForm [inline, virtual]
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/class_abstract_protocol_config_form.html b/doxydocs/class_abstract_protocol_config_form.html new file mode 100644 index 0000000..9a50e43 --- /dev/null +++ b/doxydocs/class_abstract_protocol_config_form.html @@ -0,0 +1,220 @@ + + + + + +AbstractProtocolConfigForm Class Reference + + + + + + + +
+ + + +
+
+
+Public Member Functions | +Static Public Member Functions
+
+
AbstractProtocolConfigForm Class Reference
+
+
+ +

List of all members.

+ + + + + + + + + + + + + + + + + +

+Public Member Functions

 AbstractProtocolConfigForm (QWidget *parent=0)
 Constructs the widget.
virtual ~AbstractProtocolConfigForm ()
 Destroys the widget.
virtual void loadWidget (AbstractProtocol *)
 Loads data from the protocol using it's fieldData() method into this widget.
virtual void storeWidget (AbstractProtocol *)
 Stores data from this widget into the protocol using the protocol's setFieldData() method.
uint hexStrToUInt (QString text, bool *ok=NULL)
 Convenience Method - can be used by storeWidget() implementations.
quint64 hexStrToUInt64 (QString text, bool *ok=NULL)
 Convenience Method - can be used by storeWidget() implementations.

+Static Public Member Functions

static AbstractProtocolConfigForm * createInstance ()
 Allocates and returns a new instance of the widget.
+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
AbstractProtocolConfigForm::AbstractProtocolConfigForm (QWidget * parent = 0) [inline]
+
+
+ +

Constructs the widget.

+ +
+
+ +
+
+ + + + + + + +
virtual AbstractProtocolConfigForm::~AbstractProtocolConfigForm () [inline, virtual]
+
+
+ +

Destroys the widget.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
static AbstractProtocolConfigForm* AbstractProtocolConfigForm::createInstance () [inline, static]
+
+
+ +

Allocates and returns a new instance of the widget.

+

Caller is responsible for freeing up after use. Subclasses MUST implement this function

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
uint AbstractProtocolConfigForm::hexStrToUInt (QString text,
bool * ok = NULL 
) [inline]
+
+
+ +

Convenience Method - can be used by storeWidget() implementations.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
quint64 AbstractProtocolConfigForm::hexStrToUInt64 (QString text,
bool * ok = NULL 
) [inline]
+
+
+ +

Convenience Method - can be used by storeWidget() implementations.

+ +
+
+ +
+
+ + + + + + + + +
virtual void AbstractProtocolConfigForm::loadWidget (AbstractProtocol * ) [inline, virtual]
+
+
+ +

Loads data from the protocol using it's fieldData() method into this widget.

+

Any conversion to user friendly display/editing formats (e.g. hex format) SHOULD be done by this method.

+

Subclasses MUST implement this function. See the SampleProtocol for an example

+ +
+
+ +
+
+ + + + + + + + +
virtual void AbstractProtocolConfigForm::storeWidget (AbstractProtocol * ) [inline, virtual]
+
+
+ +

Stores data from this widget into the protocol using the protocol's setFieldData() method.

+

Field values MUST be converted from any user friendly display/editing formats (e.g. hex format) to simple Qt-style integers/strings before passing to setFieldData()

+

Subclasses MUST implement this function. See the SampleProtocol for an example

+ +
+
+
The documentation for this class was generated from the following file: +
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/class_pdml_protocol-members.html b/doxydocs/class_pdml_protocol-members.html new file mode 100644 index 0000000..c73b1f2 --- /dev/null +++ b/doxydocs/class_pdml_protocol-members.html @@ -0,0 +1,49 @@ + + + + + +Member List + + + + + + + +
+ + + +
+
+
+
PdmlProtocol Member List
+
+
+This is the complete list of members for PdmlProtocol, including all inherited members. + + + + + + + + + + + + + + +
createInstance()PdmlProtocol [static]
fieldHandler(QString name, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)PdmlProtocol
fieldId(QString name) const PdmlProtocol
fieldMap_ (defined in PdmlProtocol)PdmlProtocol [protected]
hasField(QString name) const PdmlProtocol
knownFieldHandler(QString name, QString valueHexStr, OstProto::Protocol *pbProto)PdmlProtocol
ostProtoId() const PdmlProtocol
ostProtoId_PdmlProtocol [protected]
PdmlProtocol()PdmlProtocol [protected]
postProtocolHandler(OstProto::Protocol *pbProto, OstProto::Stream *stream)PdmlProtocol [virtual]
prematureEndHandler(int pos, OstProto::Protocol *pbProto, OstProto::Stream *stream)PdmlProtocol [virtual]
preProtocolHandler(QString name, const QXmlStreamAttributes &attributes, int expectedPos, OstProto::Protocol *pbProto, OstProto::Stream *stream)PdmlProtocol [virtual]
unknownFieldHandler(QString name, int pos, int size, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)PdmlProtocol [virtual]
~PdmlProtocol()PdmlProtocol [virtual]
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/class_pdml_protocol.html b/doxydocs/class_pdml_protocol.html new file mode 100644 index 0000000..eb07862 --- /dev/null +++ b/doxydocs/class_pdml_protocol.html @@ -0,0 +1,484 @@ + + + + + +PdmlProtocol Class Reference + + + + + + + +
+ + + +
+
+
+Public Member Functions | +Static Public Member Functions | +Protected Member Functions | +Protected Attributes
+
+
PdmlProtocol Class Reference
+
+
+ +

PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols. + More...

+ +

List of all members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~PdmlProtocol ()
 Destroys the PdmlProtocol.
int ostProtoId () const
 Returns the protocol's field number as defined in message 'Protocol', enum 'k' (file: protocol.proto)
bool hasField (QString name) const
 Returns true if name is a 'known' field that can be directly mapped to the protobuf field.
int fieldId (QString name) const
 Returns the protocol's protobuf field number corresponding to name.
virtual void preProtocolHandler (QString name, const QXmlStreamAttributes &attributes, int expectedPos, OstProto::Protocol *pbProto, OstProto::Stream *stream)
 This method is called by PdmlReader before any fields within the protocol are processed.
virtual void prematureEndHandler (int pos, OstProto::Protocol *pbProto, OstProto::Stream *stream)
 This method is called by PdmlReader when it encounters a nested protocol in the PDML i.e.
virtual void postProtocolHandler (OstProto::Protocol *pbProto, OstProto::Stream *stream)
 This method is called by PdmlReader after all fields within the protocol are processed.
void fieldHandler (QString name, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)
 This method is called by PdmlReader for each field in the protocol.
void knownFieldHandler (QString name, QString valueHexStr, OstProto::Protocol *pbProto)
 Handles a 'known' field.
virtual void unknownFieldHandler (QString name, int pos, int size, const QXmlStreamAttributes &attributes, OstProto::Protocol *pbProto, OstProto::Stream *stream)
 Handles a 'unknown' field.

+Static Public Member Functions

static PdmlProtocol * createInstance ()
 Allocates and returns a new instance of the class.

+Protected Member Functions

 PdmlProtocol ()
 Protocol's field number as defined in message 'Protocol', enum 'k'.

+Protected Attributes

int ostProtoId_
 Map of PDML field names to protobuf field numbers for 'known' fields.
+QMap< QString, int > fieldMap_
+

Detailed Description

+

PdmlProtocol is the base class which provides the interface for all PDML decode helper protocols.

+

All Pdml helper classes derived from PdmlProtocol MUST register themselves with PdmlReader. When PdmlReader encounters a 'proto' tag in the PDML during parsing, it instantiates the corresponding helper PdmlProtocol class and calls its methods to decode the protocol.

+

A subclass MUST initialize the following inherited protected variables in its constructor -

+
    +
  • ostProtoId_
    • +
  • fieldMap_
    • +
+

A subclass typically needs to reimplement the following methods -

+ +

Depending on certain conditions, subclasses may need to reimplement the following additional methods -

+ +

See the description of the methods for more information.

+

Use the SamplePdmlProtocol implementation as boilerplate code and for guidelines and tips

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + +
PdmlProtocol::~PdmlProtocol () [virtual]
+
+
+ +

Destroys the PdmlProtocol.

+ +
+
+ +
+
+ + + + + + + +
PdmlProtocol::PdmlProtocol () [protected]
+
+
+ +

Protocol's field number as defined in message 'Protocol', enum 'k'.

+

Constructs the PdmlProtocol.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
PdmlProtocol * PdmlProtocol::createInstance () [static]
+
+
+ +

Allocates and returns a new instance of the class.

+

Caller is responsible for freeing up after use. Subclasses MUST implement this function and register it with PdmlReader

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void PdmlProtocol::fieldHandler (QString name,
const QXmlStreamAttributes & attributes,
OstProto::Protocol * pbProto,
OstProto::Stream * stream 
)
+
+
+ +

This method is called by PdmlReader for each field in the protocol.

+

Depending on whether it is a known or unknown field, the virtual methods knownFieldHandler() and unknownFieldHandler() are invoked

+ +
+
+ +
+
+ + + + + + + + +
int PdmlProtocol::fieldId (QString name) const
+
+
+ +

Returns the protocol's protobuf field number corresponding to name.

+ +
+
+ +
+
+ + + + + + + + +
bool PdmlProtocol::hasField (QString name) const
+
+
+ +

Returns true if name is a 'known' field that can be directly mapped to the protobuf field.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void PdmlProtocol::knownFieldHandler (QString name,
QString valueHexStr,
OstProto::Protocol * pbProto 
)
+
+
+ +

Handles a 'known' field.

+

Uses protobuf reflection interface to set the protobuf field name to valueHexStr as per the field's datatype

+ +
+
+ +
+
+ + + + + + + +
int PdmlProtocol::ostProtoId () const
+
+
+ +

Returns the protocol's field number as defined in message 'Protocol', enum 'k' (file: protocol.proto)

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
void PdmlProtocol::postProtocolHandler (OstProto::Protocol * pbProto,
OstProto::Stream * stream 
) [virtual]
+
+
+ +

This method is called by PdmlReader after all fields within the protocol are processed.

+

Use this method to do any special handling that may be required for postprocessing

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void PdmlProtocol::prematureEndHandler (int pos,
OstProto::Protocol * pbProto,
OstProto::Stream * stream 
) [virtual]
+
+
+ +

This method is called by PdmlReader when it encounters a nested protocol in the PDML i.e.

+

a protocol within a protocol or a protocol within a field

+

This is a notification to the protocol that protocol processing will be ending prematurely. postProtocolHandler() will still be called in such cases.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void PdmlProtocol::preProtocolHandler (QString name,
const QXmlStreamAttributes & attributes,
int expectedPos,
OstProto::Protocol * pbProto,
OstProto::Stream * stream 
) [virtual]
+
+
+ +

This method is called by PdmlReader before any fields within the protocol are processed.

+

All attributes associated with the 'proto' tag in the PDML are passed to this method

+

Use this method to do any special handling that may be required for preprocessing

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
void PdmlProtocol::unknownFieldHandler (QString name,
int pos,
int size,
const QXmlStreamAttributes & attributes,
OstProto::Protocol * pbProto,
OstProto::Stream * stream 
) [virtual]
+
+
+ +

Handles a 'unknown' field.

+

The default implementation does nothing. Subclasses may need to implement this if the protocol contains 'unknown' fields.

+ +
+
+

Member Data Documentation

+ +
+
+ + + + +
int PdmlProtocol::ostProtoId_ [protected]
+
+
+ +

Map of PDML field names to protobuf field numbers for 'known' fields.

+ +
+
+
The documentation for this class was generated from the following files: +
+ + +
+Generated on Tue Jun 2 2015 18:40:09 by   +doxygen + 1.7.5.1 +
+ + + diff --git a/doxydocs/doxygen.css b/doxydocs/doxygen.css new file mode 100644 index 0000000..22c7b5c --- /dev/null +++ b/doxydocs/doxygen.css @@ -0,0 +1,946 @@ +/* The standard CSS for doxygen */ + +body, table, div, p, dl { + font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif; + font-size: 12px; +} + +/* @group Heading Levels */ + +h1 { + font-size: 150%; +} + +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2 { + font-size: 120%; +} + +h3 { + font-size: 100%; +} + +dt { + font-weight: bold; +} + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9CAFD4; + color: #ffffff; + border: 1px double #869DCA; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code { + color: #4665A2; +} + +a.codeRef { + color: #4665A2; +} + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +.fragment { + font-family: monospace, fixed; + font-size: 105%; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000); +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 8px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid #C4CFE5; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; +} + +.memname { + white-space: nowrap; + font-weight: bold; + margin-left: 6px; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 8px; + border-top-left-radius: 8px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 8px; + -moz-border-radius-topleft: 8px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 8px; + -webkit-border-top-left-radius: 8px; + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 2px 5px; + background-color: #FBFCFD; + border-top-width: 0; + /* opera specific markup */ + border-bottom-left-radius: 8px; + border-bottom-right-radius: 8px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 8px; + -moz-border-radius-bottomright: 8px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7); + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 8px; + -webkit-border-bottom-right-radius: 8px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7)); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +.params, .retval, .exception, .tparams { + border-spacing: 6px 2px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + + + + +/* @end */ + +/* @group Directory (tree) */ + +/* for the tree view */ + +.ftvtree { + font-family: sans-serif; + margin: 0px; +} + +/* these are for tree view when used as main index */ + +.directory { + font-size: 9pt; + font-weight: bold; + margin: 5px; +} + +.directory h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +/* +The following two styles can be used to replace the root node title +with an image of your choice. Simply uncomment the next two styles, +specify the name of your image and be sure to set 'height' to the +proper pixel height of your image. +*/ + +/* +.directory h3.swap { + height: 61px; + background-repeat: no-repeat; + background-image: url("yourimage.gif"); +} +.directory h3.swap span { + display: none; +} +*/ + +.directory > h3 { + margin-top: 0; +} + +.directory p { + margin: 0px; + white-space: nowrap; +} + +.directory div { + display: none; + margin: 0px; +} + +.directory img { + vertical-align: -30%; +} + +/* these are for tree view when not used as main index */ + +.directory-alt { + font-size: 100%; + font-weight: bold; +} + +.directory-alt h3 { + margin: 0px; + margin-top: 1em; + font-size: 11pt; +} + +.directory-alt > h3 { + margin-top: 0; +} + +.directory-alt p { + margin: 0px; + white-space: nowrap; +} + +.directory-alt div { + display: none; + margin: 0px; +} + +.directory-alt img { + vertical-align: -30%; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable { + border-collapse:collapse; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + +table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + width: 100%; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + margin-left: 5px; + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 7px; +} + +dl +{ + padding: 0 0 0 10px; +} + +dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug +{ + border-left:4px solid; + padding: 0 0 0 6px; +} + +dl.note +{ + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + border-color: #00D000; +} + +dl.deprecated +{ + border-color: #505050; +} + +dl.todo +{ + border-color: #00C0E0; +} + +dl.test +{ + border-color: #3030E0; +} + +dl.bug +{ + border-color: #C08050; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 300% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 120% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } + pre.fragment + { + overflow: visible; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + } +} + diff --git a/doxydocs/doxygen.png b/doxydocs/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/doxydocs/doxygen.png differ diff --git a/doxydocs/tabs.css b/doxydocs/tabs.css new file mode 100644 index 0000000..95f00a9 --- /dev/null +++ b/doxydocs/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI.current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI.current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.navpath +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +}