Public Types | Public Member Functions | List of all members
istd::IInformationProvider Class Referenceabstract

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

#include <IInformationProvider.h>

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

Public Types

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

 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. More...
 
virtual InformationCategory GetInformationCategory () const =0
 Get category of the information. More...
 
virtual int GetInformationId () const =0
 Get binary ID of the information using to automatical identification of this information type. More...
 
virtual QString GetInformationDescription () const =0
 Get the text description of the information. More...
 
virtual QString GetInformationSource () const =0
 Get the source of the information. More...
 
virtual int GetInformationFlags () const =0
 Get flags of the information. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this 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 ()
 

Additional Inherited Members

- 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 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

Common interface for class providing some basic information object.

Definition at line 20 of file IInformationProvider.h.

Member Enumeration Documentation

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 26 of file IInformationProvider.h.

Additionally information flags.

Enumerator
ITF_DEBUG 
ITF_SYSTEM 
ITF_USER 

Definition at line 55 of file IInformationProvider.h.

Member Function Documentation

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

Get category of the information.

See Also
InformationCategory

Implemented in ilog::CMessage.

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.

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

Get flags of the information.

See Also
InformationTypeFlags

Implemented in ilog::CMessage.

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.

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.

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.

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:

© 2007-2017 Witold Gantzke and Kirill Lepskiy