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

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

.in +1c
.ti -1c
.RI "enum \fBFlags\fP : uint8_t { \fBWasAwake\fP = 0x01, \fBIsAwake\fP = 0x02, \fBExternal\fP = 0x04 }"
.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
.RI "application channel "
.ti -1c
.RI "uint8_t \fBreason\fP {}"
.br
.ti -1c
.RI "uint8_t \fBflags\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedLinSleepModeEvent\fP {}"
.br
.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 
LIN_SLEEP\&. 

This info event occurs at the start of a measurement in order to report the initial state of the LIN hardware and every time the mode (awake/asleep) of LIN hardware changes\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBVector::BLF::LinSleepModeEvent::Flags\fP : uint8_t"
Bit values for flags 
.PP
\fBEnumerator\fP
.in +1c
.TP
\f(BIWasAwake \fP
LIN "was awake"\&. 
.TP
\f(BIIsAwake \fP
LIN "is awake"\&. 
.TP
\f(BIExternal \fP
LIN "external"\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::LinSleepModeEvent::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::LinSleepModeEvent::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::LinSleepModeEvent::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::LinSleepModeEvent::channel {}"

.PP
application channel Channel number where the event notified 
.SS "uint8_t Vector::BLF::LinSleepModeEvent::flags {}"
Bit mask with bit values as following:

.PP
Bit 0 (LSB): Indicates the state of the LIN hardware before this event occurred:
.IP "\(bu" 2
1: Awake
.IP "\(bu" 2
0: Asleep
.PP

.PP
Bit 1: Indicates the current state of the LIN hardware:
.IP "\(bu" 2
1: Awake
.IP "\(bu" 2
0: Asleep
.PP

.PP
Bit 2: Indicates whether this event caused by external or internal event:
.IP "\(bu" 2
1: External event
.IP "\(bu" 2
0: Internal event 
.PP

.SS "uint8_t Vector::BLF::LinSleepModeEvent::reason {}"
This value indicates the reason for an event\&. Following values are possible:
.IP "\(bu" 2
0: Start state
.PP

.PP
Transition to Sleep mode
.IP "\(bu" 2
1: Go-to-Sleep frame
.IP "\(bu" 2
2: Bus Idle Timeout
.IP "\(bu" 2
3: Silent SleepMode command (for shortening the BusIdle Timeout)
.PP

.PP
Leaving Sleep mode:
.IP "\(bu" 2
9: External Wakeup signal
.IP "\(bu" 2
10: Internal Wakeup signal
.IP "\(bu" 2
11: Bus traffic (can only occur if the LIN hardware does not have a Master function)
.PP

.PP
LIN hardware does not go into Sleep mode in spite of request to do so:
.IP "\(bu" 2
18: Bus traffic (can only occur if the LIN hardware does not have a Master function) 
.PP

.SS "uint32_t Vector::BLF::LinSleepModeEvent::reservedLinSleepModeEvent {}"
reserved 

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