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

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <MostReg\&.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 \fBreservedMostReg\fP {}"
.br
.ti -1c
.RI "uint32_t \fBhandle\fP {}"
.br
.RI "operation handle "
.ti -1c
.RI "uint32_t \fBoffset\fP {}"
.br
.RI "start address "
.ti -1c
.RI "uint16_t \fBchip\fP {}"
.br
.RI "chip id "
.ti -1c
.RI "uint16_t \fBregDataLen\fP {}"
.br
.RI "number of bytes "
.ti -1c
.RI "std::array< uint8_t, 16 > \fBregData\fP {}"
.br
.RI "data bytes "
.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_REG\&. 

This event transports a register read or write result (e\&.g\&. reading the routing engine of the OS8104)\&. Unlike the special register event (\fBMostGenReg\fP) this event does not occur spontaneous\&. 
.SH "Member Function Documentation"
.PP 
.SS "uint32_t Vector::BLF::MostReg::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::MostReg::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::MostReg::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::MostReg::channel {}"

.PP
application channel Application channel 
.SS "uint16_t Vector::BLF::MostReg::chip {}"

.PP
chip id ID of chip
.IP "\(bu" 2
1 – OS8104 
.PP

.SS "uint32_t Vector::BLF::MostReg::handle {}"

.PP
operation handle Operation handle (obsolete; write 0) 
.SS "uint32_t Vector::BLF::MostReg::offset {}"

.PP
start address Register address offset 
.SS "std::array<uint8_t, 16> Vector::BLF::MostReg::regData {}"

.PP
data bytes Register data 
.SS "uint16_t Vector::BLF::MostReg::regDataLen {}"

.PP
number of bytes Number of valid bytes in regData 
.SS "uint8_t Vector::BLF::MostReg::reservedMostReg {}"
reserved 
.SS "uint8_t Vector::BLF::MostReg::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\&.