FileJournal.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#ifndef AGXDATA_FILEJOURNAL_H
#define AGXDATA_FILEJOURNAL_H
 
#include <agxData/JournalArchive.h>
#include <agxData/SerializedFrame.h>
#include <agx/HashVector.h>
 
namespace agx
{
  class TiXmlElement;
  class TiXmlText;
}
 
 
namespace agxData
{
  AGX_DECLARE_POINTER_TYPES(FileJournal);
 
 
  class AGXCORE_EXPORT FileJournal : public agxData::JournalArchive
  {
  public:
 
    static bool isFileJournal(const agx::String& path);
 
  public:
    AGX_DECLARE_POINTER_TYPES(Session);
 
    FileJournal( const agx::String& diskPath );
 
    virtual JournalArchive::Session* createNewSession( const agx::Name& name ) override;
 
 
    agxData::FileJournal::Session* getFileSession( const agx::Name& name );
 
 
    virtual bool removeSession( agxData::JournalArchive::Session* session ) override;
 
    virtual bool renameSession( agxData::JournalArchive::Session* session, const agx::Name& newName ) override;
 
    virtual agx::String getCustomFilesPath(bool create = true) const override;
 
    virtual agx::String getCustomFilesPath( const agx::Name& sessionName, bool create = true ) const override;
 
 
    static bool parseSessionPath(const agx::String& fullPath, agx::String& journalPath, agx::String& sessionName);
 
 
    virtual DiskFrameReader* createFrameReader(JournalArchive::Session* session) override;
    virtual DiskFrameWriter* createFrameWriter(JournalArchive::Session* session) override;
 
  protected:
    virtual ~FileJournal();
 
    virtual agxData::JournalArchive::Session* makeCopy( agxData::JournalArchive::Session* session ) override;
 
  private:
    void readJournalContent();
 
    FileJournal::Session* createNewFileSession( const agx::Name& name );
 
 
    agxData::FileJournal::Session* downcastSession( agxData::JournalArchive::Session* abstractSession ) const;
 
 
    // agxData::JournalArchive::Session* makeCopy( agxData::JournalArchive::Session* session );
  };
 
 
  class AGXCORE_EXPORT agxData::FileJournal::Session : public agxData::JournalArchive::Session
  {
  public:
 
    agx::String getFramesPath() const;
 
 
    virtual agx::String getPath() const override;
 
    virtual agx::String getScenePath(bool create = true) const override;
 
 
    virtual bool unpackSceneFile() override;
 
    virtual bool packSceneData(std::stringstream& sceneData) override;
 
    virtual bool unpackSceneData(std::stringstream& sceneData) override;
 
    virtual bool packSceneData(std::istream& sceneData) override;
 
    virtual bool unpackSceneData(std::ostream& sceneData) override;
 
 
    virtual bool truncate( agx::UInt firstFrameToRemove ) override;
 
    agx::String buildFramePath( agx::UInt frameIndex ) const;
 
 
    virtual agxData::Frame::Header getFrameHeader( agx::UInt frameIndex ) const override;
 
    FileJournal* getFileJournal();
    const FileJournal* getFileJournal() const;
 
 
 
 
    virtual agx::String getCustomFilesPath(bool create = true) const override;
    agx::String getPlotDirectoryPath() const;
    agx::String getSessionHeaderPath() const;
 
    virtual bool recordExtraData( const agx::String& key, const agx::String& value ) override;
    virtual bool retrieveExtraData( const agx::String& key, agx::String& value  ) override;
 
    virtual void savePlot(const PlotData* plot) override;
    virtual void removePlot(const agx::String& plotName) override;
    virtual PlotData* getPlot(const agx::String& plotName) override;
    virtual void getAllPlots(PlotDataRefVector& result) override;
    virtual void getPlotList(agx::StringVector& result) override;
 
    virtual void writeHeader() override;
    virtual void finalizeHeader() override;
 
    virtual agx::UInt getNextFrameIndex(agx::UInt currentFrameIndex, agx::Int offset) const override;
 
  public:
 
    static agxData::FileJournal::Session* create( const agx::Name& name, const agx::String& path );
 
    static FileJournal::Session* load( const agx::TiXmlElement* eSession );
 
 
    struct FrameInfo : public SerializedFrame::BinaryHeader::FrameMeta
    {
      agx::UInt64 headerOffset;
      agx::UInt64 dataSegmentOffset;
      agx::UInt64 sequenceIndex;
    };
 
 
    const FrameInfo* getFrameInfo(agx::UInt frameIndex) const;
 
    agx::UInt64 getFrameHead();
    void setFrameHead(agx::UInt64 head);
 
  private:
    friend class agxData::FileJournal;
 
    bool copyDiskData( agxData::FileJournal* target );
 
    virtual bool transferDiskData( agxData::JournalArchive* target ) override;
 
 
    agx::TiXmlElement* generateHeader();
 
  private:
 
    Session( const agx::Name& name );
 
    agx::TiXmlText* getTextNode(agx::TiXmlElement* root, const agx::String& key, bool create);
 
    bool unpackSceneDataToStream(std::ostream& sceneData);
    void createFrameTable();
    void printFileStatistics();
    void readExtraData(agx::TiXmlElement* eExtraData);
    void readPlotData(agx::TiXmlElement* ePlotData);
 
  protected:
    virtual ~Session();
 
  private:
    // std::ofstream m_file;
    agx::UInt64 m_sceneDataOffset;
    agx::UInt64 m_sceneDataSize;
    agx::UInt64 m_frameDataOffset;
    agx::UInt64 m_frameHead;
 
    typedef agx::HashVector<agx::UInt64, FrameInfo> FrameTable;
    FrameTable m_frameTable;
 
    typedef agx::HashTable<agx::String, agx::String> ExtraDataTable;
    ExtraDataTable m_extraDataTable;
 
 
    struct PlotEntry
    {
      agx::UInt64 offset;
      agx::UInt64 headerSize;
      agx::UInt64 dataSize;
    };
 
    class PlotSort;
 
    typedef agx::HashTable<agx::Name, PlotEntry> PlotTable;
    PlotTable m_plotTable;
  };
 
}
 
 
/* AGXDATA_FILEJOURNAL_H */
#endif