Manages registries and composed component. More...

#include <CRegistriesManagerComp.h>

Inheritance diagram for ipackage::CRegistriesManagerComp:

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
	Base class typedef for component functionality.

typedef ilog::CLoggerBase	BaseClass2
	Base class typedef for logger functionality.

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.

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

typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

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

Public Member Functions
virtual PathList	GetConfigurationPathList (PathType pathType) const override
	Get list of files used for configuration.

virtual int	GetPackageDefinitionLevel (const QByteArray &packageId) const override
	Get level of package definition in configuration.

virtual bool	LoadPackages (const QString &configFilePath=QString()) override
	Configure environment for specified file path.

virtual int	GetPackageType (const QByteArray &packageId) const override
	Get type of package as defined in `PackageType`.

virtual QString	GetPackagePath (const QByteArray &packageId) const override
	Get directory path of specified component package.

virtual QString	GetRegistryPath (const icomp::CComponentAddress &address) const override
	Get registry file path, if it is composed registry.

virtual const icomp::IRegistry *	GetRegistry (const icomp::CComponentAddress &address, const icomp::IRegistry *contextRegistryPtr=NULL) const override
	Get access to stored registry.

virtual ComponentAddresses	GetComponentAddresses (int typeFlag=CTF_ALL) const override
	Get addresses of known components.

virtual const icomp::IRegistry *	GetRegistryFromFile (const QString &path) const override
	Get an ACF registry from a given file.

Public Member Functions inherited from ilog::CLoggerBase
	CLoggerBase ()
	Default constructor.

virtual void	SetLogPtr (ilog::IMessageConsumer *logPtr) override
	Attach a message consumer for logging.

virtual ilog::IMessageConsumer *	GetLogPtr () const override
	Get the currently attached message consumer.

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.

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.

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 () override
	Called when component is created.

Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
bool	IsVerboseEnabled (int tracingLevel=0) const
	Check if verbose messages are enabled for a given tracing level.

void	SendVerboseMessage (const QString &message, const QString &messageSource=QString(), int tracingLevel=0) const
	Send a verbose message if enabled.

virtual void	DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
	Decorate message before sending.

virtual void	OnComponentDestroyed () override
	Called when component is destroyed.

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.

bool	SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send warning message to log.

bool	SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send error message to log.

bool	SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send critical message to log.

bool	SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once info message to log.

bool	SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once warning message to log.

bool	SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once error message to log.

bool	SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
	Send once critical message to log.

bool	SendUserMessage (const istd::IInformationProvider *messagePtr) const
	Send message with user object.

bool	AllowMessageOnceAgain (int id)
	Reset message lock.

virtual bool	IsLogConsumed (const istd::IInformationProvider::InformationCategory categoryPtr=NULL, const int flagsPtr=NULL) const override
	Check if any log message is consumed.

virtual bool	SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
	Send any message to log.

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.

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

◆ BaseClass

typedef ilog::CLoggerComponentBase ipackage::CRegistriesManagerComp::BaseClass

Definition at line 35 of file CRegistriesManagerComp.h.

Member Enumeration Documentation

◆ MessageId

enum ipackage::CRegistriesManagerComp::MessageId

Enumerator
MI_CANNOT_REGISTER
MI_CANNOT_CREATE_ELEMENT

Definition at line 37 of file CRegistriesManagerComp.h.

Member Function Documentation

◆ CheckAndMarkPath()

bool ipackage::CRegistriesManagerComp::CheckAndMarkPath	(	PathList &	pathList,
		const QDir &	directory,
		const QString &	path,
		QString &	resultPath
	)		const

protected

◆ GetComponentAddresses()

virtual ComponentAddresses ipackage::CRegistriesManagerComp::GetComponentAddresses ( int typeFlag = CTF_ALL ) const

overridevirtual

Get addresses of known components.

Implements icomp::IComponentListProvider.

◆ GetConfigurationPathList()

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

overridevirtual

Get list of files used for configuration.

Implements icomp::IExtPackagesManager.

◆ GetPackageDefinitionLevel()

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

overridevirtual

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.

◆ GetPackagePath()

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

overridevirtual

Get directory path of specified component package.

Parameters

packageId ID of component package.

Returns: package path or empty string if specified package is not registered.

Implements icomp::IPackagesManager.

◆ GetPackageType()

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

overridevirtual

Get type of package as defined in PackageType.

Implements icomp::IPackagesManager.

◆ GetRegistry()

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

overridevirtual

Get access to stored registry.

Parameters

address adress of registry treated as composed component.

Returns: registry object or NULL if specified composite component is not registered.

Implements icomp::IRegistriesManager.

◆ GetRegistryFromFile()

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

overridevirtual

Get an ACF registry from a given file.

Implements icomp::IRegistryLoader.

◆ GetRegistryPath()

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

overridevirtual

Get registry file path, if it is composed registry.

Parameters

address adress of registry treated as composed component.

Returns: registry object or NULL if specified composite component is not registered.

Implements icomp::IPackagesManager.

◆ LoadConfigFile()

bool ipackage::CRegistriesManagerComp::LoadConfigFile	(	const QString &	configFile,
		int	definitionLevel
	)

protected

◆ LoadPackages()

virtual bool ipackage::CRegistriesManagerComp::LoadPackages ( const QString & configFilePath = QString() )

overridevirtual

Configure environment for specified file path.

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

Implements icomp::IPackagesManager.

◆ OnComponentCreated()

virtual void ipackage::CRegistriesManagerComp::OnComponentCreated ( )

overrideprotectedvirtual

Called when component is created.

Automatically connects the log consumer from the "Log" reference.

Note: Override to add initialization, but always call base class:
virtual void OnComponentCreated() override {

// Custom initialization

BaseClass::OnComponentCreated();

}

ilog::TLoggerCompWrap::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.
Definition TLoggerCompWrap.h:330

ipackage::CRegistriesManagerComp::OnComponentCreated
virtual void OnComponentCreated() override
Called when component is created.

Reimplemented from ilog::TLoggerCompWrap< Base >.

◆ RegisterPackageFile()

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

protected

◆ RegisterPackagesDir()

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

protected

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

Acf/Include/ipackage/CRegistriesManagerComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ MessageId

Member Function Documentation

◆ CheckAndMarkPath()

◆ GetComponentAddresses()

◆ GetConfigurationPathList()

◆ GetPackageDefinitionLevel()

◆ GetPackagePath()

◆ GetPackageType()

◆ GetRegistry()

◆ GetRegistryFromFile()

◆ GetRegistryPath()

◆ LoadConfigFile()

◆ LoadPackages()

◆ OnComponentCreated()

◆ RegisterPackageFile()

◆ RegisterPackagesDir()