Public Types | Public Member Functions | Protected Member Functions | List of all members
ipackage::CRegistriesManagerComp Class Reference

Manages registries and composed component. More...

#include <CRegistriesManagerComp.h>

Inheritance diagram for ipackage::CRegistriesManagerComp:
ilog::TLoggerCompWrap< Base > icomp::IExtPackagesManager icomp::IRegistriesManager icomp::IRegistryLoader ilog::CLoggerBase icomp::IPackagesManager icomp::IComponentListProvider istd::IPolymorphic ilog::ILoggable istd::ILogger istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic istd::IPolymorphic

Public Types

enum  MessageId { MI_CANNOT_REGISTER = 650, MI_CANNOT_CREATE_ELEMENT }
 
typedef ilog::CLoggerComponentBase BaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- Public Types inherited from icomp::IExtPackagesManager
enum  PathType {
  PT_ALL, PT_CONFIG, PT_PACKAGES_DIR, PT_PACKAGE,
  PT_REGISTRY
}
 
typedef QSet< QString > PathList
 List of pathes. More...
 
- Public Types inherited from icomp::IPackagesManager
enum  PackageType { PT_UNDIFINED, PT_UNKNOWN, PT_REAL, PT_COMPOSED }
 
- 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 Types inherited from icomp::IComponentListProvider
enum  ComponentTypeFlag { CTF_REAL = 1 << IComponentStaticInfo::CT_REAL, CTF_COMPOSITE = 1 << IComponentStaticInfo::CT_COMPOSITE, CTF_ALL = -1 }
 
typedef QSet< CComponentAddressComponentAddresses
 

Public Member Functions

virtual PathList GetConfigurationPathList (PathType pathType) const
 Get list of files used for configuration. More...
 
virtual int GetPackageDefinitionLevel (const QByteArray &packageId) const
 Get level of package definition in configuration. More...
 
virtual bool LoadPackages (const QString &configFilePath=QString())
 Configure environment for specified file path. More...
 
virtual int GetPackageType (const QByteArray &packageId) const
 Get type of package as defined in PackageType. More...
 
virtual QString GetPackagePath (const QByteArray &packageId) const
 Get directory path of specified component package. More...
 
virtual QString GetRegistryPath (const icomp::CComponentAddress &address) const
 Get registry file path, if it is composed registry. More...
 
virtual const icomp::IRegistryGetRegistry (const icomp::CComponentAddress &address, const icomp::IRegistry *contextRegistryPtr=NULL) const
 Get access to stored registry. More...
 
virtual ComponentAddresses GetComponentAddresses (int typeFlag=CTF_ALL) const
 Get addresses of known components. More...
 
virtual const icomp::IRegistryGetRegistryFromFile (const QString &path) const
 Get an ACF registry from a given file. More...
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
virtual void SetLogPtr (ilog::IMessageConsumer *logPtr)
 Install log. More...
 
virtual ilog::IMessageConsumerGetLogPtr () const
 Get log. More...
 
virtual void SetTracingEnabled (bool trace)
 Enable/disable tracing. More...
 
virtual bool IsTracingEnabled () const
 Returns true if tracing enabled. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- 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...
 

Protected Member Functions

void RegisterPackageFile (const QString &file, int definitionLevel)
 
void RegisterPackagesDir (const QString &subDir, int definitionLevel)
 
bool LoadConfigFile (const QString &configFile, int definitionLevel)
 
bool CheckAndMarkPath (PathList &pathList, const QDir &directory, const QString &path, QString &resultPath) const
 
virtual void OnComponentCreated ()
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool IsVerboseEnabled () const
 Check if verbose messages are enabled. More...
 
void SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message. More...
 
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
 Decorate message parts before outputting. More...
 
virtual void OnComponentDestroyed ()
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send info message to log. More...
 
bool SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send warning message to log. More...
 
bool SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send error message to log. More...
 
bool SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send critical message to log. More...
 
bool SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once info message to log. More...
 
bool SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once warning message to log. More...
 
bool SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once error message to log. More...
 
bool SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once critical message to log. More...
 
bool SendUserMessage (const istd::IInformationProvider *messagePtr) const
 Send message with user object. More...
 
bool AllowMessageOnceAgain (int id)
 Reset message lock. More...
 
virtual bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=NULL, const int *flagsPtr=NULL) const
 Check if any log message is consumed. More...
 
virtual bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
 Send any message to log. 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...
 

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 Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Manages registries and composed component.

It allows simple management of packages without loading of real packages.

Definition at line 28 of file CRegistriesManagerComp.h.

Member Typedef Documentation

Definition at line 35 of file CRegistriesManagerComp.h.

Member Enumeration Documentation

Enumerator
MI_CANNOT_REGISTER 
MI_CANNOT_CREATE_ELEMENT 

Definition at line 37 of file CRegistriesManagerComp.h.

Member Function Documentation

bool ipackage::CRegistriesManagerComp::CheckAndMarkPath ( PathList pathList,
const QDir &  directory,
const QString &  path,
QString &  resultPath 
) const
protected
virtual ComponentAddresses ipackage::CRegistriesManagerComp::GetComponentAddresses ( int  typeFlag = CTF_ALL) const
virtual

Get addresses of known components.

Implements icomp::IComponentListProvider.

virtual PathList ipackage::CRegistriesManagerComp::GetConfigurationPathList ( PathType  pathType) const
virtual

Get list of files used for configuration.

Implements icomp::IExtPackagesManager.

virtual int ipackage::CRegistriesManagerComp::GetPackageDefinitionLevel ( const QByteArray &  packageId) const
virtual

Get level of package definition in configuration.

The packages defined direct in loaded configuration file returns 0, the packages in the derrived configuration 1 etc. It returns negative value if the definition level cannot be calculated.

Implements icomp::IExtPackagesManager.

virtual QString ipackage::CRegistriesManagerComp::GetPackagePath ( const QByteArray &  packageId) const
virtual

Get directory path of specified component package.

Parameters
packageIdID of component package.
Returns
package path or empty string if specified package is not registered.

Implements icomp::IPackagesManager.

virtual int ipackage::CRegistriesManagerComp::GetPackageType ( const QByteArray &  packageId) const
virtual

Get type of package as defined in PackageType.

Implements icomp::IPackagesManager.

virtual const icomp::IRegistry* ipackage::CRegistriesManagerComp::GetRegistry ( const icomp::CComponentAddress address,
const icomp::IRegistry contextRegistryPtr = NULL 
) const
virtual

Get access to stored registry.

Parameters
addressadress of registry treated as composed component.
Returns
registry object or NULL if specified composite component is not registered.

Implements icomp::IRegistriesManager.

virtual const icomp::IRegistry* ipackage::CRegistriesManagerComp::GetRegistryFromFile ( const QString &  path) const
virtual

Get an ACF registry from a given file.

Implements icomp::IRegistryLoader.

virtual QString ipackage::CRegistriesManagerComp::GetRegistryPath ( const icomp::CComponentAddress address) const
virtual

Get registry file path, if it is composed registry.

Parameters
addressadress of registry treated as composed component.
Returns
registry object or NULL if specified composite component is not registered.

Implements icomp::IPackagesManager.

bool ipackage::CRegistriesManagerComp::LoadConfigFile ( const QString &  configFile,
int  definitionLevel 
)
protected
virtual bool ipackage::CRegistriesManagerComp::LoadPackages ( const QString &  configFilePath = QString())
virtual

Configure environment for specified file path.

If this file path is invalid or empty, standard configuration file will be used.

Implements icomp::IPackagesManager.

virtual void ipackage::CRegistriesManagerComp::OnComponentCreated ( )
protectedvirtual

Reimplemented from ilog::TLoggerCompWrap< Base >.

void ipackage::CRegistriesManagerComp::RegisterPackageFile ( const QString &  file,
int  definitionLevel 
)
protected
void ipackage::CRegistriesManagerComp::RegisterPackagesDir ( const QString &  subDir,
int  definitionLevel 
)
protected

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy