Public Types | Public Member Functions | List of all members
icomp::IPackagesManager Class Referenceabstract

#include <IPackagesManager.h>

Inheritance diagram for icomp::IPackagesManager:
istd::IChangeable istd::IPolymorphic icomp::IComponentEnvironmentManager icomp::IExtPackagesManager icomp::CEnvironmentManagerBase ipackage::CRegistriesManagerComp icomp::CCachedEnvironmentManager ipackage::CPackagesLoaderComp

Public Types

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

virtual bool LoadPackages (const QString &configFilePath=QString())=0
 Configure environment for specified file path. More...
 
virtual int GetPackageType (const QByteArray &packageId) const =0
 Get type of package as defined in PackageType. More...
 
virtual QString GetPackagePath (const QByteArray &packageId) const =0
 Get directory path of specified component package. More...
 
virtual QString GetRegistryPath (const CComponentAddress &address) const =0
 Get registry file path, if it is composed registry. 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

Definition at line 18 of file IPackagesManager.h.

Member Enumeration Documentation

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 21 of file IPackagesManager.h.

Member Function Documentation

virtual QString icomp::IPackagesManager::GetPackagePath ( const QByteArray &  packageId) const
pure 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.

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

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

Get type of package as defined in PackageType.

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

virtual QString icomp::IPackagesManager::GetRegistryPath ( const CComponentAddress address) const
pure 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.

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

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 ipackage::CPackagesLoaderComp, ipackage::CRegistriesManagerComp, and icomp::CEnvironmentManagerBase.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy