Emergency 2017 Dokumentation  v3.0.1
qsf::editor::SequenceMapBackup Class Reference

Sequence map backup implementation using a binary serializer. More...

#include <SequenceMapBackup.h>

Public Member Functions

 SequenceMapBackup ()
 Default constructor. More...
 
 ~SequenceMapBackup ()
 Destructor. More...
 
bool isEmpty () const
 Check if the sequence map backup is empty. More...
 
void clear ()
 Clear the sequence map backup's contents. More...
 
void copyFromStream (std::istream &stream)
 Copy contents from a stream. More...
 
void copyToStream (std::ostream &stream)
 Copy contents to a stream. More...
 
bool backupSequenceMap (const logic::Sequence &sequence)
 Create a backup of the sequence map. More...
 
bool restoreSequenceMap (logic::Sequence &sequence) const
 Load a sequence map from the backup. More...
 

Static Public Attributes

static const std::string FORMAT_TYPE
 Sequence map backup format type string "SequenceMap". More...
 
static const uint32 FORMAT_VERSION
 Current sequence map backup format version. More...
 

Detailed Description

Sequence map backup implementation using a binary serializer.

Todo:
  • TODO(co) Adding new tracks during sequence editing has to be handled property. Currently done via hack. See "qsf::editor::SequenceAddTrackOperation::sealImpl()".

Definition at line 50 of file SequenceMapBackup.h.

Constructor & Destructor Documentation

qsf::editor::SequenceMapBackup::SequenceMapBackup ( )

Default constructor.

qsf::editor::SequenceMapBackup::~SequenceMapBackup ( )

Destructor.

Member Function Documentation

bool qsf::editor::SequenceMapBackup::backupSequenceMap ( const logic::Sequence sequence)

Create a backup of the sequence map.

Parameters
[in]sequenceThe sequence map instance to save
Returns
"true" if all went fine, else "false"
void qsf::editor::SequenceMapBackup::clear ( )

Clear the sequence map backup's contents.

void qsf::editor::SequenceMapBackup::copyFromStream ( std::istream &  stream)

Copy contents from a stream.

void qsf::editor::SequenceMapBackup::copyToStream ( std::ostream &  stream)

Copy contents to a stream.

bool qsf::editor::SequenceMapBackup::isEmpty ( ) const

Check if the sequence map backup is empty.

Returns
"true" if the sequence map backup is empty, "false" if it has any content
bool qsf::editor::SequenceMapBackup::restoreSequenceMap ( logic::Sequence sequence) const

Load a sequence map from the backup.

Parameters
[out]sequenceThe sequence map instance to load
Returns
"true" if all went fine, else "false"

Member Data Documentation

const std::string qsf::editor::SequenceMapBackup::FORMAT_TYPE
static

Sequence map backup format type string "SequenceMap".

Definition at line 58 of file SequenceMapBackup.h.

const uint32 qsf::editor::SequenceMapBackup::FORMAT_VERSION
static

Current sequence map backup format version.

Definition at line 59 of file SequenceMapBackup.h.


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