OMPF::ompfHeaderChunk Class Reference

#include <ompfHeaderChunk.h>

Inherits OMPF::ompfBaseChunk.

Public Member Functions

 ompfHeaderChunk ()
 
virtual ~ompfHeaderChunk ()=default
 
uint32 getSize (const ompfSettings &settings) override
 
virtual bool write (std::ofstream &stream, const ompfSettings &settings)
 
virtual bool read (std::ifstream &stream, ompfSettings &settings)
 
- Public Member Functions inherited from OMPF::ompfBaseChunk
 ompfBaseChunk (OMPFChunkType typeID)
 
virtual ~ompfBaseChunk ()=default
 
virtual bool write (std::ofstream &stream, const ompfSettings &settings)
 
virtual bool read (std::ifstream &stream, ompfSettings &settings)
 
void insertChunk (ompfBaseChunk *chunk)
 
void removeChunk (ompfBaseChunk *chunk)
 
bool hasParent () const
 
uint32 getParentID () const
 
void setParentID (const uint32 parentID)
 
bool hasChildren () const
 
const std::vector< ompfBaseChunk * > & getChildren () const
 
void setID (const uint32 chunkID)
 
uint32 getID () const
 
virtual uint32 getSize (const ompfSettings &settings)
 
OMPFChunkType getType () const
 
void setName (const iaString &name)
 
iaString getName () const
 

Detailed Description

header chunk the represents the header in an ompf file

Constructor & Destructor Documentation

◆ ompfHeaderChunk()

OMPF::ompfHeaderChunk::ompfHeaderChunk ( )

does nothing

◆ ~ompfHeaderChunk()

virtual OMPF::ompfHeaderChunk::~ompfHeaderChunk ( )
virtualdefault

does nothing

Member Function Documentation

◆ getSize()

uint32 OMPF::ompfHeaderChunk::getSize ( const ompfSettings settings)
overridevirtual
Returns
size of chunk
Parameters
settignsthe settings to calculate the size

Reimplemented from OMPF::ompfBaseChunk.

◆ read()

bool OMPF::ompfHeaderChunk::read ( std::ifstream &  stream,
ompfSettings settings 
)
virtual

reads chunk from stream

Parameters
streamsource stream
settingsthe settings how to read the chunk

Reimplemented from OMPF::ompfBaseChunk.

◆ write()

bool OMPF::ompfHeaderChunk::write ( std::ofstream &  stream,
const ompfSettings settings 
)
virtual

writes chunk to stream

Parameters
streamdestination stream
settingsthe settings how to write the chunk

Reimplemented from OMPF::ompfBaseChunk.


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