Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
ilog::CMessage Class Reference

Basic implementation of the istd::IInformationProvider interface. More...

#include <CMessage.h>

Inheritance diagram for ilog::CMessage:
istd::IInformationProvider iser::IObject istd::IChangeable iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic ilog::CExtMessage ilog::TExtMessage< Element >

Public Member Functions

 CMessage ()
 
 CMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &text, const QString &source, int flags=0, const QDateTime *timeStampPtr=NULL)
 
void SetMessageValues (istd::IInformationProvider::InformationCategory category, int id, const QString &text, const QString &source, int flags=0, const QDateTime *timeStampPtr=NULL)
 
virtual void SetCategory (istd::IInformationProvider::InformationCategory category)
 
virtual void SetText (const QString &text)
 
virtual void SetSource (const QString &source)
 
virtual QDateTime GetInformationTimeStamp () const
 Get optional time stamp of the information. More...
 
virtual InformationCategory GetInformationCategory () const
 Get category of the information. More...
 
virtual int GetInformationId () const
 Get binary ID of the information using to automatical identification of this information type. More...
 
virtual QString GetInformationDescription () const
 Get the text description of the information. More...
 
virtual QString GetInformationSource () const
 Get the source of the information. More...
 
virtual int GetInformationFlags () const
 Get flags of the information. More...
 
virtual QByteArray GetFactoryId () const
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
virtual bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
- Public Member Functions inherited from istd::IInformationProvider
 I_DECLARE_ENUM (InformationCategory, IC_NONE, IC_INFO, IC_WARNING, IC_ERROR, IC_CRITICAL)
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 

Static Public Member Functions

static QByteArray GetMessageTypeId ()
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 

Protected Attributes

istd::IInformationProvider::InformationCategory m_category
 
int m_id
 
QString m_text
 
QString m_source
 
int m_flags
 
QDateTime m_timeStamp
 

Additional Inherited Members

- Public Types inherited from istd::IInformationProvider
enum  InformationCategory {
  IC_NONE, IC_INFO, IC_WARNING, IC_ERROR,
  IC_CRITICAL
}
 Category of information. More...
 
enum  InformationTypeFlags { ITF_DEBUG = 0x1, ITF_SYSTEM = 0x2, ITF_USER = 0x4 }
 Additionally information flags. More...
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0, CF_ALL_DATA, CF_ANY, CF_DESTROYING,
  CF_DELEGATED, CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0, SO_OBSERVE = 1 << 0, SO_COPY = 1 << 1, SO_CLONE = 1 << 2,
  SO_COMPARE = 1 << 3, SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT, CM_WITHOUT_REFS, CM_WITH_REFS, CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Basic implementation of the istd::IInformationProvider interface.

Definition at line 22 of file CMessage.h.

Constructor & Destructor Documentation

ilog::CMessage::CMessage ( )
ilog::CMessage::CMessage ( istd::IInformationProvider::InformationCategory  category,
int  id,
const QString &  text,
const QString &  source,
int  flags = 0,
const QDateTime *  timeStampPtr = NULL 
)

Member Function Documentation

virtual istd::IChangeable* ilog::CMessage::CloneMe ( CompatibilityMode  mode = CM_WITHOUT_REFS) const
virtual

Make a copy of this object.

Returns
new instance or NULL, if this operation is not supported.

Reimplemented from istd::IChangeable.

Reimplemented in ilog::CExtMessage, and ilog::TExtMessage< Element >.

virtual bool ilog::CMessage::CopyFrom ( const istd::IChangeable object,
CompatibilityMode  mode = CM_WITHOUT_REFS 
)
virtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from istd::IChangeable.

Reimplemented in ilog::CExtMessage, and ilog::TExtMessage< Element >.

virtual QByteArray ilog::CMessage::GetFactoryId ( ) const
virtual

Reimplemented from iser::IObject.

Reimplemented in ilog::CExtMessage, and ilog::TExtMessage< Element >.

istd::IInformationProvider::InformationCategory ilog::CMessage::GetInformationCategory ( ) const
inlinevirtual

Get category of the information.

See Also
InformationCategory

Implements istd::IInformationProvider.

Definition at line 87 of file CMessage.h.

References m_category.

QString ilog::CMessage::GetInformationDescription ( ) const
inlinevirtual

Get the text description of the information.

If there is no description provided it contains empty string.

Implements istd::IInformationProvider.

Definition at line 99 of file CMessage.h.

References m_text.

int ilog::CMessage::GetInformationFlags ( ) const
inlinevirtual

Get flags of the information.

See Also
InformationTypeFlags

Implements istd::IInformationProvider.

Definition at line 111 of file CMessage.h.

References m_flags.

int ilog::CMessage::GetInformationId ( ) const
inlinevirtual

Get binary ID of the information using to automatical identification of this information type.

If there is no information ID it returns negative value.

Implements istd::IInformationProvider.

Definition at line 93 of file CMessage.h.

References m_id.

QString ilog::CMessage::GetInformationSource ( ) const
inlinevirtual

Get the source of the information.

If there is no source information provided it contains empty string.

Implements istd::IInformationProvider.

Definition at line 105 of file CMessage.h.

References m_source.

QDateTime ilog::CMessage::GetInformationTimeStamp ( ) const
inlinevirtual

Get optional time stamp of the information.

Returns
time stamp associated with this information, or null QDateTime object, if there is no associated time stamp.

Implements istd::IInformationProvider.

Definition at line 81 of file CMessage.h.

References m_timeStamp.

static QByteArray ilog::CMessage::GetMessageTypeId ( )
static
virtual bool ilog::CMessage::Serialize ( iser::IArchive archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See Also
iser::IArchive

Implements iser::ISerializable.

Reimplemented in ilog::CExtMessage, and ilog::TExtMessage< Element >.

virtual void ilog::CMessage::SetCategory ( istd::IInformationProvider::InformationCategory  category)
virtual
void ilog::CMessage::SetMessageValues ( istd::IInformationProvider::InformationCategory  category,
int  id,
const QString &  text,
const QString &  source,
int  flags = 0,
const QDateTime *  timeStampPtr = NULL 
)
virtual void ilog::CMessage::SetSource ( const QString &  source)
virtual
virtual void ilog::CMessage::SetText ( const QString &  text)
virtual

Member Data Documentation

istd::IInformationProvider::InformationCategory ilog::CMessage::m_category
protected

Definition at line 67 of file CMessage.h.

Referenced by GetInformationCategory().

int ilog::CMessage::m_flags
protected

Definition at line 71 of file CMessage.h.

Referenced by GetInformationFlags().

int ilog::CMessage::m_id
protected

Definition at line 68 of file CMessage.h.

Referenced by GetInformationId().

QString ilog::CMessage::m_source
protected

Definition at line 70 of file CMessage.h.

Referenced by GetInformationSource().

QString ilog::CMessage::m_text
protected

Definition at line 69 of file CMessage.h.

Referenced by GetInformationDescription().

QDateTime ilog::CMessage::m_timeStamp
protected

Definition at line 73 of file CMessage.h.

Referenced by GetInformationTimeStamp().


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy