icomp::IPackagesManager Class Reference

#include <IPackagesManager.h>

Inheritance diagram for icomp::IPackagesManager:

Collaboration diagram for icomp::IPackagesManager:

Public Types
enum	ChangeFlags { CF_PACKAGES_CHANGED = 0x734638 }
enum	PackageType { PT_UNDIFINED , PT_UNKNOWN , PT_REAL , PT_COMPOSED }
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ICF_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 , SO_CHANGE_LOCK = 1 << 5 }
	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
virtual bool	LoadPackages (const QString &configFilePath=QString())=0
	Configure environment for specified file path.
virtual int	GetPackageType (const QByteArray &packageId) const =0
	Get type of package as defined in PackageType.
virtual QString	GetPackagePath (const QByteArray &packageId) const =0
	Get directory path of specified component package.
virtual QString	GetRegistryPath (const CComponentAddress &address) const =0
	Get registry file path, if it is composed registry.
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 std::unique_ptr< 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 QMutex *	GetChangesLock () const
	Get mutex beeing locked during changes, if available.
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.

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

Definition at line 22 of file IPackagesManager.h.

Member Enumeration Documentation

ChangeFlags

enum icomp::IPackagesManager::ChangeFlags

Enumerator
CF_PACKAGES_CHANGED

Definition at line 25 of file IPackagesManager.h.

PackageType

enum icomp::IPackagesManager::PackageType

Enumerator
PT_UNDIFINED	Package doesn't exist.
PT_UNKNOWN	Type of this package cannot be found out.
PT_REAL	Real packages are stored as dynamic linked libraries in arp files.
PT_COMPOSED	Composed packages are stored in folders containing registry files (acc files).

Definition at line 30 of file IPackagesManager.h.

Member Function Documentation

GetPackagePath()

virtual QString icomp::IPackagesManager::GetPackagePath ( const QByteArray & packageId ) const

pure virtual

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.

Implemented in icomp::CEnvironmentManagerBase, ipackage::CPackagesLoaderComp, and ipackage::CRegistriesManagerComp.

GetPackageType()

virtual int icomp::IPackagesManager::GetPackageType ( const QByteArray & packageId ) const

pure virtual

Get type of package as defined in PackageType.

Implemented in icomp::CEnvironmentManagerBase, ipackage::CPackagesLoaderComp, and ipackage::CRegistriesManagerComp.

GetRegistryPath()

virtual QString icomp::IPackagesManager::GetRegistryPath ( const CComponentAddress & address ) const

pure virtual

Get registry file path, if it is composed registry.

Parameters

address

adress of registry treated as composed component.

Returns

registry object or nullptr if specified composite component is not registered.

Implemented in icomp::CEnvironmentManagerBase, ipackage::CPackagesLoaderComp, and ipackage::CRegistriesManagerComp.

LoadPackages()

virtual bool icomp::IPackagesManager::LoadPackages ( const QString & configFilePath = QString() )

pure virtual

Configure environment for specified file path.

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

Implemented in icomp::CEnvironmentManagerBase, ipackage::CPackagesLoaderComp, and ipackage::CRegistriesManagerComp.

---

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

• icomp/IPackagesManager.h