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

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

.in +1c
.ti -1c
.RI "enum \fBFlags\fP : uint16_t { \fBLinkStatus\fP = 0x0001, \fBBitrate\fP = 0x0002, \fBEthernetPhy\fP = 0x0004, \fBDuplex\fP = 0x0008, \fBMdiType\fP = 0x0010, \fBConnector\fP = 0x0020, \fBClockMode\fP = 0x0040, \fBBrPair\fP = 0x0080, \fBHardwareChannel\fP = 0x0100 }"
.br
.ti -1c
.RI "enum \fBLinkStatus\fP : uint8_t { \fBUnknownLinkStatus\fP = 0, \fBLinkDown\fP = 1, \fBLinkUp\fP = 2, \fBNegotiate\fP = 3, \fBLinkError\fP = 4 }"
.br
.ti -1c
.RI "enum \fBEthernetPhy\fP : uint8_t { \fBUnknownEthernetPhy\fP = 0, \fBIeee802_3\fP = 1, \fBBroadR_Reach\fP = 2 }"
.br
.ti -1c
.RI "enum \fBDuplex\fP : uint8_t { \fBUnknownDuplex\fP = 0, \fBHalfDuplex\fP = 1, \fBFullDuplex\fP = 2 }"
.br
.ti -1c
.RI "enum \fBMdi\fP : uint8_t { \fBUnknownMdi\fP = 0, \fBDirect\fP = 1, \fBCrossover\fP = 2 }"
.br
.ti -1c
.RI "enum \fBConnector\fP : uint8_t { \fBUnknownConnector\fP = 0, \fBRj45\fP = 1, \fBDSub\fP = 2 }"
.br
.ti -1c
.RI "enum \fBClockMode\fP : uint8_t { \fBUnknownClockMode\fP = 0, \fBMaster\fP = 1, \fBSlave\fP = 2 }"
.br
.ti -1c
.RI "enum \fBPairs\fP : uint8_t { \fBUnknownPairs\fP = 0, \fBBr1Pair\fP = 1, \fBBr2Pair\fP = 2, \fBBr4Pair\fP = 3 }"
.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 "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

Public Member Functions inherited from \fBVector::BLF::ObjectHeader\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader\fP (const ObjectType \fBobjectType\fP, const uint16_t \fBobjectVersion\fP=0)"
.br
.ti -1c
.RI "void \fBread\fP (\fBAbstractFile\fP &is) override"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBAbstractFile\fP &os) override"
.br
.ti -1c
.RI "uint16_t \fBcalculateHeaderSize\fP () const override"
.br
.ti -1c
.RI "uint32_t \fBcalculateObjectSize\fP () const override"
.br
.in -1c

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

.in +1c
.ti -1c
.RI "uint16_t \fBchannel\fP {}"
.br
.ti -1c
.RI "uint16_t \fBflags\fP"
.br
.ti -1c
.RI "uint8_t \fBlinkStatus\fP {}"
.br
.RI "Link Status\&. "
.ti -1c
.RI "uint8_t \fBethernetPhy\fP {}"
.br
.RI "Ethernet Phy\&. "
.ti -1c
.RI "uint8_t \fBduplex\fP {}"
.br
.RI "\fBDuplex\fP\&. "
.ti -1c
.RI "uint8_t \fBmdi\fP {}"
.br
.ti -1c
.RI "uint8_t \fBconnector\fP {}"
.br
.ti -1c
.RI "uint8_t \fBclockMode\fP {}"
.br
.ti -1c
.RI "uint8_t \fBpairs\fP {}"
.br
.ti -1c
.RI "uint8_t \fBhardwareChannel\fP {}"
.br
.ti -1c
.RI "uint32_t \fBbitrate\fP {}"
.br
.RI "Bitrate in [kbit/sec]\&. "
.in -1c

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

Public Attributes inherited from \fBVector::BLF::ObjectHeaderBase\fP
.in +1c
.ti -1c
.RI "uint32_t \fBsignature\fP {ObjectSignature}"
.br
.RI "signature (ObjectSignature) "
.ti -1c
.RI "uint16_t \fBheaderSize\fP {}"
.br
.RI "sizeof object header "
.ti -1c
.RI "uint16_t \fBheaderVersion\fP {}"
.br
.RI "header version (1) "
.ti -1c
.RI "uint32_t \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_STATUS\&. 

Ethernet status\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBVector::BLF::EthernetStatus::ClockMode\fP : uint8_t"
enumeration for clockMode 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownClockMode \fP
Unknown 
.TP
\f(BIMaster \fP
Master 
.TP
\f(BISlave \fP
Slave 
.SS "enum \fBVector::BLF::EthernetStatus::Connector\fP : uint8_t"
enumeration for connector 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownConnector \fP
Unknown 
.TP
\f(BIRj45 \fP
RJ45 
.TP
\f(BIDSub \fP
D-Sub 
.SS "enum \fBVector::BLF::EthernetStatus::Duplex\fP : uint8_t"
enumeration for duplex 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownDuplex \fP
Unknown 
.TP
\f(BIHalfDuplex \fP
Half \fBDuplex\fP 
.TP
\f(BIFullDuplex \fP
Full \fBDuplex\fP 
.SS "enum \fBVector::BLF::EthernetStatus::EthernetPhy\fP : uint8_t"
enumeration for ethernetPhy 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownEthernetPhy \fP
Unknown 
.TP
\f(BIIeee802_3 \fP
IEEE 802\&.3 
.TP
\f(BIBroadR_Reach \fP
BroadR-Reach 
.SS "enum \fBVector::BLF::EthernetStatus::Flags\fP : uint16_t"
enumeration for flags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BILinkStatus \fP
Link Status 
.TP
\f(BIBitrate \fP
Bit rate 
.TP
\f(BIEthernetPhy \fP
Ethernet Phy 
.TP
\f(BIDuplex \fP
\fBDuplex\fP 
.TP
\f(BIMdiType \fP
MDI Type 
.TP
\f(BIConnector \fP
\fBConnector\fP 
.TP
\f(BIClockMode \fP
Clock Mode 
.TP
\f(BIBrPair \fP
BR Pair 
.TP
\f(BIHardwareChannel \fP
Hardware Channel 
.SS "enum \fBVector::BLF::EthernetStatus::LinkStatus\fP : uint8_t"
enumeration for linkStatus 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownLinkStatus \fP
Unknown 
.TP
\f(BILinkDown \fP
Link down 
.TP
\f(BILinkUp \fP
Link up 
.TP
\f(BINegotiate \fP
Negotiate 
.TP
\f(BILinkError \fP
Link error 
.SS "enum \fBVector::BLF::EthernetStatus::Mdi\fP : uint8_t"
enumeration for mdi 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownMdi \fP
Unknown 
.TP
\f(BIDirect \fP
Direct 
.TP
\f(BICrossover \fP
Crossover 
.SS "enum \fBVector::BLF::EthernetStatus::Pairs\fP : uint8_t"
enumeration for pairs 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIUnknownPairs \fP
Unknown 
.TP
\f(BIBr1Pair \fP
BR 1-pair 
.TP
\f(BIBr2Pair \fP
BR 2-pair 
.TP
\f(BIBr4Pair \fP
BR 4-pair 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::EthernetStatus::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 "void Vector::BLF::EthernetStatus::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 "void Vector::BLF::EthernetStatus::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 "uint16_t Vector::BLF::EthernetStatus::channel {}"
The channel of the event\&. 
.SS "uint8_t Vector::BLF::EthernetStatus::clockMode {}"
clock mode 
.SS "uint8_t Vector::BLF::EthernetStatus::connector {}"
connector 
.SS "uint16_t Vector::BLF::EthernetStatus::flags"
flags 
.SS "uint8_t Vector::BLF::EthernetStatus::hardwareChannel {}"
hardware channel 
.SS "uint8_t Vector::BLF::EthernetStatus::mdi {}"
MDI 
.SS "uint8_t Vector::BLF::EthernetStatus::pairs {}"
pairs 

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