Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

NMLFactory Class Reference

#include <NML.h>

List of all members.

Public Methods

NMLCreateNML (const NML::RawNewsObject_t &rno, const NMLEscapeCodeHandler *EscapeCodeHandler)
 create an NML object from raw NML An NML object will be created from the specified raw news object, even if the raw news object is invalid. In this case, an error NML object is created containing a hexadecimal dump of the erroneous input. A handler for NML escape code sequences, e.g. RemoveNMLEscapeSequences or NMLEscapeSequences2HTML must be specified, so that escape code sequences can be handled in an application specific way.

NMLCreateError (NML::NewsObjectId_t oid, const char *title)
 generate an invalid NML error object The title of the error message will be title, and the body will consist of a hex dump of the erroneous NML object.

NMLCreateErrorDump (NML::NewsObjectId_t oid, const NML::RawNewsObject_t &rno, const char *error_msg)
 generate an NML Error object from a raw news object generates a fake NML object containing an error message.


Static Public Methods

NMLFactory * Instance (void)
 NMLFactory Singleton Instance.

void ExitInstance (void)
 NMLFactory Singleton ExitInstance destroys the (only) instance of NMLFactory).


Private Methods

 NMLFactory ()
 ~NMLFactory ()
NMLFactory & operator= (const NMLFactory &)
 NMLFactory (const NMLFactory &)

Static Private Attributes

NMLFactory * _instance = 0


Constructor & Destructor Documentation

NMLFactory::NMLFactory   [private]
 

NMLFactory::~NMLFactory   [private]
 

NMLFactory::NMLFactory const NMLFactory &    [private]
 


Member Function Documentation

NML * NMLFactory::CreateError NML::NewsObjectId_t    oid,
const char *    title
 

generate an invalid NML error object The title of the error message will be title, and the body will consist of a hex dump of the erroneous NML object.

and a hex dump of the raw news object

Parameters:
oid  NML object id
title  title error message
Returns :
pointer to error object (delete after use!)

NML * NMLFactory::CreateErrorDump NML::NewsObjectId_t    oid,
const NML::RawNewsObject_t   rno,
const char *    error_msg
 

generate an NML Error object from a raw news object generates a fake NML object containing an error message.

The title of the error message will be error_msg, and the body will consist of a hex dump of the erroneous NML object. and a hex dump of the raw news object

Parameters:
oid  NML object id
rno  raw NML object
error_msg  error message
Returns :
pointer to created NML errordump object (delete after use!)

NML * NMLFactory::CreateNML const NML::RawNewsObject_t   rno,
const NMLEscapeCodeHandler   EscapeCodeHandler
 

create an NML object from raw NML An NML object will be created from the specified raw news object, even if the raw news object is invalid. In this case, an error NML object is created containing a hexadecimal dump of the erroneous input. A handler for NML escape code sequences, e.g. RemoveNMLEscapeSequences or NMLEscapeSequences2HTML must be specified, so that escape code sequences can be handled in an application specific way.

Parameters:
rno  raw NML object
EscapeCodeHandler  handler for NML escape codes
Returns :
pointer to created NML news object (delete after use!)

void NMLFactory::ExitInstance void    [static]
 

NMLFactory Singleton ExitInstance destroys the (only) instance of NMLFactory).

NMLFactory * NMLFactory::Instance void    [static]
 

NMLFactory Singleton Instance.

Returns :
The (only) instance of NMLFactory

NMLFactory& NMLFactory::operator= const NMLFactory &    [private]
 


Member Data Documentation

NMLFactory * NMLFactory::_instance = 0 [static, private]
 


The documentation for this class was generated from the following files:
Generated on Thu Mar 18 13:10:33 2004 for journaline_demo by doxygen1.2.17