StructureSerializerDebug Class Reference

Class handling the data structure format type "Debug". More...

#include <adskDataStructureSerializerDebug.h>

Inheritance diagram for StructureSerializerDebug:

Public Member Functions
	~StructureSerializerDebug () override
	Default destructor, does nothing.
Structure *	read (std::istream &cSrc, std::string &errors) const override
	Mandatory pure virtual read method fails immediately. More...
int	write (const Structure &dataToWrite, std::ostream &cDst) const override
	Output the Structure object in Debug format into the stream. More...
void	getFormatDescription (std::ostream &info) const override
	Get a description of the Debug structure format. More...
Public Member Functions inherited from StructureSerializer
	StructureSerializer ()
	Default constructor, does nothing.
virtual	~StructureSerializer ()
	Default destructor, does nothing.

Detailed Description

Class handling the data structure format type "Debug".

The "Debug" format is taken directly from the Print request handler on the Structure and owned object classes. The formatting will be self-describing so either print a structure or look at the Debug method in the adsk::Data::Structure class to see what information is printed.

Member Function Documentation

Structure * read ( std::istream &  cSrc, std::string &  errors  ) const

overridevirtual

Mandatory pure virtual read method fails immediately.

Parameters

[in]	cSrc	Stream containing the Debug format data to be parsed
[out]	errors	Description of problems found when parsing the string

Returns

NULL since no Structure can be created from this format

Implements StructureSerializer.

int write ( const Structure &  dataToWrite, std::ostream &  cDst  ) const

overridevirtual

Output the Structure object in Debug format into the stream.

Parameters

[in]	dataToWrite	Structure to be formatted
[out]	cDst	Stream to which the Debug format of the structure is written

Returns

number of errors found during write, 0 means success

Implements StructureSerializer.

void getFormatDescription ( std::ostream &  info ) const

overridevirtual

Get a description of the Debug structure format.

Parameters

[out]

info

Stream to which the Debug format description is output

Implements StructureSerializer.

---

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

• adskDataStructureSerializerDebug.h
• adskDataStructureSerializerDebug.cpp