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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <FlexRayVFrStatus\&.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
.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 \fBchannel\fP {}"
.br
.RI "application channel "
.ti -1c
.RI "\fBuint16_t\fP \fBversion\fP {}"
.br
.RI "object version "
.ti -1c
.RI "\fBuint16_t\fP \fBchannelMask\fP {}"
.br
.RI "channel mask "
.ti -1c
.RI "\fBuint8_t\fP \fBcycle\fP {}"
.br
.RI "current cycle "
.ti -1c
.RI "\fBuint8_t\fP \fBreservedFlexRayVFrStatus1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBclientIndexFlexRayVFrStatus\fP {}"
.br
.RI "clientindex of send node "
.ti -1c
.RI "\fBuint32_t\fP \fBclusterNo\fP {}"
.br
.RI "number of cluster "
.ti -1c
.RI "\fBuint32_t\fP \fBwus\fP {}"
.br
.RI "wakeup status "
.ti -1c
.RI "\fBuint32_t\fP \fBccSyncState\fP {}"
.br
.RI "sync state of cc "
.ti -1c
.RI "\fBuint32_t\fP \fBtag\fP {}"
.br
.RI "type of cc "
.ti -1c
.RI "std::array< \fBuint32_t\fP, 2 > \fBdata\fP {}"
.br
.RI "register flags "
.ti -1c
.RI "std::array< \fBuint16_t\fP, 18 > \fBreservedFlexRayVFrStatus2\fP {}"
.br
.RI "reserved "
.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 
FR_STATUS\&. 

The content of the FlexRay status event depends on the type of hardware interface\&. The event is generated in one of the following situations:
.IP "\(bu" 2
A symbol is received
.IP "\(bu" 2
The POC state or wakeup state of the CC has changed
.IP "\(bu" 2
The status of the symbol window has changed 
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::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::FlexRayVFrStatus::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::FlexRayVFrStatus::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 "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::ccSyncState {}"

.PP
sync state of cc Sync-State, only valid
.IP "\(bu" 2
for Cyclone 1
.IP "\(bu" 2
for Cyclone II if the wakup state value is 0\&.
.PP
.PP
Meaning:
.IP "\(bu" 2
0 = Not synced passive
.IP "\(bu" 2
1 = Synced active
.IP "\(bu" 2
2 = Not synced 
.PP

.SS "\fBuint16_t\fP Vector::BLF::FlexRayVFrStatus::channel {}"

.PP
application channel Application channel 
.SS "\fBuint16_t\fP Vector::BLF::FlexRayVFrStatus::channelMask {}"

.PP
channel mask Channel Mask
.IP "\(bu" 2
0 = Reserved or invalid
.IP "\(bu" 2
1 = FlexRay Channel A
.IP "\(bu" 2
2 = FlexRay Channel B
.IP "\(bu" 2
3 = FlexRay Channels A and B 
.PP

.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::clientIndexFlexRayVFrStatus {}"

.PP
clientindex of send node Client index of send node\&. Must be set to 0 if file is written from other applications 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::clusterNo {}"

.PP
number of cluster Number of cluster: channel number – 1 
.SS "\fBuint8_t\fP Vector::BLF::FlexRayVFrStatus::cycle {}"

.PP
current cycle Cycle number 
.SS "std::array<\fBuint32_t\fP, 2> Vector::BLF::FlexRayVFrStatus::data {}"

.PP
register flags Driver flags for internal usage
.PP
CC-Type: Cyclone I
.IP "\(bu" 2
data[0]: Content of Protocol state register (PSR)
.IP "\(bu" 2
data[1]: Content of Module config register (MCR0)
.PP
.PP
CC-Type: BUSDOCTOR
.IP "\(bu" 2
LOW-WORD of data[0]: Symbol length
.IP "\(bu" 2
HI-WORD of data[0]: Flags: 1 = possible CAS
.IP "\(bu" 2
data[1]: Reserved
.PP
.PP
CC-Type: VN-Interface
.IP "\(bu" 2
data[0]: POC state of E-Ray register CCSV\&. Only valid
.IP "  \(bu" 4
for Vector interfaces
.IP "  \(bu" 4
if wakeup state is 0 POC State in the operation control phase:
.IP "  \(bu" 4
0x00: DEFAULT_CONFIG
.IP "  \(bu" 4
0x01: READY
.IP "  \(bu" 4
0x02: NORMAL_ACTIVE
.IP "  \(bu" 4
0x03: NORMAL_PASSIVE
.IP "  \(bu" 4
0x04: HALT
.IP "  \(bu" 4
0x05: MONITOR_NODE
.IP "  \(bu" 4
0x06: CONFIG POC State in the wake-up phase:
.IP "  \(bu" 4
0x10: WAKEUP_STANDBY
.IP "  \(bu" 4
0x11: WAKEUP_LISTEN
.IP "  \(bu" 4
0x12: WAKEUP_SEND
.IP "  \(bu" 4
0x13: WAKEUP_DETECT POC State in the start-up phase:
.IP "  \(bu" 4
0x20: STARTUP_PREPARE
.IP "  \(bu" 4
0x21: COLDSTART_LISTEN
.IP "  \(bu" 4
0x22: COLDSTART_COLLISION_RESOLUTION
.IP "  \(bu" 4
0x23: COLDSTART_CONSISTENCY_CHECK
.IP "  \(bu" 4
0x24: COLDSTART_GAP
.IP "  \(bu" 4
0x25: COLDSTART_JOIN
.IP "  \(bu" 4
0x26: INTEGRATION_COLDSTART_CHECK
.IP "  \(bu" 4
0x27: INTEGRATION_LISTEN
.IP "  \(bu" 4
0x28: INTEGRATION_CONSISTENCY_CHECK
.IP "  \(bu" 4
0x29: INITIALIZE_SCHEDULE
.IP "  \(bu" 4
0x30: ABORT_STARTUP
.IP "  \(bu" 4
0x31: STARTUP_SUCCESS All other values are reserved\&.
.PP

.IP "\(bu" 2
LOW-WORD of data[1]: Bit field indicating the symbol window status of the controller and the event source\&.
.IP "  \(bu" 4
1: SESA (Syntax error in symbol window channel A)
.IP "  \(bu" 4
2: SBSA (Slot boundary violation in symbol window channel A)
.IP "  \(bu" 4
4: TCSA (Transmission conflict in symbol window channel A)
.IP "  \(bu" 4
8: SESB (Syntax error in symbol window channel B)
.IP "  \(bu" 4
16: SBSB (Slot boundary violation in symbol window channel B)
.IP "  \(bu" 4
32: TCSB (Transmission conflict in symbol window channel B)
.IP "  \(bu" 4
64: The event was generated from a controller-independent protocol interpreter (Spy)\&.
.IP "  \(bu" 4
128: Cold-start helper POC indicator, if set, event contains the POC state of the cold-start helper All other bits are reserved\&. CANoe/CANalyzer may set some of these bits to 1\&. Other applications must set them to 0\&.
.PP

.IP "\(bu" 2
HI-WORD of data[1]: Symbol length in bit times\&. Only valid for symbol type 4 and if the value is not zero\&. 
.PP

.SS "\fBuint8_t\fP Vector::BLF::FlexRayVFrStatus::reservedFlexRayVFrStatus1 {}"
reserved 
.SS "std::array<\fBuint16_t\fP, 18> Vector::BLF::FlexRayVFrStatus::reservedFlexRayVFrStatus2 {}"

.PP
reserved reserved[0]: If this value is not zero, then the event contains the information about a symbol\&.
.IP "\(bu" 2
0 = Void
.IP "\(bu" 2
1 = CAS
.IP "\(bu" 2
2 = MTS
.IP "\(bu" 2
3 = WUS
.IP "\(bu" 2
4 = Network interface doesn’t provide a symbol interpretation, e\&.g\&. if spy-mode is used or the BUSDOCTOR interface\&. In spy mode, the symbol length is stored in the HI-WORD of data[1]\&.
.PP
.PP
reserved[1\&.\&.15]: Reserved 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::tag {}"

.PP
type of cc Type of communication controller
.IP "\(bu" 2
0 = Architecture independent
.IP "\(bu" 2
1 = Invalid CC type (for internal use only)
.IP "\(bu" 2
2 = Cyclone I
.IP "\(bu" 2
3 = BUSDOCTOR
.IP "\(bu" 2
4 = Cyclone II
.IP "\(bu" 2
5 = Vector VN interface
.IP "\(bu" 2
6 = VN-Sync-Pulse (only in Status Event, for debugging purposes only) 
.PP

.SS "\fBuint16_t\fP Vector::BLF::FlexRayVFrStatus::version {}"

.PP
object version Object version, for internal use 
.SS "\fBuint32_t\fP Vector::BLF::FlexRayVFrStatus::wus {}"

.PP
wakeup status WakeUp state\&. Only valid
.IP "\(bu" 2
for Vector interfaces and for Cyclone II,
.IP "\(bu" 2
if symbol is void (mReserved[0] = 0)
.PP
.PP
Meaning (see E-Ray specification for a detailed description):
.IP "\(bu" 2
0: UNDEFINED
.IP "\(bu" 2
1: RECEIVED_HEADER
.IP "\(bu" 2
2: RECEIVED_WUP
.IP "\(bu" 2
3: COLLISION_HEADER
.IP "\(bu" 2
4: COLLISION_WUP
.IP "\(bu" 2
5: COLLISION_UNKNOWN
.IP "\(bu" 2
6: TRANSMITTED
.IP "\(bu" 2
7: EXTERNAL_WAKEUP
.IP "\(bu" 2
8: WUP_RECEIVED_WITHOUT_WUS_TX 
.PP


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