XJ::SegmentMessage Class Reference

#include <SegmentMessage.h>

Inheritance diagram for XJ::SegmentMessage:

Public Types
enum	Type { Debug , Info , Warning , Error }

Public Member Functions
	SegmentMessage ()=default
bool	equals (const SegmentMessage &segmentMessage) const
unsigned long long	hashCode () const
Public Member Functions inherited from XJ::SegmentEntity
	SegmentEntity ()=default

Static Public Member Functions
static SegmentMessage::Type	parseType (const std::string &value)
static std::string	toString (const SegmentMessage::Type &type)

Public Attributes
SegmentMessage::Type	type {}
std::string	body
Public Attributes inherited from XJ::SegmentEntity
UUID	id
int	segmentId {}

Member Enumeration Documentation

Type

enum XJ::SegmentMessage::Type

Enumerator
Debug
Info
Warning
Error

Constructor & Destructor Documentation

SegmentMessage()

XJ::SegmentMessage::SegmentMessage ( )

default

Member Function Documentation

equals()

bool SegmentMessage::equals

(

const SegmentMessage &

segmentMessage

)

const

Assert equality with another Segment Message

Parameters

segmentMessage

The Segment Message to compare

Returns

true if equal

hashCode()

unsigned long long SegmentMessage::hashCode

(

)

const

Determine a unique hash code for the Segment Message

Returns

hash code

parseType()

SegmentMessage::Type SegmentMessage::parseType ( const std::string &  value )

static

Parse the Segment Message Type enum value from a string

Parameters

value

The string to parse

Returns

The Segment Message Type enum value

toString()

std::string SegmentMessage::toString ( const SegmentMessage::Type &  type )

static

Convert an Segment Message Type enum value to a string

Parameters

type	The Segment Message Type enum value

Returns

The string representation of the Segment Message Type

Member Data Documentation

body

std::string XJ::SegmentMessage::body

type

SegmentMessage::Type XJ::SegmentMessage::type {}

---

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

• /home/runner/work/xjmusic/xjmusic/engine/include/xjmusic/segment/SegmentMessage.h
• /home/runner/work/xjmusic/xjmusic/engine/src/segment/SegmentMessage.cpp