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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <MostGenReg\&.h>\fP
.PP
Inherits \fBVector::BLF::ObjectHeader2\fP\&.
.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::ObjectHeader2\fP
.in +1c
.ti -1c
.RI "\fBObjectHeader2\fP (const ObjectType \fBobjectType\fP)"
.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 \fBsubType\fP {}"
.br
.RI "read/write request/result "
.ti -1c
.RI "uint8_t \fBreservedMostGenReg1\fP {}"
.br
.ti -1c
.RI "uint32_t \fBhandle\fP {}"
.br
.RI "operation handle "
.ti -1c
.RI "uint16_t \fBregId\fP {}"
.br
.RI "register ID "
.ti -1c
.RI "uint16_t \fBreservedMostGenReg2\fP {}"
.br
.ti -1c
.RI "uint32_t \fBreservedMostGenReg3\fP {}"
.br
.ti -1c
.RI "uint64_t \fBregValue\fP {}"
.br
.RI "register value "
.in -1c

Public Attributes inherited from \fBVector::BLF::ObjectHeader2\fP
.in +1c
.ti -1c
.RI "uint32_t \fBobjectFlags\fP {\fBObjectFlags::TimeOneNans\fP}"
.br
.RI "object flags "
.ti -1c
.RI "uint8_t \fBtimeStampStatus\fP {}"
.br
.RI "time stamp status "
.ti -1c
.RI "uint8_t \fBreservedObjectHeader\fP {0}"
.br
.ti -1c
.RI "uint16_t \fBobjectVersion\fP {0}"
.br
.RI "object specific version "
.ti -1c
.RI "uint64_t \fBobjectTimeStamp\fP {0}"
.br
.RI "object timestamp "
.ti -1c
.RI "uint64_t \fBoriginalTimeStamp\fP {0}"
.br
.RI "original 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
.SS "Additional Inherited Members"


Public Types inherited from \fBVector::BLF::ObjectHeader2\fP
.in +1c
.ti -1c
.RI "enum \fBObjectFlags\fP : uint32_t { \fBTimeTenMics\fP = 0x00000001, \fBTimeOneNans\fP = 0x00000002 }"
.br
.ti -1c
.RI "enum \fBTimeStampStatus\fP : uint8_t { \fBOrig\fP = 0x01, \fBSwHw\fP = 0x02, \fBUser\fP = 0x10 }"
.br
.in -1c
.SH "Detailed Description"
.PP 
MOST_GENREG\&. 

This event reports the change of an important transceiver register like node position or node address\&. It can occur spontaneous or as result of a read/write operation\&. Directly after measurement start the current values of the special registers are reported even if they have not changed\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::MostGenReg::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::MostGenReg::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::MostGenReg::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::MostGenReg::channel {}"

.PP
application channel Application channel 
.SS "uint32_t Vector::BLF::MostGenReg::handle {}"

.PP
operation handle Operation handle (obsolete; write 0) 
.SS "uint16_t Vector::BLF::MostGenReg::regId {}"

.PP
register ID IDs for identifying registers\&.
.IP "\(bu" 2
Empty = 0x0
.IP "\(bu" 2
NPR = 0x87: 8 bit Node Position register
.IP "\(bu" 2
GA = 0x89: 8 bit Group (Group Address = 0x0300 + Group)
.IP "\(bu" 2
NA = 0x8A: 16 bit Node Address
.IP "\(bu" 2
NDR = 0x8F: 8 bit Node Delay (MOST25 only)
.IP "\(bu" 2
MPR = 0x90: 8 bit Number of nodes with open bypass
.IP "\(bu" 2
MDR = 0x91: 8 bit Maximum Delay (MOST25 only)
.IP "\(bu" 2
SBC = 0x96: 8 bit Synchronous Bandwidth Control (SBC)
.IP "  \(bu" 4
Synchronous Bandwidth = 4 x SBC
.IP "  \(bu" 4
Maximum values for SBC:
.IP "    \(bu" 6
MOST25: 15 (= 60 Bytes)
.IP "    \(bu" 6
MOST50: 29 (= 116 Bytes)
.IP "    \(bu" 6
MOST150: 93 (= 372 Bytes)
.PP

.PP

.IP "\(bu" 2
APA = 0xE8: 16 bit Alternate Packet Address (MOST25 only)
.IP "\(bu" 2
XTIM = 0xBE: 8 bit Transmit Retry Time
.IP "\(bu" 2
XRTY = 0xBF: 8 bit Number of send attempts
.IP "\(bu" 2
MacAdr = 0xFE: 48 bit MAC address (EUI-48, conforming to the IEEE standard; MOST150 only) 
.PP

.SS "uint64_t Vector::BLF::MostGenReg::regValue {}"

.PP
register value Register value 
.SS "uint8_t Vector::BLF::MostGenReg::reservedMostGenReg1 {}"
reserved 
.SS "uint16_t Vector::BLF::MostGenReg::reservedMostGenReg2 {}"
reserved 
.SS "uint32_t Vector::BLF::MostGenReg::reservedMostGenReg3 {}"
reserved 
.SS "uint8_t Vector::BLF::MostGenReg::subType {}"

.PP
read/write request/result Operation type of a register event\&.
.IP "\(bu" 2
Unspecified = 0: unspecified (or HW does not support sub types)
.IP "\(bu" 2
Notify = 1: notification on register change (spontaneous)
.IP "\(bu" 2
ReadRequest = 2: request of a register read operation
.IP "\(bu" 2
WriteRequest = 3: request of a register write operation
.IP "\(bu" 2
ReadResult = 4: result of a register read operation
.IP "\(bu" 2
WriteResult = 5: result of a register write operation
.IP "\(bu" 2
ReadFailed = 6: register read operation failed
.IP "\(bu" 2
WriteFailed = 7: register write operation failed 
.PP


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