Vector::BLF::MostSpy(3) | Library Functions Manual | Vector::BLF::MostSpy(3) |
NAME
Vector::BLF::MostSpy - MOST_SPY.
SYNOPSIS
#include <MostSpy.h>
Inherits Vector::BLF::ObjectHeader.
Public Member Functions
void read (AbstractFile &is)
override
void write (AbstractFile &os) override
uint32_t calculateObjectSize () const override
Public Member Functions inherited from
Vector::BLF::ObjectHeader
ObjectHeader (const ObjectType objectType, const
uint16_t objectVersion=0)
void read (AbstractFile &is) override
void write (AbstractFile &os) override
uint16_t calculateHeaderSize () const override
uint32_t calculateObjectSize () const override
Public Member Functions inherited from
Vector::BLF::ObjectHeaderBase
ObjectHeaderBase (const uint16_t headerVersion,
const ObjectType objectType)
ObjectHeaderBase (const ObjectHeaderBase
&)=default
ObjectHeaderBase & operator= (const
ObjectHeaderBase &)=default
ObjectHeaderBase (ObjectHeaderBase &&)=default
ObjectHeaderBase & operator= (ObjectHeaderBase
&&)=default
Public Attributes
uint16_t channel {}
application channel uint8_t dir {}
uint8_t reservedMostSpy1 {}
uint32_t sourceAdr {}
uint32_t destAdr {}
std::array< uint8_t, 17 > msg {}
uint8_t reservedMostSpy2 {}
uint16_t rTyp {}
Control message sub type. uint8_t rTypAdr {}
Addressing mode. uint8_t state {}
Transmission state MOST25. uint8_t reservedMostSpy3 {}
uint8_t ackNack {}
uint32_t crc {}
Public Attributes inherited from Vector::BLF::ObjectHeader
uint32_t objectFlags {ObjectFlags::TimeOneNans}
object flags uint16_t clientIndex {}
client index of send node uint16_t objectVersion {0}
object specific version uint64_t objectTimeStamp {}
object timestamp
Public Attributes inherited from
Vector::BLF::ObjectHeaderBase
uint32_t signature {ObjectSignature}
signature (ObjectSignature) uint16_t headerSize {}
sizeof object header uint16_t headerVersion {}
header version (1) uint32_t objectSize {}
object size ObjectType objectType {ObjectType::UNKNOWN}
object type
Additional Inherited Members
Public Types inherited from Vector::BLF::ObjectHeader
enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001,
TimeOneNans = 0x00000002 }
Detailed Description
MOST_SPY.
Message from MOST 25 Control Channel; received in spy mode (listen only).
Member Function Documentation
uint32_t Vector::BLF::MostSpy::calculateObjectSize () const [override], [virtual]
Calculates the objectSize
Returns
Reimplemented from Vector::BLF::ObjectHeaderBase.
void Vector::BLF::MostSpy::read (AbstractFile & is) [override], [virtual]
Read the data of this object
Parameters
Reimplemented from Vector::BLF::ObjectHeaderBase.
void Vector::BLF::MostSpy::write (AbstractFile & os) [override], [virtual]
Write the data of this object
Parameters
Reimplemented from Vector::BLF::ObjectHeaderBase.
Member Data Documentation
uint8_t Vector::BLF::MostSpy::ackNack {}
AckNack holds the transmit status of a control message (see Transmit Status Register of OS8104 for MOST25).
- •
- Bit 0: Meaning:
- •
- 1: no response (NoResp) Restriction:
- •
- only for Dir = Tx or spy messages
- •
- Bit 1: Meaning:
- •
- 1: valid receipt (Valid) Restriction:
- •
- only for Dir = Tx or spy messages
- •
- Bit 2: Meaning:
- •
- 1: CRC Error (CRCError) Restriction:
- •
- only for Dir = Tx or spy messages
- •
- Bit 3: Meaning:
- •
- 1: receive buffer full (RxBufFull) Restriction:
- •
- only for Dir = Tx or spy messages
- •
- Bit 4: Meaning:
- •
- 1: acknowledged (Ack) Restriction:
- •
- only for Dir = Tx or spy messages (always set to 1 for Rx messages in node mode)
- •
- Bit 5: Meaning:
- •
- 1: negative acknowledge (NAck) Restriction:
- •
- only for Dir = Tx or spy messages
uint32_t Vector::BLF::MostSpy::crc {}
Cyclic Redundancy Check
uint32_t Vector::BLF::MostSpy::destAdr {}
Target address
uint8_t Vector::BLF::MostSpy::dir {}
Direction of message events:
- 0: Rx (received)
- 1: Tx (transmit receipt)
- 2: Tx Request (transmit request)
std::array<uint8_t, 17> Vector::BLF::MostSpy::msg {}
17 data bytes
uint8_t Vector::BLF::MostSpy::reservedMostSpy1 {}
reserved
uint8_t Vector::BLF::MostSpy::reservedMostSpy2 {}
reserved
uint8_t Vector::BLF::MostSpy::reservedMostSpy3 {}
reserved
uint16_t Vector::BLF::MostSpy::rTyp {}
Control message sub type. Sub type of a MOST 25 Control message (see data sheet of OS8104 also).
- 0: Normal
- 1: RemoteRead
- 2: RemoteWrite
- 3: Alloc
- 4: Dealloc
- 5: GetSource
- >5: not used so far
uint8_t Vector::BLF::MostSpy::rTypAdr {}
Addressing mode. Addressing mode of MOST25 Control messages.
- 0x00: Device (logical node address)
- 0x10: Node position
- 0x20: Broadcast
- 0x30: Groupcast
- 0xFF: Unknown
uint32_t Vector::BLF::MostSpy::sourceAdr {}
Source address
uint8_t Vector::BLF::MostSpy::state {}
Transmission state MOST25. Transmission state of a MOST25 Control message.
- •
- Bit 0: Meaning:
- •
- 0: bus inactive
- •
- 1: bus active Restriction:
- •
- only for Dir = Rx (MOSTCtrl) or MOSTSpy
- •
- Bit 1: Meaning:
- •
- 1: unlock event during transmission (Unl) Restriction:
- •
- only for Dir = Rx (MOSTCtrl) or MOSTSpy
- •
- Bit 4: Meaning:
- •
- 1: acknowledged (Ack) Restriction:
- •
- only for Dir = Tx (always set to 1 for Rx messages in node mode)
- •
- Bit 5: Meaning:
- •
- 1: not acknowledged (NAck) Restriction:
- •
- only for Dir = Tx
- •
- Bit 6: Meaning:
- •
- Send result:
- •
- 0: Transmission error (TxF)
- •
- 1: OK Restriction:
- •
- only for Dir = Tx (MOSTCtrl)
Author
Generated automatically by Doxygen for Vector BLF from the source code.
Vector BLF |