BinLDrivers_DocumentSection Class Reference

More or less independent part of the saved/restored document that is distinct from OCAF data themselves but may be referred by them. More...

#include <BinLDrivers_DocumentSection.hxx>

Public Member Functions
	BinLDrivers_DocumentSection ()
	Empty constructor.
	BinLDrivers_DocumentSection (const TCollection_AsciiString &theName, const bool isPostRead)
	Constructor.
const TCollection_AsciiString &	Name () const
	Query the name of the section.
bool	IsPostRead () const
	Query the status: if the Section should be read after OCAF; False means that the Section is read before starting to read OCAF data.
uint64_t	Offset () const
	Query the offset of the section in the persistent file.
void	SetOffset (const uint64_t theOffset)
	Set the offset of the section in the persistent file.
uint64_t	Length () const
	Query the length of the section in the persistent file.
void	SetLength (const uint64_t theLength)
	Set the length of the section in the persistent file.
void	WriteTOC (Standard_OStream &theOS, const TDocStd_FormatVersion theDocFormatVersion)
	Create a Section entry in the Document TOC (list of sections).
void	Write (Standard_OStream &theOS, const uint64_t theOffset, const TDocStd_FormatVersion theDocFormatVersion)
	Save Offset and Length data into the Section entry in the Document TOC (list of sections).

Static Public Member Functions
static bool	ReadTOC (BinLDrivers_DocumentSection &theSection, Standard_IStream &theIS, const TDocStd_FormatVersion theDocFormatVersion)
	Fill a DocumentSection instance from the data that are read from TOC. Returns false in case of the stream reading problem.

Detailed Description

More or less independent part of the saved/restored document that is distinct from OCAF data themselves but may be referred by them.

Constructor & Destructor Documentation

BinLDrivers_DocumentSection() [1/2]

BinLDrivers_DocumentSection::BinLDrivers_DocumentSection

(

)

Empty constructor.

BinLDrivers_DocumentSection() [2/2]

BinLDrivers_DocumentSection::BinLDrivers_DocumentSection	(	const TCollection_AsciiString &	theName,
		const bool	isPostRead )

Constructor.

Member Function Documentation

IsPostRead()

bool BinLDrivers_DocumentSection::IsPostRead

(

)

const

Query the status: if the Section should be read after OCAF; False means that the Section is read before starting to read OCAF data.

Length()

uint64_t BinLDrivers_DocumentSection::Length

(

)

const

Query the length of the section in the persistent file.

Name()

const TCollection_AsciiString & BinLDrivers_DocumentSection::Name

(

)

const

Query the name of the section.

Offset()

uint64_t BinLDrivers_DocumentSection::Offset

(

)

const

Query the offset of the section in the persistent file.

ReadTOC()

bool BinLDrivers_DocumentSection::ReadTOC ( BinLDrivers_DocumentSection & theSection, Standard_IStream & theIS, const TDocStd_FormatVersion theDocFormatVersion )

static

Fill a DocumentSection instance from the data that are read from TOC. Returns false in case of the stream reading problem.

SetLength()

void BinLDrivers_DocumentSection::SetLength

(

const uint64_t

theLength

)

Set the length of the section in the persistent file.

SetOffset()

void BinLDrivers_DocumentSection::SetOffset

(

const uint64_t

theOffset

)

Set the offset of the section in the persistent file.

Write()

void BinLDrivers_DocumentSection::Write	(	Standard_OStream &	theOS,
		const uint64_t	theOffset,
		const TDocStd_FormatVersion	theDocFormatVersion )

Save Offset and Length data into the Section entry in the Document TOC (list of sections).

WriteTOC()

void BinLDrivers_DocumentSection::WriteTOC	(	Standard_OStream &	theOS,
		const TDocStd_FormatVersion	theDocFormatVersion )

Create a Section entry in the Document TOC (list of sections).

---

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

• BinLDrivers_DocumentSection.hxx