VRS::BinaryObjectWriter Class Reference

#include <vrs/io/binaryobjectwriter.h>

Inheritance diagram for VRS::BinaryObjectWriter:

List of all members.

Public Member Functions
	VRS_TYPEINFO (BinaryObjectWriter, ObjectWriter)
virtual bool	canHandle (SharedObj *obj) const
virtual void	write (SharedObj *obj, const std::string &filename) const
virtual const char *	objectFormatName () const
virtual const char *	objectFileSuffix () const
virtual double	priority () const
Static Public Member Functions
static bool	writeFile (SO< SharedObj > obj, const std::string &filename, bool skipDefaultValues=true)
static bool	writeFile (SO< SharedObj > obj, std::vector< char > &target, bool skipDefaultValues=true)
static void	enableCompression (bool yesNo=true)
static bool	isCompressionEnabled ()

---

Member Function Documentation

VRS::BinaryObjectWriter::VRS_TYPEINFO	(	BinaryObjectWriter	,
		ObjectWriter
	)

virtual bool VRS::BinaryObjectWriter::canHandle

(

SharedObj *

obj

)

const [inline, virtual]

Implements VRS::ObjectWriter.

virtual void VRS::BinaryObjectWriter::write	(	SharedObj *	obj,
		const std::string &	filename
	)			const [inline, virtual]

`canHandle' checks whether a concrete writer class can handle a given object or not. `write' will output the object to a file with filename. In the case of i/o errors, an exception of type IOError is thrown. 'write' assumes that the object passed can be handled, i.e., 'canHandle' must return true for that object.

Implements VRS::ObjectWriter.

virtual const char* VRS::BinaryObjectWriter::objectFormatName

(

void

)

const [inline, virtual]

Implements VRS::ObjectWriter.

virtual const char* VRS::BinaryObjectWriter::objectFileSuffix

(

)

const [inline, virtual]

`objectFormatName' gives a verbose description of the file format that is written to. `objectFileSuffix' is the most widely used suffix used for this format.

Implements VRS::ObjectWriter.

virtual double VRS::BinaryObjectWriter::priority

(

)

const [inline, virtual]

Reimplemented from VRS::ObjectWriter.

static bool VRS::BinaryObjectWriter::writeFile	(	SO< SharedObj >	obj,
		const std::string &	filename,
		bool	skipDefaultValues = true
	)			[static]

static bool VRS::BinaryObjectWriter::writeFile	(	SO< SharedObj >	obj,
		std::vector< char > &	target,
		bool	skipDefaultValues = true
	)			[static]

static void VRS::BinaryObjectWriter::enableCompression

(

bool

yesNo = true

)

[static]

static bool VRS::BinaryObjectWriter::isCompressionEnabled

(

)

[static]

---

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

• binaryobjectwriter.h