ICF 3.0.5.47
Technical documentation of ICF Libraries
icmpstr::CPackagesLoaderExtComp Class Reference

#include <CPackagesLoaderExtComp.h>

Inheritance diagram for icmpstr::CPackagesLoaderExtComp:
Collaboration diagram for icmpstr::CPackagesLoaderExtComp:

Classes

class  ParamsManager
 

Public Types

typedef ipackage::CPackagesLoaderComp BaseClass
 
- Public Types inherited from ipackage::CPackagesLoaderComp
enum  MessageId { MI_CANNOT_REGISTER = 650 , MI_CANNOT_CREATE_ELEMENT }
 
typedef ilog::CLoggerComponentBase BaseClass
 
typedef icomp::CEnvironmentManagerBase BaseClass2
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- Public Types inherited from icomp::IComponentStaticInfo
enum class  ComponentType { None , Real , Composite }
 Specify type of the component realization. More...
 
- Public Types inherited from icomp::IElementStaticInfo
enum class  MetaGroupId : int { Interfaces , Subelements , EmbeddedComponents , Last = Subelements }
 
typedef QSet< QByteArray > Ids
 
- 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 Types inherited from icomp::IPackagesManager
enum  ChangeFlags { CF_PACKAGES_CHANGED = 0x734638 }
 
enum  PackageType { PT_UNDIFINED , PT_UNKNOWN , PT_REAL , PT_COMPOSED }
 
- Public Types inherited from icomp::IComponentListProvider
enum  ComponentTypeFlag { CTF_REAL = 1 << int(IComponentStaticInfo::ComponentType::Real) , CTF_COMPOSITE = 1 << int(IComponentStaticInfo::ComponentType::Composite) , CTF_ALL = -1 }
 
typedef QSet< CComponentAddressComponentAddresses
 

Public Member Functions

bool RegisterPackagesDir (const QString &subDir) override
 
QString GetPackageInfoPath (const QByteArray &packageId) const override
 Get path of package info directory.
 
QString GetComponentInfoPath (const icomp::CComponentAddress &address) const override
 Get path of component info directory.
 
- Public Member Functions inherited from ipackage::CPackagesLoaderComp
const icomp::IRegistryGetRegistryFromFile (const QString &path) const override
 Get an ICF registry from a given file.
 
QString GetConfigFilePath () const override
 Get file path of real used config file.
 
bool LoadPackages (const QString &configFilePath=QString()) override
 Configure environment for specified file path.
 
int GetPackageType (const QByteArray &packageId) const override
 Get type of package as defined in PackageType.
 
QString GetPackagePath (const QByteArray &packageId) const override
 Get directory path of specified component package.
 
QString GetRegistryPath (const icomp::CComponentAddress &address) const override
 Get registry file path, if it is composed registry.
 
const icomp::IRegistryGetRegistry (const icomp::CComponentAddress &address, const icomp::IRegistry *contextRegistryPtr=nullptr) const override
 Get access to stored registry.
 
ComponentAddresses GetComponentAddresses (int typeFlag=CTF_ALL) const override
 Get addresses of known components.
 
void OnComponentCreated () override
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from icomp::CEnvironmentManagerBase
virtual const IComponentStaticInfoGetComponentMetaInfo (const CComponentAddress &address) const
 Get access to static info of some component.
 
virtual const IComponentStaticInfoGetPackageMetaInfo (const QByteArray &packageId) const
 Get access to static info of a package.
 
- Public Member Functions inherited from icomp::CPackageStaticInfo
 CPackageStaticInfo ()
 
 CPackageStaticInfo (const QString &description, const QString &keywords)
 
void Reset ()
 
virtual void RegisterEmbeddedComponentInfo (const QByteArray &embeddedId, const IComponentStaticInfo *componentInfoPtr)
 Register embedded component static info.
 
Ids GetMetaIds (MetaGroupId metaGroupId) const override
 Get list of meta IDs associated with some meta key.
 
const IComponentStaticInfoGetEmbeddedComponentInfo (const QByteArray &embeddedId) const override
 Return number of interfaces for specific slot.
 
const QString & GetDescription () const override
 Get human readable description of this component.
 
const QString & GetKeywords () const override
 Get keywords for this component.
 
- Public Member Functions inherited from icomp::CComponentStaticInfoBase
ComponentType GetComponentType () const override
 Get information about component type.
 
const IAttributeStaticInfoGetAttributeInfo (const QByteArray &attributeId) const override
 Get set of attributes.
 
const IElementStaticInfoGetSubelementInfo (const QByteArray &subcomponentId) const override
 Return number of interfaces for specific slot.
 
iattr::IAttributesProvider::AttributeIds GetAttributeMetaIds () const override
 Get all IDs of known attribute meta informations.
 
const iattr::IAttributeMetaInfoGetAttributeMetaInfo (const QByteArray &attributeId) const override
 Get property with the given index.
 
- Public Member Functions inherited from icomp::IComponentStaticInfo
- Public Member Functions inherited from icomp::IElementStaticInfo
- Public Member Functions inherited from iattr::IAttributesMetaInfoProvider
- 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< IChangeableCloneMe (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.
 
- Public Member Functions inherited from icomp::IComponentEnvironmentManager
- Public Member Functions inherited from icomp::IPackagesManager
- Public Member Functions inherited from icomp::IRegistriesManager
- Public Member Functions inherited from icomp::IComponentListProvider
- Public Member Functions inherited from icomp::IMetaInfoManager
- Public Member Functions inherited from icomp::IRegistryLoader
- Public Member Functions inherited from icmpstr::IExternalMetaInfoManager

Protected Member Functions

bool ProcessConfigFile (const icomp::CConfigurationInfo &configInfo, const QDir &baseDir, int definitionLevel) override
 
- Protected Member Functions inherited from ipackage::CPackagesLoaderComp
virtual bool RegisterPackageFile (const QString &file)
 
virtual bool LoadConfigFile (const QString &configFile, int definitionLevel)
 
icomp::GetPackageInfoFunc GetPackageFunction (const QFileInfo &fileInfo)
 
bool CheckAndMarkPath (const QDir &directory, const QString &path, QString &resultPath) const
 Check if path was already visited and return enrolled value.
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
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.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
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::ILogger
- 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 ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Definition at line 24 of file CPackagesLoaderExtComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetComponentInfoPath()

QString icmpstr::CPackagesLoaderExtComp::GetComponentInfoPath ( const icomp::CComponentAddress & address) const
overridevirtual

Get path of component info directory.

Implements icmpstr::IExternalMetaInfoManager.

◆ GetPackageInfoPath()

QString icmpstr::CPackagesLoaderExtComp::GetPackageInfoPath ( const QByteArray & packageId) const
overridevirtual

Get path of package info directory.

Implements icmpstr::IExternalMetaInfoManager.

◆ ProcessConfigFile()

bool icmpstr::CPackagesLoaderExtComp::ProcessConfigFile ( const icomp::CConfigurationInfo & configInfo,
const QDir & baseDir,
int definitionLevel )
overrideprotectedvirtual

Reimplemented from ipackage::CPackagesLoaderComp.

◆ RegisterPackagesDir()

bool icmpstr::CPackagesLoaderExtComp::RegisterPackagesDir ( const QString & subDir)
overridevirtual

Reimplemented from ipackage::CPackagesLoaderComp.


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

© Witold Gantzke and Kirill Lepskiy