IGLib  1.7.2
The IGLib base library EXTENDED - with other lilbraries and applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
IG.Lib.ParsableXmlObject Class Referenceabstract

Base class for data classes that support writing data to / reading from custom XML files, writing from / to database objects, etc. More...

+ Inheritance diagram for IG.Lib.ParsableXmlObject:
+ Collaboration diagram for IG.Lib.ParsableXmlObject:

Classes

class  AccummulatedReport
 Class used for accummulated error and warning reports for task composed of several steps. This is used when we want to perform the whole task even if some errors occur, and treat all errors and messages after the task is completed. More...
 

Public Member Functions

virtual void Save (string filename)
 Saves contents of the msg to an xml file. More...
 
virtual void CreateXml ()
 Creates msg Xml from the current msg data and stores it in this object. More...
 
virtual void Load (string filename)
 Loads msg data from a file containing the XML msg. More...
 
virtual void LoadXml (string doc)
 Loads msg data from a string containing the XML msg. More...
 
virtual void LoadXml (XmlDocument doc)
 Loads msg data from an XmlDocument containing XML msg. More...
 
abstract void Read ()
 Reads msg data from the internal XML document containing the msg. More...
 
abstract void Read (XmlParser data)
 Read msg data from an XML document containing the msg. More...
 
virtual void CheckConsistency (AccummulatedReport rep)
 Empty data consistency check, intended to be overridden in derived classes. More...
 
virtual void WriteToConsole ()
 Writes cntents of the msg in a human readable form to the system console. More...
 
virtual void Write (string filename, bool append)
 Writes cntents of the msg in a human readable form to a file. More...
 
abstract XmlDocument ToXml ()
 Converts a msg to Xml and returns it. More...
 

Public Attributes

string XmlString = null
 

Protected Attributes

XmlBuilder Data = new XmlBuilder()
 

Properties

virtual IReporter R [get]
 Reporter for this class. More...
 
XmlDocument Doc [get]
 Returns the XML document representing the msg. More...
 

Private Member Functions

void Write (TextWriter tw)
 Writes contents of the msg in a human readable form to a textwriter. More...
 

Private Attributes

IReporter _R = null
 

Detailed Description

Base class for data classes that support writing data to / reading from custom XML files, writing from / to database objects, etc.

Member Function Documentation

virtual void IG.Lib.ParsableXmlObject.Save ( string  filename)
inlinevirtual
virtual void IG.Lib.ParsableXmlObject.CreateXml ( )
inlinevirtual

Creates msg Xml from the current msg data and stores it in this object.

References IG.Lib.XmlUtilityBase.LoadXml().

virtual void IG.Lib.ParsableXmlObject.LoadXml ( string  doc)
inlinevirtual

Loads msg data from a string containing the XML msg.

Parameters
docString containing the msg in XML format.

References IG.Lib.XmlUtilityBase.LoadXml().

Referenced by IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder(), and IGTest.ProgramIGTest.TestCalypsoWs().

virtual void IG.Lib.ParsableXmlObject.LoadXml ( XmlDocument  doc)
inlinevirtual

Loads msg data from an XmlDocument containing XML msg.

Parameters
filenameXMLDocument containing the msg.

References IG.Lib.XmlUtilityBase.LoadXml().

abstract void IG.Lib.ParsableXmlObject.Read ( )
pure virtual

Reads msg data from the internal XML document containing the msg.

Implemented in IG.Lib.MsgObervationOrder, IG.Lib.DocFindings, IG.Lib.MsgFinancialTransaction, and IG.Lib.MsgObservationEvent.

Referenced by IGTest.ProgramIGTest.ReceiveSpecimenObservationOrder().

abstract void IG.Lib.ParsableXmlObject.Read ( XmlParser  data)
pure virtual

Read msg data from an XML document containing the msg.

Parameters
docDocument containing the msg.

Implemented in IG.Lib.MsgObervationOrder, IG.Lib.DocFindings, IG.Lib.MsgFinancialTransaction, and IG.Lib.MsgObservationEvent.

virtual void IG.Lib.ParsableXmlObject.CheckConsistency ( AccummulatedReport  rep)
inlinevirtual

Empty data consistency check, intended to be overridden in derived classes.

Parameters
repObject where error, warning and info reports are accumulated.

Reimplemented in IG.Lib.MsgObervationOrder, IG.Lib.DocFindings, IG.Lib.MsgFinancialTransaction, and IG.Lib.MsgObservationEvent.

References IG.Lib.ParsableXmlObject.AccummulatedReport.AddInfo().

void IG.Lib.ParsableXmlObject.Write ( TextWriter  tw)
inlineprivate

Writes contents of the msg in a human readable form to a textwriter.

virtual void IG.Lib.ParsableXmlObject.Write ( string  filename,
bool  append 
)
inlinevirtual

Writes cntents of the msg in a human readable form to a file.

Parameters
filenameFile to which msg contents is written.
appendIf true then fle is appended, otherwise it is overwritten.
abstract XmlDocument IG.Lib.ParsableXmlObject.ToXml ( )
pure virtual

Member Data Documentation

string IG.Lib.ParsableXmlObject.XmlString = null
IReporter IG.Lib.ParsableXmlObject._R = null
private
XmlBuilder IG.Lib.ParsableXmlObject.Data = new XmlBuilder()
protected

Property Documentation

virtual IReporter IG.Lib.ParsableXmlObject.R
get

Reporter for this class.


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