Sen API
Sen Libraries
Loading...
Searching...
No Matches
Archive manipulation library

Provides means to read and write recordings. More...

Classes

class  sen::db::Annotation
 Represents an annotation which can be added to a recording. More...
class  sen::db::Creation
 Represents the creation of an object. More...
class  sen::db::Cursor< End, T >
 A cursor that can be used to iterate over the contents of a recording. The cursor holds a payload which can have one of the values given as type arguments. More...
class  sen::db::Deletion
 Represents the deletion of an object. More...
class  sen::db::Event
 Represents the emission of an event by some object. More...
struct  sen::db::KeyframeIndex
 The location of a keyframe in an archive. More...
struct  sen::db::ObjectIndexDef
 Describes an object that has been indexed. More...
class  sen::db::End
 Represents the end of the recording. Used in cursors. More...
class  sen::db::Input
 Allows you to access an existing recording in the file system. More...
class  sen::db::Keyframe
 Represents the state of the system at a given time. The state of the system is made of the snapshots of all the objects present at the time of the snapshot. More...
struct  sen::db::ObjectInfo
 Basic information about an object tracked for recording. More...
class  sen::db::Output
 Allows the creation of recordings. More...
class  sen::db::PropertyChange
 Represents the change of a property value. More...
class  sen::db::Snapshot
 Represents the full state of an object at a point in time. More...

Typedefs

using sen::db::DataCursor = Cursor<End, PropertyChange, Event, Keyframe, Creation, Deletion>
 A cursor that can iterate over data entries.
using sen::db::AnnotationCursor = Cursor<End, Annotation>
 A cursor that can iterate over annotation entries.
using sen::db::ErrorHandler = std::function<void()>
 A function to be called in case of error.
using sen::db::ObjectInfoList = std::vector<ObjectInfo>
 A list of information elements about tracked objects.

Detailed Description

Provides means to read and write recordings.


Class Documentation

◆ sen::db::KeyframeIndex

struct sen::db::KeyframeIndex

The location of a keyframe in an archive.

Class Members
uint64_t offset
TimeStamp time

◆ sen::db::ObjectIndexDef

struct sen::db::ObjectIndexDef

Describes an object that has been indexed.

Class Members
ConstTypeHandle< ClassType > type
ObjectId objectId
string name
string session
string bus
uint32_t indexId

◆ sen::db::End

class sen::db::End

Represents the end of the recording. Used in cursors.

◆ sen::db::ObjectInfo

struct sen::db::ObjectInfo

Basic information about an object tracked for recording.

Class Members
const Object * instance
string session
string bus

Typedef Documentation

◆ DataCursor

A cursor that can iterate over data entries.

◆ AnnotationCursor

A cursor that can iterate over annotation entries.

◆ ErrorHandler

using sen::db::ErrorHandler = std::function<void()>

A function to be called in case of error.

◆ ObjectInfoList

using sen::db::ObjectInfoList = std::vector<ObjectInfo>

A list of information elements about tracked objects.