Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
ilog::CExtMessage Class Reference

Extended message supporting attached list of objects. More...

#include <CExtMessage.h>

Inheritance diagram for ilog::CExtMessage:
ilog::CMessage istd::IInformationProvider iser::IObject istd::IChangeable iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic

Classes

struct  AttachedObject
 

Public Types

typedef CMessage BaseClass
 
- 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...
 

Public Member Functions

 CExtMessage (const iser::IObjectFactory *factoryPtr=NULL)
 
 CExtMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &text, const QString &source, int flags=0, const QDateTime *timeStampPtr=NULL, const iser::IObjectFactory *factoryPtr=NULL)
 
const iser::IObjectFactoryGetObjectFactory () const
 
void SetObjectFactory (const iser::IObjectFactory *factoryPtr)
 
void ResetAttachedObjects ()
 Remove all attached objects from container. More...
 
int GetAttachedObjectsCount () const
 Get number of attached objects. More...
 
const iser::IObjectGetAttachedObject (int index) const
 Get single attached object. More...
 
const QString & GetAttachedObjectDescription (int index) const
 Get description of attached object. More...
 
void InsertAttachedObject (const iser::IObject *objectPtr, const QString &description="")
 Add some object to this container. 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_STRICT)
 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 ilog::CMessage
 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...
 
- 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 GetTypeName ()
 
- Static Public Member Functions inherited from ilog::CMessage
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...
 

Additional Inherited Members

- 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...
 
- Protected Attributes inherited from ilog::CMessage
istd::IInformationProvider::InformationCategory m_category
 
int m_id
 
QString m_text
 
QString m_source
 
int m_flags
 
QDateTime m_timeStamp
 

Detailed Description

Extended message supporting attached list of objects.

Definition at line 23 of file CExtMessage.h.

Member Typedef Documentation

Definition at line 26 of file CExtMessage.h.

Constructor & Destructor Documentation

ilog::CExtMessage::CExtMessage ( const iser::IObjectFactory factoryPtr = NULL)
explicit
ilog::CExtMessage::CExtMessage ( istd::IInformationProvider::InformationCategory  category,
int  id,
const QString &  text,
const QString &  source,
int  flags = 0,
const QDateTime *  timeStampPtr = NULL,
const iser::IObjectFactory factoryPtr = NULL 
)

Member Function Documentation

virtual istd::IChangeable* ilog::CExtMessage::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 ilog::CMessage.

virtual bool ilog::CExtMessage::CopyFrom ( const istd::IChangeable object,
CompatibilityMode  mode = CM_STRICT 
)
virtual

Copy this object from another one.

Default implementation in istd::IChangeable does nothing.

Reimplemented from ilog::CMessage.

const iser::IObject* ilog::CExtMessage::GetAttachedObject ( int  index) const

Get single attached object.

const QString& ilog::CExtMessage::GetAttachedObjectDescription ( int  index) const

Get description of attached object.

int ilog::CExtMessage::GetAttachedObjectsCount ( ) const

Get number of attached objects.

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

Reimplemented from ilog::CMessage.

const iser::IObjectFactory* ilog::CExtMessage::GetObjectFactory ( ) const
static QByteArray ilog::CExtMessage::GetTypeName ( )
static
void ilog::CExtMessage::InsertAttachedObject ( const iser::IObject objectPtr,
const QString &  description = "" 
)

Add some object to this container.

Parameters
objectPtrattached object, ownership of this object belongs to container (it will be removed automatically).
void ilog::CExtMessage::ResetAttachedObjects ( )

Remove all attached objects from container.

virtual bool ilog::CExtMessage::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

Reimplemented from ilog::CMessage.

void ilog::CExtMessage::SetObjectFactory ( const iser::IObjectFactory factoryPtr)

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy