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

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

.in +1c
.ti -1c
.RI "enum \fBDir\fP : uint16_t { \fBRx\fP = 0, \fBTx\fP = 1, \fBTxRq\fP = 2 }"
.br
.in -1c

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
.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
.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 "std::array< \fBuint8_t\fP, 6 > \fBsourceAddress\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBchannel\fP {}"
.br
.ti -1c
.RI "std::array< \fBuint8_t\fP, 6 > \fBdestinationAddress\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBdir\fP {}"
.br
.RI "Direction flag\&. "
.ti -1c
.RI "\fBuint16_t\fP \fBtype\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBtpid\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBtci\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBpayLoadLength\fP {}"
.br
.RI "Number of valid payLoad bytes\&. "
.ti -1c
.RI "\fBuint64_t\fP \fBreservedEthernetFrame\fP {}"
.br
.ti -1c
.RI "std::vector< \fBuint8_t\fP > \fBpayLoad\fP {}"
.br
.RI "Max 1500 data bytes per frame\&. "
.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
.SH "Detailed Description"
.PP 
ETHERNET_FRAME\&. 

Ethernet frame 
.SH "Member Enumeration Documentation"
.PP 
.SS "\fBenum\fP \fBVector::BLF::EthernetFrame::Dir\fP : \fBuint16_t\fP"
enumeration for dir 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::EthernetFrame::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 "\fBvoid\fP Vector::BLF::EthernetFrame::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::EthernetFrame::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::EthernetFrame::channel {}"
The channel of the frame\&. 
.SS "std::array<\fBuint8_t\fP, 6> Vector::BLF::EthernetFrame::destinationAddress {}"
Ethernet (MAC) address of target computer (network byte order)\&. 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrame::dir {}"

.PP
Direction flag\&. Direction flag 
.SS "std::vector<\fBuint8_t\fP> Vector::BLF::EthernetFrame::payLoad {}"

.PP
Max 1500 data bytes per frame\&. Ethernet payload data (without Ethernet header) 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrame::payLoadLength {}"

.PP
Number of valid payLoad bytes\&. Length of Ethernet payload data in bytes\&. Max\&. 1500 Bytes (without Ethernet header) 
.SS "\fBuint64_t\fP Vector::BLF::EthernetFrame::reservedEthernetFrame {}"
reserved 
.SS "std::array<\fBuint8_t\fP, 6> Vector::BLF::EthernetFrame::sourceAddress {}"
Ethernet (MAC) address of source computer (network byte order)\&. 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrame::tci {}"
TCI when VLAND tag valid, zero when no VLAN\&. See Ethernet standard specification\&. 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrame::tpid {}"
TPID when VLAN tag valid, zero when no VLAN\&. See Ethernet standard specification\&. 
.SS "\fBuint16_t\fP Vector::BLF::EthernetFrame::type {}"
EtherType which indicates protocol for Ethernet payload data
.PP
See Ethernet standard specification for valid values\&. 

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