RetsXmlEndDocumentEvent Class Reference

(Internal) RetsXmlEndDocumentEvent is a class that handles the Expat "end document" XML event. More...

#include <librets/RetsXmlEndDocumentEvent.h>

Inheritance diagram for RetsXmlEndDocumentEvent:

RetsXmlEvent RetsObject

List of all members.

Public Types

enum  Type { START_ELEMENT, END_ELEMENT, TEXT, END_DOCUMENT }
 Clasify the type of the Xml event. More...

Public Member Functions

 RetsXmlEndDocumentEvent (int lineNumber=-1, int columnNumber=-1)
 Contstruct the object with a default line and column number.
virtual Type GetType () const
 Always returns END_DOCUMENT.
virtual std::ostream & Print (std::ostream &outputStream) const
 Prints the attribute and value in a standard form for debugging and error reporting.
virtual bool Equals (const RetsObject *rhs) const
 Checks to see if the attribute names are identical between two RetsXmlEndDocumentEvent objects.
int GetLineNumber () const
 Get the line number for this element.
int GetColumnNumber () const
 Get the column number for this element.
std::string ToString () const

Protected Member Functions

std::ostream & PrintLineAndColumn (std::ostream &out) const

Protected Attributes

int mLineNumber
int mColumnNumber


Detailed Description

(Internal) RetsXmlEndDocumentEvent is a class that handles the Expat "end document" XML event.

Refer to the libexpat documentation.


Member Enumeration Documentation

enum Type [inherited]

Clasify the type of the Xml event.

Enumerator:
START_ELEMENT  Indicates this is a start element (<RETS>).
END_ELEMENT  Indicates this is an end element (</RETS>).
TEXT  Indicates this is a text element.
END_DOCUMENT  Indicates this is the end of the XML document.


Constructor & Destructor Documentation

RetsXmlEndDocumentEvent ( int  lineNumber = -1,
int  columnNumber = -1 
)

Contstruct the object with a default line and column number.

These numbers should reflect the line/column from the XML stream where this element can be found and is used for debugging.


Member Function Documentation

virtual bool Equals ( const RetsObject rhs  )  const [virtual]

Checks to see if the attribute names are identical between two RetsXmlEndDocumentEvent objects.

Returns:
TRUE if the name and value for both attributes matches.

Reimplemented from RetsObject.

int GetColumnNumber (  )  const [inherited]

Get the column number for this element.

Returns:
An integer containing the column number.

int GetLineNumber (  )  const [inherited]

Get the line number for this element.

Returns:
An integer containing the line number.

virtual Type GetType (  )  const [virtual]

Always returns END_DOCUMENT.

Returns:
END_DOCUMENT

Implements RetsXmlEvent.

virtual std::ostream& Print ( std::ostream &  outputStream  )  const [virtual]

Prints the attribute and value in a standard form for debugging and error reporting.

Reimplemented from RetsObject.

std::ostream& PrintLineAndColumn ( std::ostream &  out  )  const [protected, inherited]

std::string ToString (  )  const [inherited]


Member Data Documentation

int mColumnNumber [protected, inherited]

int mLineNumber [protected, inherited]


Generated by  doxygen