Common interface for class providing some basic information object. More...

#include <IInformationProvider.h>

Inheritance diagram for istd::IInformationProvider:

Public Types
enum	InformationCategory { IC_NONE = 0 , 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...

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
	I_DECLARE_ENUM (InformationCategory, IC_NONE, IC_INFO, IC_WARNING, IC_ERROR, IC_CRITICAL)

virtual QDateTime	GetInformationTimeStamp () const =0
	Get optional time stamp of the information.

virtual InformationCategory	GetInformationCategory () const =0
	Get category of the information.

virtual int	GetInformationId () const =0
	Get binary ID of the information using to automatical identification of this information type.

virtual QString	GetInformationDescription () const =0
	Get the text description of the information.

virtual QString	GetInformationSource () const =0
	Get the source of the information.

virtual int	GetInformationFlags () const =0
	Get flags of the information.

Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.

virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.

virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.

virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.

virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.

virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.

virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.

virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.

virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.

static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.

static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.

static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.

Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.

virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Common interface for class providing some basic information object.

Definition at line 21 of file IInformationProvider.h.

Member Enumeration Documentation

◆ InformationCategory

enum istd::IInformationProvider::InformationCategory

Category of information.

Enumerator
IC_NONE	Information is unimportant, for example can be used for diagnostic.
IC_INFO	Normal information level.
IC_WARNING	Information about warning, processing could be done.
IC_ERROR	Information about error, processing could not be done correctly.
IC_CRITICAL	Information about critical error - unnormal state of system, should never be returned.

Definition at line 27 of file IInformationProvider.h.

◆ InformationTypeFlags

enum istd::IInformationProvider::InformationTypeFlags

Additionally information flags.

Enumerator
ITF_DEBUG
ITF_SYSTEM
ITF_USER

Definition at line 56 of file IInformationProvider.h.

Member Function Documentation

◆ GetInformationCategory()

virtual InformationCategory istd::IInformationProvider::GetInformationCategory ( ) const

pure virtual

Get category of the information.

See also: InformationCategory

Implemented in ilog::CMessage.

◆ GetInformationDescription()

virtual QString istd::IInformationProvider::GetInformationDescription ( ) const

pure virtual

Get the text description of the information.

If there is no description provided it contains empty string.

Implemented in ilog::CMessage.

◆ GetInformationFlags()

virtual int istd::IInformationProvider::GetInformationFlags ( ) const

pure virtual

Get flags of the information.

See also: InformationTypeFlags

Implemented in ilog::CMessage.

◆ GetInformationId()

virtual int istd::IInformationProvider::GetInformationId ( ) const

pure virtual

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

If there is no information ID it returns negative value.

Implemented in ilog::CMessage.

◆ GetInformationSource()

virtual QString istd::IInformationProvider::GetInformationSource ( ) const

pure virtual

Get the source of the information.

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

Implemented in ilog::CMessage.

◆ GetInformationTimeStamp()

virtual QDateTime istd::IInformationProvider::GetInformationTimeStamp ( ) const

pure virtual

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.

Implemented in ilog::CMessage.

◆ I_DECLARE_ENUM()

istd::IInformationProvider::I_DECLARE_ENUM	(	InformationCategory	,
		IC_NONE	,
		IC_INFO	,
		IC_WARNING	,
		IC_ERROR	,
		IC_CRITICAL
	)

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

Acf/Include/istd/IInformationProvider.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InformationCategory

◆ InformationTypeFlags

Member Function Documentation

◆ GetInformationCategory()

◆ GetInformationDescription()

◆ GetInformationFlags()

◆ GetInformationId()

◆ GetInformationSource()

◆ GetInformationTimeStamp()

◆ I_DECLARE_ENUM()