StructureSerializerDebug Class Reference

StructureSerializerDebug Class Reference

#include <adskDataStructureSerializerDebug.h>

Class 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.

+ Inheritance diagram for StructureSerializerDebug:

Public Member Functions

virtual ~StructureSerializerDebug ()
 Default destructor, does nothing.
 
virtual Structureread (std::istream &cSrc, std::string &errors) const
 Mandatory pure virtual read method fails immediately. More...
 
virtual int write (const Structure &dataToWrite, std::ostream &cDst) const
 Output the Structure object in Debug format into the stream. More...
 
virtual void getFormatDescription (std::ostream &info) const
 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.
 

Member Function Documentation

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

Mandatory pure virtual read method fails immediately.

Parameters
[in]cSrcStream containing the Debug format data to be parsed
[out]errorsDescription 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
virtual

Output the Structure object in Debug format into the stream.

Parameters
[in]dataToWriteStructure to be formatted
[out]cDstStream 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
virtual

Get a description of the Debug structure format.

Parameters
[out]infoStream 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