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

Base class messages, includes possibility of model document for conversion of the object to XML msg according to specification. More...

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

Public Member Functions

void SetModelFile (string FilePath)
 Sets the model document for creation of the msg to the contents of the specified file. More...
 
void SetModelString (string XmlString)
 Sets the model document for creation of the msg to the contents of the specified string. More...
 
void SetModelDocument (XmlDocument doc)
 Sets the model document for creation of the msg to the contents of the specified string. More...
 
- Public Member Functions inherited from IG.Lib.MsgBase
void SetSenderLabex ()
 Sets msg data such that sender is Labex and receiver is Bis. More...
 
void SetSenderBis ()
 Sets msg data such that sender is Bis and receiver is Labex. More...
 
- Public Member Functions inherited from IG.Lib.ParsableXmlObject
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...
 

Properties

virtual XmlDocument ModelDocument [get, set]
 Gets or seta the XML document that is used as model for creation of XML. Warning: Each call to execution of get() makes a clone of an XmlDocument. More...
 
- Properties inherited from IG.Lib.MsgBase
static MsgConst Const [get]
 Gets objects that contains all constants related to communication messages. More...
 
string MessageXml [get, set]
 Complete msg as obtained from the web service. More...
 
- Properties inherited from IG.Lib.ParsableXmlObject
virtual IReporter R [get]
 Reporter for this class. More...
 
XmlDocument Doc [get]
 Returns the XML document representing the msg. More...
 

Private Attributes

XmlDocument _modelDocument = null
 

Additional Inherited Members

- Static Public Member Functions inherited from IG.Lib.MsgBase
static void SetMessageReceiverOld (ref XmlDocument msg, string receiver, out bool changed)
 Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. WARNING: searching for receiver element is done through an XPath expression, which may fail due to default namespaces that were not detected. More...
 
static void SetMessageReceiver (ref string message, string receiver, out bool changed)
 Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More...
 
static void SetMessageReceiver (ref XmlDocument msg, string receiver, out bool changed)
 Sets the receiver of the communication msg stored in msg to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More...
 
static void SetMessageReceiver (ref XmlBuilder data, string receiver, out bool changed)
 Sets the receiver of the communication msg stored in an Xml builder to the specified receiver, and indicates through an output argument whether the receiver has been changed in msg. If the receiver stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More...
 
static void SetMessageSender (ref XmlBuilder data, string sender, out bool changed)
 Sets the sender of the communication msg stored in an Xml builder to the specified sender, and indicates through an output argument whether the sender has been changed in msg. If the Sender stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More...
 
static void SetMessageResponder (ref XmlBuilder data, string responder, out bool changed)
 Sets the responder of the communication msg stored in an Xml builder to the specified responder, and indicates through an output argument whether the responder has been changed in msg. If the responder stated in the msg already equals to the specified one then nothing changes in the msg and the output indicator becomes false. More...
 
static MessageType GetMessageType (string msgstring)
 Infers the msg type from the XML string containing the msg, and returns it. More...
 
static MessageType GetMessageType (XmlDocument msg)
 Infers the msg type from the XML document containing the msg, and returns it. More...
 
static MessageType GetMessageType (XmlParser data)
 Infers the msg type from the XML parser containing the msg, and returns it. More...
 
- Public Attributes inherited from IG.Lib.MsgBase
MessageType Type = MessageType.Unknown
 Message type. Helps with general methods that operate on any datatype of msg. More...
 
string MessageId = null
 Message ID, obtained form the web service. More...
 
string MessageFile = null
 Specifies the file where message has been backed up. Warning: this file may be deleted at any time! More...
 
string MessageNumber = null
 
- Public Attributes inherited from IG.Lib.ParsableXmlObject
string XmlString = null
 
- Protected Attributes inherited from IG.Lib.ParsableXmlObject
XmlBuilder Data = new XmlBuilder()
 
- Static Protected Attributes inherited from IG.Lib.MsgBase
static string LabexIdLowercase = null
 

Detailed Description

Base class messages, includes possibility of model document for conversion of the object to XML msg according to specification.

Member Function Documentation

void IG.Lib.MsgBaseWithModel.SetModelFile ( string  FilePath)
inline

Sets the model document for creation of the msg to the contents of the specified file.

Parameters
FilePathPath of the file containing the model msg.

Referenced by IGTest.ProgramIGTest.TestMsgFinancialTransaction(), and IGTest.ProgramIGTest.TestMsgObservationEvent().

void IG.Lib.MsgBaseWithModel.SetModelString ( string  XmlString)
inline

Sets the model document for creation of the msg to the contents of the specified string.

Parameters
FilePathString containing the model msg.
void IG.Lib.MsgBaseWithModel.SetModelDocument ( XmlDocument  doc)
inline

Sets the model document for creation of the msg to the contents of the specified string.

Parameters
FilePathString containing the model msg.

Member Data Documentation

XmlDocument IG.Lib.MsgBaseWithModel._modelDocument = null
private

Property Documentation

virtual XmlDocument IG.Lib.MsgBaseWithModel.ModelDocument
getset

Gets or seta the XML document that is used as model for creation of XML. Warning: Each call to execution of get() makes a clone of an XmlDocument.


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