Vector::BLF::MostCtrl(3) Library Functions Manual Vector::BLF::MostCtrl(3)
NAME
Vector::BLF::MostCtrl - MOST_CTRL.
SYNOPSIS
#include <MostCtrl.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 reservedMostCtrl1 {}
uint32_t sourceAdr {}
uint32_t destAdr {}
std::array< uint8_t, 17 > msg {}
uint8_t reservedMostCtrl2 {}
uint16_t rTyp {}
Control message sub type.
uint8_t rTypAdr {}
Addressing mode.
uint8_t state {}
Transmission state MOST25.
uint8_t reservedMostCtrl3 {}
uint8_t ackNack {}
acknowledge bits
uint32_t reservedMostCtrl4 {}
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_CTRL.
Message on MOST 25 Control Channel; received or transmitted in node
mode.
Member Function Documentation
uint32_t Vector::BLF::MostCtrl::calculateObjectSize () const [override],
[virtual]
Calculates the objectSize
Returns
object size
Reimplemented from Vector::BLF::ObjectHeaderBase.
void Vector::BLF::MostCtrl::read (AbstractFile & is) [override], [virtual]
Read the data of this object
Parameters
is input stream
Reimplemented from Vector::BLF::ObjectHeaderBase.
void Vector::BLF::MostCtrl::write (AbstractFile & os) [override],
[virtual]
Write the data of this object
Parameters
os output stream
Reimplemented from Vector::BLF::ObjectHeaderBase.
Member Data Documentation
uint8_t Vector::BLF::MostCtrl::ackNack {}
acknowledge bits AckNack holds the transmit status of a control message
(see Transmit Status Register of OS8104 for MOST25).
o Bit 0: Meaning:
o 1: no response (NoResp) Restriction:
o only for Dir = Tx or spy messages
o Bit 1: Meaning:
o 1: valid receipt (Valid) Restriction:
o only for Dir = Tx or spy messages
o Bit 2: Meaning:
o 1: CRC Error (CRCError) Restriction:
o only for Dir = Tx or spy messages
o Bit 3: Meaning:
o 1: receive buffer full (RxBufFull) Restriction:
o only for Dir = Tx or spy messages
o Bit 4: Meaning:
o 1: acknowledged (Ack) Restriction:
o only for Dir = Tx or spy messages (always set to 1 for Rx messages
in node mode)
o Bit 5: Meaning:
o 1: negative acknowledge (NAck) Restriction:
o only for Dir = Tx or spy messages
uint16_t Vector::BLF::MostCtrl::channel {}
application channel Channel the message was sent or received.
uint32_t Vector::BLF::MostCtrl::destAdr {}
Target address
uint8_t Vector::BLF::MostCtrl::dir {}
Direction of message events:
o 0: Rx (received)
o 1: Tx (transmit receipt)
o 2: Tx Request (transmit request)
std::array<uint8_t, 17> Vector::BLF::MostCtrl::msg {}
17 data bytes
uint8_t Vector::BLF::MostCtrl::reservedMostCtrl1 {}
reserved
uint8_t Vector::BLF::MostCtrl::reservedMostCtrl2 {}
reserved
uint8_t Vector::BLF::MostCtrl::reservedMostCtrl3 {}
reserved
uint32_t Vector::BLF::MostCtrl::reservedMostCtrl4 {}
reserved
uint16_t Vector::BLF::MostCtrl::rTyp {}
Control message sub type. Sub type of a MOST 25 Control message (see
data sheet of OS8104 also).
o 0: Normal
o 1: RemoteRead
o 2: RemoteWrite
o 3: Alloc
o 4: Dealloc
o 5: GetSource
o >5: not used so far
uint8_t Vector::BLF::MostCtrl::rTypAdr {}
Addressing mode. Addressing mode of MOST25 Control messages.
o 0x00: Device (logical node address)
o 0x10: Node position
o 0x20: Broadcast
o 0x30: Groupcast
o 0xFF: Unknown
uint32_t Vector::BLF::MostCtrl::sourceAdr {}
Source address
uint8_t Vector::BLF::MostCtrl::state {}
Transmission state MOST25. Transmission state of a MOST25 Control
message.
o Bit 0: Meaning:
o 0: bus inactive
o 1: bus active Restriction:
o only for Dir = Rx (MOSTCtrl) or MOSTSpy
o Bit 1: Meaning:
o 1: unlock event during transmission (Unl) Restriction:
o only for Dir = Rx (MOSTCtrl) or MOSTSpy
o Bit 4: Meaning:
o 1: acknowledged (Ack) Restriction:
o only for Dir = Tx (always set to 1 for Rx messages in node mode)
o Bit 5: Meaning:
o 1: not acknowledged (NAck) Restriction:
o only for Dir = Tx
o Bit 6: Meaning:
o Send result:
o 0: Transmission error (TxF)
o 1: OK Restriction:
o only for Dir = Tx (MOSTCtrl)
Author
Generated automatically by Doxygen for Vector BLF from the source code.
Vector BLF Vector::BLF::MostCtrl(3)