agxData::agxData Class Reference

Representation of a session on disk created by the FileFrameWriter. More...

#include <FileJournal.h>

Inheritance diagram for agxData::agxData:

Classes
struct	FrameInfo

Public Member Functions
agx::String	buildFramePath (agx::UInt frameIndex) const
virtual void	finalizeHeader () override
virtual void	getAllPlots (PlotDataRefVector &result) override
virtual agx::String	getCustomFilesPath (bool create=true) const override
FileJournal *	getFileJournal ()
const FileJournal *	getFileJournal () const
agx::UInt64	getFrameHead ()
virtual agxData::Frame::Header	getFrameHeader (agx::UInt frameIndex) const override
	Load the header data for a particular frame.
const FrameInfo *	getFrameInfo (agx::UInt frameIndex) const
agx::String	getFramesPath () const
virtual agx::UInt	getNextFrameIndex (agx::UInt currentFrameIndex, agx::Int offset) const override
virtual agx::String	getPath () const override
virtual PlotData *	getPlot (const agx::String &plotName) override
agx::String	getPlotDirectoryPath () const
virtual void	getPlotList (agx::StringVector &result) override
virtual agx::String	getScenePath (bool create=true) const override
agx::String	getSessionHeaderPath () const
virtual bool	packSceneData (std::istream &sceneData) override
	Copy the scene data found in the given input stream into the scene file pointed to by getScenePath.
virtual bool	packSceneData (std::stringstream &sceneData) override
	Copy the scene data found in the given string stream into the scene file pointed to by getScenePath.
virtual bool	recordExtraData (const agx::String &key, const agx::String &value) override
virtual void	removePlot (const agx::String &plotName) override
virtual bool	retrieveExtraData (const agx::String &key, agx::String &value) override
virtual void	savePlot (const PlotData *plot) override
void	setFrameHead (agx::UInt64 head)
virtual bool	truncate (agx::UInt firstFrameToRemove) override
	Remove all frames from the given index and forward.
virtual bool	unpackSceneData (std::ostream &sceneData) override
	Copy the scene data from the file pointed to by getScenePath into the given output stream.
virtual bool	unpackSceneData (std::stringstream &sceneData) override
	Copy the scene data from the file pointed to by getScenePath into the given string stream.
virtual bool	unpackSceneFile () override
	The file journal does not support packing, so this does nothing.
virtual void	writeHeader () override

Static Public Member Functions
static agxData::FileJournal::Session *	create (const agx::Name &name, const agx::String &path)
	Create a new empty session to which a recording can be made. Will return nullptr on error.
static FileJournal::Session *	load (const agx::TiXmlElement *eSession)
	Load a session from disk. Will return nullptr on error.

Protected Member Functions
virtual	~Session ()

Detailed Description

Representation of a session on disk created by the FileFrameWriter.

Definition at line 118 of file FileJournal.h.

Constructor & Destructor Documentation

~Session()

virtual agxData::agxData::~Session ( )

protectedvirtual

Member Function Documentation

buildFramePath()

agx::String agxData::agxData::buildFramePath

(

agx::UInt

frameIndex

)

const

Returns

Disk path to the folder where the given frame is stored. If the given frame isn't part of the stored session data, then the returned path will point to a folder that doesn't exist.

create()

static agxData::FileJournal::Session * agxData::agxData::create ( const agx::Name &  name, const agx::String &  path  )

static

Create a new empty session to which a recording can be made. Will return nullptr on error.

finalizeHeader()

virtual void agxData::agxData::finalizeHeader ( )

overridevirtual

getAllPlots()

virtual void agxData::agxData::getAllPlots ( PlotDataRefVector &  result )

overridevirtual

getCustomFilesPath()

virtual agx::String agxData::agxData::getCustomFilesPath ( bool  create = true ) const

overridevirtual

getFileJournal() [1/2]

FileJournal * agxData::agxData::getFileJournal

(

)

Returns

The file journal to which the session have been registered.

getFileJournal() [2/2]

const FileJournal * agxData::agxData::getFileJournal

(

)

const

Returns

The file journal to which the session have been registered.

getFrameHead()

agx::UInt64 agxData::agxData::getFrameHead

(

)

getFrameHeader()

virtual agxData::Frame::Header agxData::agxData::getFrameHeader ( agx::UInt  frameIndex ) const

overridevirtual

Load the header data for a particular frame.

getFrameInfo()

const FrameInfo * agxData::agxData::getFrameInfo

(

agx::UInt

frameIndex

)

const

getFramesPath()

agx::String agxData::agxData::getFramesPath

(

)

const

Returns

Disk path to the folder containing all the frames.

getNextFrameIndex()

virtual agx::UInt agxData::agxData::getNextFrameIndex ( agx::UInt  currentFrameIndex, agx::Int  offset  ) const

overridevirtual

getPath()

virtual agx::String agxData::agxData::getPath ( ) const

overridevirtual

Returns

The disk path where the session is stored.

getPlot()

virtual PlotData * agxData::agxData::getPlot ( const agx::String &  plotName )

overridevirtual

getPlotDirectoryPath()

agx::String agxData::agxData::getPlotDirectoryPath

(

)

const

getPlotList()

virtual void agxData::agxData::getPlotList ( agx::StringVector &  result )

overridevirtual

getScenePath()

virtual agx::String agxData::agxData::getScenePath ( bool  create = true ) const

overridevirtual

Returns

The disk path to the .agx file for this session.

getSessionHeaderPath()

agx::String agxData::agxData::getSessionHeaderPath

(

)

const

load()

static FileJournal::Session * agxData::agxData::load ( const agx::TiXmlElement *  eSession )

static

Load a session from disk. Will return nullptr on error.

packSceneData() [1/2]

virtual bool agxData::agxData::packSceneData ( std::istream &  sceneData )

overridevirtual

Copy the scene data found in the given input stream into the scene file pointed to by getScenePath.

packSceneData() [2/2]

virtual bool agxData::agxData::packSceneData ( std::stringstream &  sceneData )

overridevirtual

Copy the scene data found in the given string stream into the scene file pointed to by getScenePath.

recordExtraData()

virtual bool agxData::agxData::recordExtraData ( const agx::String &  key, const agx::String &  value  )

overridevirtual

removePlot()

virtual void agxData::agxData::removePlot ( const agx::String &  plotName )

overridevirtual

retrieveExtraData()

virtual bool agxData::agxData::retrieveExtraData ( const agx::String &  key, agx::String &  value  )

overridevirtual

savePlot()

virtual void agxData::agxData::savePlot ( const PlotData *  plot )

overridevirtual

setFrameHead()

void agxData::agxData::setFrameHead

(

agx::UInt64

head

)

truncate()

virtual bool agxData::agxData::truncate ( agx::UInt  firstFrameToRemove )

overridevirtual

Remove all frames from the given index and forward.

unpackSceneData() [1/2]

virtual bool agxData::agxData::unpackSceneData ( std::ostream &  sceneData )

overridevirtual

Copy the scene data from the file pointed to by getScenePath into the given output stream.

unpackSceneData() [2/2]

virtual bool agxData::agxData::unpackSceneData ( std::stringstream &  sceneData )

overridevirtual

Copy the scene data from the file pointed to by getScenePath into the given string stream.

unpackSceneFile()

virtual bool agxData::agxData::unpackSceneFile ( )

overridevirtual

The file journal does not support packing, so this does nothing.

Returns

True if a scene file exists at the location returned by getScenePath. False otherwise.

writeHeader()

virtual void agxData::agxData::writeHeader ( )

overridevirtual

---

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

• FileJournal.h