Rose::BinaryAnalysis::Serialization::FrameRecord Class Reference

Description

Helper class for metadata and payload handling.

This class serves as a convenient abstraction for working with metadata and payloads in the serialization system. It provides direct access to metadata fields, methods to manipulate the payload, and serialization support.

Definition at line 57 of file SerialFrame.h.

#include <Rose/BinaryAnalysis/Serialization/SerialFrame.h>

Public Member Functions
	FrameRecord ()
	Default constructor creates an empty record.
	FrameRecord (Serialization::Savable objectType, Serialization::Format format)
	Construct with specific objectType and format.
	FrameRecord (const Record &record)
	Construct from a Record struct.
Record	toRecord () const
	Convert to a Record struct.
const std::vector< char > &	payload () const
	Field getter and setters.
void	payload (const std::vector< char > &payload)
Serialization::Savable	objectType () const
void	objectType (Serialization::Savable type)
Serialization::Format	format () const
void	format (Serialization::Format fmt)
std::string	roseVersion () const
void	roseVersion (const std::string &ver)
std::uint64_t	payloadSize () const
	Get the payload size.
template<typename T >
void	serializeObject (const T &object)
	Template method to serialize an object directly to this record's payload.
template<typename T >
void	deserializeObject (T &object) const
	Template method to deserialize an object from this record's payload.
template<class Archive >
void	serialize (Archive &ar, const unsigned)
	Boost serialization support.

Constructor & Destructor Documentation

FrameRecord() [1/3]

Rose::BinaryAnalysis::Serialization::FrameRecord::FrameRecord ( )

inline

Default constructor creates an empty record.

Definition at line 60 of file SerialFrame.h.

FrameRecord() [2/3]

Rose::BinaryAnalysis::Serialization::FrameRecord::FrameRecord ( Serialization::Savable  objectType, Serialization::Format  format  )

inline

Construct with specific objectType and format.

Definition at line 64 of file SerialFrame.h.

FrameRecord() [3/3]

Rose::BinaryAnalysis::Serialization::FrameRecord::FrameRecord ( const Record &  record )

inlineexplicit

Construct from a Record struct.

Definition at line 68 of file SerialFrame.h.

Member Function Documentation

toRecord()

Record Rose::BinaryAnalysis::Serialization::FrameRecord::toRecord ( ) const

inline

Convert to a Record struct.

Definition at line 73 of file SerialFrame.h.

payload() [1/2]

const std::vector< char > & Rose::BinaryAnalysis::Serialization::FrameRecord::payload ( ) const

inline

Field getter and setters.

Definition at line 84 of file SerialFrame.h.

payload() [2/2]

void Rose::BinaryAnalysis::Serialization::FrameRecord::payload ( const std::vector< char > &  payload )

inline

Definition at line 85 of file SerialFrame.h.

objectType() [1/2]

Serialization::Savable Rose::BinaryAnalysis::Serialization::FrameRecord::objectType ( ) const

inline

Definition at line 87 of file SerialFrame.h.

objectType() [2/2]

void Rose::BinaryAnalysis::Serialization::FrameRecord::objectType ( Serialization::Savable  type )

inline

Definition at line 88 of file SerialFrame.h.

format() [1/2]

Serialization::Format Rose::BinaryAnalysis::Serialization::FrameRecord::format ( ) const

inline

Definition at line 90 of file SerialFrame.h.

format() [2/2]

void Rose::BinaryAnalysis::Serialization::FrameRecord::format ( Serialization::Format  fmt )

inline

Definition at line 91 of file SerialFrame.h.

roseVersion() [1/2]

std::string Rose::BinaryAnalysis::Serialization::FrameRecord::roseVersion ( ) const

inline

Definition at line 93 of file SerialFrame.h.

roseVersion() [2/2]

void Rose::BinaryAnalysis::Serialization::FrameRecord::roseVersion ( const std::string &  ver )

inline

Definition at line 94 of file SerialFrame.h.

payloadSize()

std::uint64_t Rose::BinaryAnalysis::Serialization::FrameRecord::payloadSize ( ) const

inline

Get the payload size.

Definition at line 97 of file SerialFrame.h.

serializeObject()

template<typename T >

void Rose::BinaryAnalysis::Serialization::FrameRecord::serializeObject ( const T &  object )

inline

Template method to serialize an object directly to this record's payload.

Definition at line 100 of file SerialFrame.h.

deserializeObject()

template<typename T >

void Rose::BinaryAnalysis::Serialization::FrameRecord::deserializeObject ( T &  object ) const

inline

Template method to deserialize an object from this record's payload.

Definition at line 112 of file SerialFrame.h.

serialize()

template<class Archive >

void Rose::BinaryAnalysis::Serialization::FrameRecord::serialize ( Archive &  ar, const unsigned    )

inline

Boost serialization support.

Definition at line 120 of file SerialFrame.h.

---

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

• SerialFrame.h