sen::db::Snapshot Class Reference

Represents the full state of an object at a point in time. More...

#include <snapshot.h>

Public Member Functions
	~Snapshot ()=default
ObjectId	getObjectId () const noexcept
	The ID of the object.
const std::string &	getName () const noexcept
	The name of the object.
const std::string &	getSessionName () const noexcept
	The session where the object was published.
const std::string &	getBusName () const noexcept
	The bus where the object was published.
const ConstTypeHandle< ClassType > &	getType () const noexcept
	The class of the object.
const Var &	getPropertyAsVariant (const Property *property) const
	Get the value of a property as a variant.
Span< const uint8_t >	getPropertyAsBuffer (const Property *property) const
	Get the value of a property as a serialized buffer.
Span< const uint8_t >	getAllPropertiesBuffer () const noexcept
	Get the buffer containing all the serialized properties.

Friends
class	Input

Detailed Description

Represents the full state of an object at a point in time.

Constructor & Destructor Documentation

~Snapshot()

sen::db::Snapshot::~Snapshot ( )

default

Member Function Documentation

getObjectId()

ObjectId sen::db::Snapshot::getObjectId ( ) const

nodiscardnoexcept

The ID of the object.

getName()

const std::string & sen::db::Snapshot::getName ( ) const

nodiscardnoexcept

The name of the object.

getSessionName()

const std::string & sen::db::Snapshot::getSessionName ( ) const

nodiscardnoexcept

The session where the object was published.

getBusName()

const std::string & sen::db::Snapshot::getBusName ( ) const

nodiscardnoexcept

The bus where the object was published.

getType()

const ConstTypeHandle< ClassType > & sen::db::Snapshot::getType ( ) const

inlinenodiscardnoexcept

The class of the object.

getPropertyAsVariant()

const Var & sen::db::Snapshot::getPropertyAsVariant ( const Property * property ) const

nodiscard

Get the value of a property as a variant.

getPropertyAsBuffer()

Span< const uint8_t > sen::db::Snapshot::getPropertyAsBuffer ( const Property * property ) const

nodiscard

Get the value of a property as a serialized buffer.

getAllPropertiesBuffer()

Span< const uint8_t > sen::db::Snapshot::getAllPropertiesBuffer ( ) const

nodiscardnoexcept

Get the buffer containing all the serialized properties.

Friends And Related Symbol Documentation

Input

friend class Input

friend

---

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

• snapshot.h