mimosis::Message Class Reference

Class for handling a 16-bit MIMOSIS message word. More...

#include <MimosisMessage.h>

Public Member Functions
	Message ()
	Message (uint16_t word)
	Message (const Message &)=default
Message &	operator= (const Message &)=default
uint16_t	GetRaw () const
void	SetRaw (uint16_t w)
WordType	GetWordType () const
	– Type
uint16_t	GetPixelAddress () const
	— Pixel address data (valid if PixelData)
uint8_t	GetPEAddress () const
uint8_t	GetCode () const
bool	IsValidPixelAddress () const
	True if pixel address is 0..504.
uint8_t	GetRegionNumber () const
	— Region header (valid if RegionHeader)
bool	IsFrameHeader () const
	— Frame header helpers
uint32_t	GetFrameNumber () const
	Only valid on the correct header word.
bool	IsFrameTrailer () const
	— Frame trailer
uint16_t	GetCRC () const
uint8_t	GetTrailerFlags () const
bool	IsRegionHeader () const
bool	IsPixelData () const
bool	IsEmptyWord () const
bool	IsSpareWord () const
std::string	ToString () const
	— For debugging: human readable string

Static Public Member Functions
static std::string	PrintWordType (WordType type)

Private Attributes
uint16_t	fWord

Static Private Attributes
static constexpr uint16_t	kMaxPixelAddress = 504

Detailed Description

Class for handling a 16-bit MIMOSIS message word.

Definition at line 52 of file MimosisMessage.h.

Constructor & Destructor Documentation

Message() [1/3]

mimosis::Message::Message ( )

inline

Definition at line 54 of file MimosisMessage.h.

References fWord.

Referenced by Message(), and operator=().

Message() [2/3]

mimosis::Message::Message ( uint16_t word )

inlineexplicit

Definition at line 55 of file MimosisMessage.h.

References fWord.

Message() [3/3]

mimosis::Message::Message ( const Message & )

default

References Message().

Member Function Documentation

GetCode()

uint8_t mimosis::Message::GetCode

(

)

const

Definition at line 36 of file MimosisMessage.cxx.

References fWord.

Referenced by ToString().

GetCRC()

uint16_t mimosis::Message::GetCRC

(

)

const

Definition at line 67 of file MimosisMessage.cxx.

References fWord.

GetFrameNumber()

uint32_t mimosis::Message::GetFrameNumber

(

)

const

Only valid on the correct header word.

Definition at line 55 of file MimosisMessage.cxx.

References fWord.

GetPEAddress()

uint8_t mimosis::Message::GetPEAddress

(

)

const

Definition at line 31 of file MimosisMessage.cxx.

References fWord.

Referenced by ToString().

GetPixelAddress()

uint16_t mimosis::Message::GetPixelAddress

(

)

const

— Pixel address data (valid if PixelData)

Definition at line 25 of file MimosisMessage.cxx.

References fWord.

Referenced by IsValidPixelAddress(), and ToString().

GetRaw()

uint16_t mimosis::Message::GetRaw ( ) const

inline

Definition at line 59 of file MimosisMessage.h.

References fWord.

GetRegionNumber()

uint8_t mimosis::Message::GetRegionNumber

(

)

const

— Region header (valid if RegionHeader)

Definition at line 47 of file MimosisMessage.cxx.

References fWord.

Referenced by ToString().

GetTrailerFlags()

uint8_t mimosis::Message::GetTrailerFlags

(

)

const

Definition at line 73 of file MimosisMessage.cxx.

References fWord.

Referenced by ToString().

GetWordType()

WordType mimosis::Message::GetWordType

(

)

const

– Type

Definition at line 13 of file MimosisMessage.cxx.

References mimosis::Empty, mimosis::FrameHeader, mimosis::FrameTrailer, fWord, mimosis::PixelData, mimosis::RegionHeader, mimosis::Spare, and mimosis::Unknown.

Referenced by IsEmptyWord(), IsFrameHeader(), IsFrameTrailer(), IsPixelData(), IsRegionHeader(), IsSpareWord(), IsValidPixelAddress(), and ToString().

IsEmptyWord()

bool mimosis::Message::IsEmptyWord

(

)

const

Definition at line 81 of file MimosisMessage.cxx.

References mimosis::Empty, and GetWordType().

IsFrameHeader()

bool mimosis::Message::IsFrameHeader

(

)

const

— Frame header helpers

Definition at line 53 of file MimosisMessage.cxx.

References mimosis::FrameHeader, and GetWordType().

IsFrameTrailer()

bool mimosis::Message::IsFrameTrailer

(

)

const

— Frame trailer

Definition at line 65 of file MimosisMessage.cxx.

References mimosis::FrameTrailer, and GetWordType().

IsPixelData()

bool mimosis::Message::IsPixelData

(

)

const

Definition at line 80 of file MimosisMessage.cxx.

References GetWordType(), and mimosis::PixelData.

IsRegionHeader()

bool mimosis::Message::IsRegionHeader

(

)

const

Definition at line 79 of file MimosisMessage.cxx.

References GetWordType(), and mimosis::RegionHeader.

IsSpareWord()

bool mimosis::Message::IsSpareWord

(

)

const

Definition at line 82 of file MimosisMessage.cxx.

References GetWordType(), and mimosis::Spare.

IsValidPixelAddress()

bool mimosis::Message::IsValidPixelAddress

(

)

const

True if pixel address is 0..504.

Definition at line 41 of file MimosisMessage.cxx.

References GetPixelAddress(), GetWordType(), kMaxPixelAddress, and mimosis::PixelData.

Referenced by ToString().

operator=()

Message & mimosis::Message::operator= ( const Message & )

default

References Message().

PrintWordType()

std::string mimosis::Message::PrintWordType ( WordType type )

static

Definition at line 84 of file MimosisMessage.cxx.

References mimosis::Empty, mimosis::FrameHeader, mimosis::FrameTrailer, mimosis::PixelData, mimosis::RegionHeader, and mimosis::Spare.

Referenced by ToString().

SetRaw()

void mimosis::Message::SetRaw ( uint16_t w )

inline

Definition at line 60 of file MimosisMessage.h.

References fWord.

ToString()

std::string mimosis::Message::ToString

(

)

const

— For debugging: human readable string

Definition at line 97 of file MimosisMessage.cxx.

References mimosis::Empty, mimosis::FrameHeader, mimosis::FrameTrailer, fWord, GetCode(), GetPEAddress(), GetPixelAddress(), GetRegionNumber(), GetTrailerFlags(), GetWordType(), IsValidPixelAddress(), mimosis::PixelData, PrintWordType(), mimosis::RegionHeader, and mimosis::Spare.

Member Data Documentation

fWord

uint16_t mimosis::Message::fWord

private

Definition at line 94 of file MimosisMessage.h.

Referenced by GetCode(), GetCRC(), GetFrameNumber(), GetPEAddress(), GetPixelAddress(), GetRaw(), GetRegionNumber(), GetTrailerFlags(), GetWordType(), Message(), Message(), SetRaw(), and ToString().

kMaxPixelAddress

uint16_t mimosis::Message::kMaxPixelAddress = 504

staticconstexprprivate

Definition at line 95 of file MimosisMessage.h.

Referenced by IsValidPixelAddress().

---

The documentation for this class was generated from the following files:

• MimosisMessage.h
• MimosisMessage.cxx