.TH "Vector::BLF::EthernetFrameForwarded" 3 "Vector BLF" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Vector::BLF::EthernetFrameForwarded \- ETHERNET_FRAME_FORWARDED\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <EthernetFrameForwarded\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBuint16_t\fP \fBcalculateStructLength\fP () \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (\fBconst\fP ObjectType \fBobjectType\fP, \fBconst\fP \fBuint16_t\fP \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "\fBvoid\fP \fBread\fP (\fBAbstractFile\fP &\fBis\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBwrite\fP (\fBAbstractFile\fP &\fBos\fP) \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBcalculateHeaderSize\fP () \fBconst\fP \fBoverride\fP"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcalculateObjectSize\fP () \fBconst\fP \fBoverride\fP"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBuint16_t\fP \fBheaderVersion\fP, \fBconst\fP ObjectType \fBobjectType\fP)"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBconst\fP \fBObjectHeaderBase\fP &)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP"
.br
.ti -1c
.RI "\fBObjectHeaderBase\fP & \fBoperator=\fP (\fBObjectHeaderBase\fP &&)=\fBdefault\fP"
.br
.in -1c
.SS "Public Attributes"

.in +1c
.ti -1c
.RI "\fBuint16_t\fP \fBstructLength\fP {}"
.br
.RI "Length of this structure, without sizeof(VBLObjectHeader), without mStructLength member and without mFrameData member\&. "
.ti -1c
.RI "\fBuint16_t\fP \fBflags\fP {}"
.br
.RI "flags, which indicates the valid fields: "
.ti -1c
.RI "\fBuint16_t\fP \fBchannel\fP {}"
.br
.RI "application channel, i\&.e\&. Eth 1 "
.ti -1c
.RI "\fBuint16_t\fP \fBhardwareChannel\fP {}"
.br
.RI "HW channel\&. "
.ti -1c
.RI "\fBuint64_t\fP \fBframeDuration\fP {}"
.br
.RI "Transmission duration in [ns]\&. "
.ti -1c
.RI "\fBuint32_t\fP \fBframeChecksum\fP {}"
.br
.RI "Ethernet checksum\&. "
.ti -1c
.RI "\fBuint16_t\fP \fBdir\fP {}"
.br
.RI "Direction flag: 0=Rx, 1=Tx, 2=TxRq\&. "
.ti -1c
.RI "\fBuint16_t\fP \fBframeLength\fP {}"
.br
.RI "Number of valid frameData bytes\&. "
.ti -1c
.RI "\fBuint32_t\fP \fBframeHandle\fP {}"
.br
.RI "Handle which refer the corresponding \fBEthernetFrameForwarded\fP event\&. "
.ti -1c
.RI "\fBuint32_t\fP \fBreservedEthernetFrameForwarded\fP {}"
.br
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBframeData\fP {}"
.br
.RI "Max 1612 data bytes per frame\&. Contains Ethernet header + Ethernet payload\&. "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "\fBuint16_t\fP \fBclientIndex\fP {}"
.br
.RI "client index of send node "
.ti -1c
.RI "\fBuint16_t\fP \fBobjectVersion\fP {0}"
.br
.RI "object specific version "
.ti -1c
.RI "\fBuint64_t\fP \fBobjectTimeStamp\fP {}"
.br
.RI "object timestamp "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "\fBuint32_t\fP \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "\fBuint16_t\fP \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "\fBuint32_t\fP \fBobjectSize\fP {}"
.br
.RI "object size "
.ti -1c
.RI "ObjectType \fBobjectType\fP {ObjectType::UNKNOWN}"
.br
.RI "object type "
.in -1c
.SS "Additional Inherited Members"


Public Types inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
ETHERNET_FRAME_FORWARDED\&. 

Ethernet frame forwarded 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::EthernetFrameForwarded::calculateObjectSize () const\fR [override]\fP, \fR [virtual]\fP"
Calculates the objectSize
.PP
\fBReturns\fP
.RS 4
object size 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrameForwarded::calculateStructLength () const\fR [virtual]\fP"
Calculates structLength\&.
.PP
\fBReturns\fP
.RS 4
struct length 
.RE
.PP

.SS "\fBvoid\fP Vector::BLF::EthernetFrameForwarded::read (\fBAbstractFile\fP & is)\fR [override]\fP, \fR [virtual]\fP"
Read the data of this object
.PP
\fBParameters\fP
.RS 4
\fIis\fP input stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SS "\fBvoid\fP Vector::BLF::EthernetFrameForwarded::write (\fBAbstractFile\fP & os)\fR [override]\fP, \fR [virtual]\fP"
Write the data of this object
.PP
\fBParameters\fP
.RS 4
\fIos\fP output stream 
.RE
.PP

.PP
Reimplemented from \fBVector::BLF::ObjectHeaderBase\fP\&.
.SH "Member Data Documentation"
.PP 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrameForwarded::flags {}"

.PP
flags, which indicates the valid fields: 
.IP "\(bu" 2
Bit 0 - normal packet = 0, forwarded packet = 1
.IP "\(bu" 2
Bit 1 - hardwareChannel valid
.IP "\(bu" 2
Bit 2 - frameDuration valid
.IP "\(bu" 2
Bit 3 - frameChecksum valid
.IP "\(bu" 2
Bit 4 - frameHandle valid 
.PP

.SS "\fBuint32_t\fP Vector::BLF::EthernetFrameForwarded::reservedEthernetFrameForwarded {}"
reserved 

.SH "Author"
.PP 
Generated automatically by Doxygen for Vector BLF from the source code\&.