Midnight Sun Firmware
Loading...
Searching...
No Matches
Metadata
Collaboration diagram for Metadata:

Classes

struct  Payload
 Metadata Datagram payload storage. More...
 

Public Member Functions

 Metadata (Payload &data)
 Constructs a Metadata object with provided payload data. More...
 
 Metadata ()=default
 Default constructor for Metadata object.
 
std::string serialize () const
 Serializes Metadata data with the Metadata command code for transmission. More...
 
void deserialize (std::string &metadataPayload)
 Deserializes Metadata data from payload string. More...
 
void setProjectName (const std::string &projectName)
 Sets the target project name. More...
 
void setProjectStatus (const std::string &projectStatus)
 Sets the target project status. More...
 
void setHardwareModel (const std::string &hardwareModel)
 Sets the target hardware model. More...
 
std::string getProjectName () const
 Gets the target project name. More...
 
std::string getProjectStatus () const
 Gets the target project status. More...
 
std::string getHardwareModel () const
 Gets the target hardware model. More...
 

Private Attributes

Payload m_metadata
 

Constructor & Destructor Documentation

◆ Metadata()

Metadata ( Payload data)
explicit

Constructs a Metadata object with provided payload data.

Parameters
dataReference to payload data

Member Function Documentation

◆ deserialize()

void deserialize ( std::string &  metadataPayload)

Deserializes Metadata data from payload string.

Parameters
metadataPayloadString containing serialized Metadata data

◆ getHardwareModel()

std::string getHardwareModel ( ) const

Gets the target hardware model.

Returns
Target hardware model

◆ getProjectName()

std::string getProjectName ( ) const

Gets the target project name.

Returns
Target project name

◆ getProjectStatus()

std::string getProjectStatus ( ) const

Gets the target project status.

Returns
Target project status

◆ serialize()

std::string serialize ( ) const

Serializes Metadata data with the Metadata command code for transmission.

Returns
Serialized string containing Metadata data

◆ setHardwareModel()

void setHardwareModel ( const std::string &  hardwareModel)

Sets the target hardware model.

Parameters
hardwareModelUpdated hardware model

◆ setProjectName()

void setProjectName ( const std::string &  projectName)

Sets the target project name.

Parameters
projectNameUpdated project name

◆ setProjectStatus()

void setProjectStatus ( const std::string &  projectStatus)

Sets the target project status.

Parameters
projectStatusUpdated project status

Member Data Documentation

◆ m_metadata

Payload m_metadata
private

Private datagram payload


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