Sen API
Sen Libraries
Loading...
Searching...
No Matches
sen::db::Output Class Reference

Allows the creation of recordings. More...

#include <output.h>

Public Member Functions

 Output (OutSettings settings, std::function< void()> errorHandler)
 Takes the settings and a function to call in case of error.
 ~Output ()
const OutSettings & getSettings () const noexcept
 The settings passed during construction.
const TimeStampgetCreationTime () const noexcept
 The time of creation of the recording.
OutStats fetchStats () const
 Fetch the current statistics. Thread-safe.
void keyframe (TimeStamp time, const ObjectInfoList &objects)
 Asynchronously write a keyframe containing the state of the given objects.
void creation (TimeStamp time, const ObjectInfo &object, bool indexed)
 Asynchronously write a creation entry for the given object. Index it if needed.
void deletion (TimeStamp time, ObjectId objectId)
 Asynchronously write a deletion entry for the given object.
void propertyChange (TimeStamp time, ObjectId objectId, MemberHash propertyId, ::sen::kernel::Buffer &&propertyValue)
 Asynchronously write a property change entry for the given object.
void event (TimeStamp time, ObjectId objectId, MemberHash eventId, ::sen::kernel::Buffer &&args)
 Asynchronously write an event entry for the given object.
void annotation (TimeStamp time, const Type *type, ::sen::kernel::Buffer &&value)
 Asynchronously write an annotation entry.

Detailed Description

Allows the creation of recordings.

Constructor & Destructor Documentation

◆ Output()

sen::db::Output::Output ( OutSettings settings,
std::function< void()> errorHandler )

Takes the settings and a function to call in case of error.

◆ ~Output()

sen::db::Output::~Output ( )

Member Function Documentation

◆ getSettings()

const OutSettings & sen::db::Output::getSettings ( ) const
nodiscardnoexcept

The settings passed during construction.

◆ getCreationTime()

const TimeStamp & sen::db::Output::getCreationTime ( ) const
nodiscardnoexcept

The time of creation of the recording.

◆ fetchStats()

OutStats sen::db::Output::fetchStats ( ) const
nodiscard

Fetch the current statistics. Thread-safe.

◆ keyframe()

void sen::db::Output::keyframe ( TimeStamp time,
const ObjectInfoList & objects )

Asynchronously write a keyframe containing the state of the given objects.

◆ creation()

void sen::db::Output::creation ( TimeStamp time,
const ObjectInfo & object,
bool indexed )

Asynchronously write a creation entry for the given object. Index it if needed.

◆ deletion()

void sen::db::Output::deletion ( TimeStamp time,
ObjectId objectId )

Asynchronously write a deletion entry for the given object.

◆ propertyChange()

void sen::db::Output::propertyChange ( TimeStamp time,
ObjectId objectId,
MemberHash propertyId,
::sen::kernel::Buffer && propertyValue )

Asynchronously write a property change entry for the given object.

◆ event()

void sen::db::Output::event ( TimeStamp time,
ObjectId objectId,
MemberHash eventId,
::sen::kernel::Buffer && args )

Asynchronously write an event entry for the given object.

◆ annotation()

void sen::db::Output::annotation ( TimeStamp time,
const Type * type,
::sen::kernel::Buffer && value )

Asynchronously write an annotation entry.


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