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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <MostSpy\&.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 "\fBuint8_t\fP \fBdir\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBreservedMostSpy1\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBsourceAdr\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBdestAdr\fP {}"
.br
.ti -1c
.RI "std::array< \fBuint8_t\fP, 17 > \fBmsg\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBreservedMostSpy2\fP {}"
.br
.ti -1c
.RI "\fBuint16_t\fP \fBrTyp\fP {}"
.br
.RI "Control message sub type\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBrTypAdr\fP {}"
.br
.RI "Addressing mode\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBstate\fP {}"
.br
.RI "Transmission state MOST25\&. "
.ti -1c
.RI "\fBuint8_t\fP \fBreservedMostSpy3\fP {}"
.br
.ti -1c
.RI "\fBuint8_t\fP \fBackNack\fP {}"
.br
.ti -1c
.RI "\fBuint32_t\fP \fBcrc\fP {}"
.br
.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 
MOST_SPY\&. 

Message from MOST 25 Control Channel; received in spy mode (listen only)\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBuint32_t\fP Vector::BLF::MostSpy::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::MostSpy::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::MostSpy::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 "\fBuint8_t\fP Vector::BLF::MostSpy::ackNack {}"
AckNack holds the transmit status of a control message (see Transmit Status Register of OS8104 for MOST25)\&.
.IP "\(bu" 2
Bit 0: Meaning:
.IP "  \(bu" 4
1: no response (NoResp) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages
.PP

.IP "\(bu" 2
Bit 1: Meaning:
.IP "  \(bu" 4
1: valid receipt (Valid) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages
.PP

.IP "\(bu" 2
Bit 2: Meaning:
.IP "  \(bu" 4
1: CRC Error (CRCError) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages
.PP

.IP "\(bu" 2
Bit 3: Meaning:
.IP "  \(bu" 4
1: receive buffer full (RxBufFull) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages
.PP

.IP "\(bu" 2
Bit 4: Meaning:
.IP "  \(bu" 4
1: acknowledged (Ack) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode)
.PP

.IP "\(bu" 2
Bit 5: Meaning:
.IP "  \(bu" 4
1: negative acknowledge (NAck) Restriction:
.IP "  \(bu" 4
only for Dir = Tx or spy messages 
.PP

.PP

.SS "\fBuint32_t\fP Vector::BLF::MostSpy::crc {}"
Cyclic Redundancy Check 
.SS "\fBuint32_t\fP Vector::BLF::MostSpy::destAdr {}"
Target address 
.SS "\fBuint8_t\fP Vector::BLF::MostSpy::dir {}"
Direction of message events:
.IP "\(bu" 2
0: Rx (received)
.IP "\(bu" 2
1: Tx (transmit receipt)
.IP "\(bu" 2
2: Tx Request (transmit request) 
.PP

.SS "std::array<\fBuint8_t\fP, 17> Vector::BLF::MostSpy::msg {}"
17 data bytes 
.SS "\fBuint8_t\fP Vector::BLF::MostSpy::reservedMostSpy1 {}"
reserved 
.SS "\fBuint8_t\fP Vector::BLF::MostSpy::reservedMostSpy2 {}"
reserved 
.SS "\fBuint8_t\fP Vector::BLF::MostSpy::reservedMostSpy3 {}"
reserved 
.SS "\fBuint16_t\fP Vector::BLF::MostSpy::rTyp {}"

.PP
Control message sub type\&. Sub type of a MOST 25 Control message (see data sheet of OS8104 also)\&.
.IP "\(bu" 2
0: Normal
.IP "\(bu" 2
1: RemoteRead
.IP "\(bu" 2
2: RemoteWrite
.IP "\(bu" 2
3: Alloc
.IP "\(bu" 2
4: Dealloc
.IP "\(bu" 2
5: GetSource
.IP "\(bu" 2
>5: not used so far 
.PP

.SS "\fBuint8_t\fP Vector::BLF::MostSpy::rTypAdr {}"

.PP
Addressing mode\&. Addressing mode of MOST25 Control messages\&.
.IP "\(bu" 2
0x00: Device (logical node address)
.IP "\(bu" 2
0x10: Node position
.IP "\(bu" 2
0x20: Broadcast
.IP "\(bu" 2
0x30: Groupcast
.IP "\(bu" 2
0xFF: Unknown 
.PP

.SS "\fBuint32_t\fP Vector::BLF::MostSpy::sourceAdr {}"
Source address 
.SS "\fBuint8_t\fP Vector::BLF::MostSpy::state {}"

.PP
Transmission state MOST25\&. Transmission state of a MOST25 Control message\&.
.IP "\(bu" 2
Bit 0: Meaning:
.IP "  \(bu" 4
0: bus inactive
.IP "  \(bu" 4
1: bus active Restriction:
.IP "  \(bu" 4
only for Dir = Rx (MOSTCtrl) or MOSTSpy
.PP

.IP "\(bu" 2
Bit 1: Meaning:
.IP "  \(bu" 4
1: unlock event during transmission (Unl) Restriction:
.IP "  \(bu" 4
only for Dir = Rx (MOSTCtrl) or MOSTSpy
.PP

.IP "\(bu" 2
Bit 4: Meaning:
.IP "  \(bu" 4
1: acknowledged (Ack) Restriction:
.IP "  \(bu" 4
only for Dir = Tx (always set to 1 for Rx messages in node mode)
.PP

.IP "\(bu" 2
Bit 5: Meaning:
.IP "  \(bu" 4
1: not acknowledged (NAck) Restriction:
.IP "  \(bu" 4
only for Dir = Tx
.PP

.IP "\(bu" 2
Bit 6: Meaning:
.IP "  \(bu" 4
Send result:
.IP "    \(bu" 6
0: Transmission error (TxF)
.IP "    \(bu" 6
1: OK Restriction:
.PP

.IP "  \(bu" 4
only for Dir = Tx (MOSTCtrl) 
.PP

.PP


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