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

#include <CRegistryConsistInfoComp.h>

Inheritance diagram for icmpstr::CRegistryConsistInfoComp:
Collaboration diagram for icmpstr::CRegistryConsistInfoComp:

Public Types

enum  MessageId {
  MI_COMPONENT_INACTIVE = 0x819f0 , MI_NO_ELEMENT_INFO , MI_BAD_ATTRIBUTE_TYPE , MI_UNDEF_ATTRIBUTE ,
  MI_COMPOSITE_FOUND , MI_WRONG_INTERFACE , MI_COMPONENT_NOT_FOUND , MI_REF_NOT_RESOLVED
}
 
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from icmpstr::IRegistryConsistInfo
enum  QueryFlags {
  QF_NONE = 0 , QF_ANY_INTERFACE = 1 << 0 , QF_INCLUDE_UNDEFINED = 1 << 1 , QF_INCLUDE_SUBELEMENTS = 1 << 2 ,
  QF_DETACHED_FROM_CONTAINER = 1 << 3
}
 

Public Member Functions

virtual icomp::IRegistry::Ids GetCompatibleElements (const icomp::IElementStaticInfo::Ids &interfaceNames, const icomp::IRegistry &registry, int queryFlags) const override
 Get list of compatible element names.
 
virtual bool IsRegistryValid (const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const override
 Check if registry is valid.
 
virtual bool IsElementValid (const QByteArray &elementName, const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const override
 Check if element is valid.
 
virtual bool IsAttributeValid (const QByteArray &attributeName, const QByteArray &elementName, const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr, const icomp::IComponentStaticInfo *componentMetaInfoPtr=nullptr) const override
 Check if attribute is valid.
 
virtual bool IsAttributeValueValid (int attributeFlags, const QByteArray &attributeText, const icomp::IElementStaticInfo::Ids &interfaceNames, const icomp::IElementStaticInfo::Ids &optionalInterfaceNames, const icomp::IRegistry &registry, bool ignoreUndef, ilog::IMessageConsumer *reasonConsumerPtr) const override
 Check if attribute is valid.
 
QIcon GetComponentIcon (const icomp::CComponentAddress &address) const override
 Get icon of component.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from icmpstr::IRegistryConsistInfo

Static Public Member Functions

static bool AreTypesCompatible (const QByteArray &metaTypeId, const QByteArray &typeId)
 

Protected Member Functions

icomp::IRegistry::Ids GetCompatibleIds (const QByteArray &elementId, const icomp::IElementStaticInfo &elementStaticInfo, const icomp::IElementStaticInfo::Ids &interfaceNames, int queryFlags) const
 Get list of compatible element ID's.
 
bool CheckAttributeCompatibility (const iser::IObject &attribute, const icomp::IAttributeStaticInfo &attributeMetaInfo, const QByteArray &attributeName, const QByteArray &elementName, const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const
 
bool CheckPointedElementCompatibility (int attributeFlags, const QByteArray &pointedElementName, const icomp::IElementStaticInfo::Ids &interfaceNames, const icomp::IElementStaticInfo::Ids &optionalInterfaceNames, const icomp::IRegistry &registry, bool ignoreUndef, const QString &messagePrefix, ilog::IMessageConsumer *reasonConsumerPtr) const
 
bool CheckPointedElementInfoCompatibility (const QByteArray &pointedElementName, const icomp::IElementStaticInfo *pointedMetaInfoPtr, const icomp::IElementStaticInfo::Ids &interfaceNames, const icomp::IElementStaticInfo::Ids &optionalInterfaceNames, bool ignoreUndef, const QString &messagePrefix, ilog::IMessageConsumer *reasonConsumerPtr) const
 
bool IsElementWithInfoValid (const QByteArray &elementName, const icomp::IRegistry::ElementInfo &elementInfo, const icomp::IComponentStaticInfo *metaInfoPtr, const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentCreated ()
 
virtual void OnComponentDestroyed ()
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () const =0
 Get access to static info of this component.
 

Additional Inherited Members

- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Definition at line 24 of file CRegistryConsistInfoComp.h.

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ MessageId

Enumerator
MI_COMPONENT_INACTIVE 
MI_NO_ELEMENT_INFO 
MI_BAD_ATTRIBUTE_TYPE 
MI_UNDEF_ATTRIBUTE 
MI_COMPOSITE_FOUND 
MI_WRONG_INTERFACE 
MI_COMPONENT_NOT_FOUND 
MI_REF_NOT_RESOLVED 

Definition at line 34 of file CRegistryConsistInfoComp.h.

Member Function Documentation

◆ AreTypesCompatible()

static bool icmpstr::CRegistryConsistInfoComp::AreTypesCompatible ( const QByteArray & metaTypeId,
const QByteArray & typeId )
static

◆ CheckAttributeCompatibility()

bool icmpstr::CRegistryConsistInfoComp::CheckAttributeCompatibility ( const iser::IObject & attribute,
const icomp::IAttributeStaticInfo & attributeMetaInfo,
const QByteArray & attributeName,
const QByteArray & elementName,
const icomp::IRegistry & registry,
bool ignoreUndef,
bool allReasons,
ilog::IMessageConsumer * reasonConsumerPtr ) const
protected

◆ CheckPointedElementCompatibility()

bool icmpstr::CRegistryConsistInfoComp::CheckPointedElementCompatibility ( int attributeFlags,
const QByteArray & pointedElementName,
const icomp::IElementStaticInfo::Ids & interfaceNames,
const icomp::IElementStaticInfo::Ids & optionalInterfaceNames,
const icomp::IRegistry & registry,
bool ignoreUndef,
const QString & messagePrefix,
ilog::IMessageConsumer * reasonConsumerPtr ) const
protected

◆ CheckPointedElementInfoCompatibility()

bool icmpstr::CRegistryConsistInfoComp::CheckPointedElementInfoCompatibility ( const QByteArray & pointedElementName,
const icomp::IElementStaticInfo * pointedMetaInfoPtr,
const icomp::IElementStaticInfo::Ids & interfaceNames,
const icomp::IElementStaticInfo::Ids & optionalInterfaceNames,
bool ignoreUndef,
const QString & messagePrefix,
ilog::IMessageConsumer * reasonConsumerPtr ) const
protected

◆ GetCompatibleElements()

virtual icomp::IRegistry::Ids icmpstr::CRegistryConsistInfoComp::GetCompatibleElements ( const icomp::IElementStaticInfo::Ids & interfaceNames,
const icomp::IRegistry & registry,
int queryFlags ) const
overridevirtual

Get list of compatible element names.

Parameters
interfaceNameslist of interfaces must be implemented.
registryregistry will be looked in.

Implements icmpstr::IRegistryConsistInfo.

◆ GetCompatibleIds()

icomp::IRegistry::Ids icmpstr::CRegistryConsistInfoComp::GetCompatibleIds ( const QByteArray & elementId,
const icomp::IElementStaticInfo & elementStaticInfo,
const icomp::IElementStaticInfo::Ids & interfaceNames,
int queryFlags ) const
protected

Get list of compatible element ID's.

It include also pointed element.

Parameters
queryFlagsflags of query, see icmpstr::IRegistryConsistInfo::QueryFlags.
subcomponentsFlagif true, subcomponents should be included.

◆ GetComponentIcon()

QIcon icmpstr::CRegistryConsistInfoComp::GetComponentIcon ( const icomp::CComponentAddress & address) const
overridevirtual

Get icon of component.

Implements icmpstr::IRegistryConsistInfo.

◆ IsAttributeValid()

virtual bool icmpstr::CRegistryConsistInfoComp::IsAttributeValid ( const QByteArray & attributeName,
const QByteArray & elementName,
const icomp::IRegistry & registry,
bool ignoreUndef,
bool allReasons,
ilog::IMessageConsumer * reasonConsumerPtr,
const icomp::IComponentStaticInfo * componentMetaInfoPtr = nullptr ) const
overridevirtual

Check if attribute is valid.

Parameters
attributeNamename of attribute in specified registry element.
elementNamename of registry element in specified registry.
registryregistry object.
ignoreUndefif true, undefined elements will be ignored.
allReasonsif true, all reasons will be explained.
reasonConsumerPtroptional consumer of messages explaining reason of calculated result.
componentMetaInfoPtroptional component meta info (e.g used for providing meta info of embedded components).

Implements icmpstr::IRegistryConsistInfo.

◆ IsAttributeValueValid()

virtual bool icmpstr::CRegistryConsistInfoComp::IsAttributeValueValid ( int attributeFlags,
const QByteArray & attributeText,
const icomp::IElementStaticInfo::Ids & interfaceNames,
const icomp::IElementStaticInfo::Ids & optionalInterfaceNames,
const icomp::IRegistry & registry,
bool ignoreUndef,
ilog::IMessageConsumer * reasonConsumerPtr ) const
overridevirtual

Check if attribute is valid.

Parameters
refererenceGoaltext of reference value.
isFactorytrue if the relationship type is factory.
registryregistry object.
ignoreUndefif true, undefined elements will be ignored.
allReasonsif true, all reasons will be explained.
reasonConsumerPtroptional consumer of messages explaining reason of calculated result.
componentMetaInfoPtroptional component meta info (e.g used for providing meta info of embedded components).

Implements icmpstr::IRegistryConsistInfo.

◆ IsElementValid()

virtual bool icmpstr::CRegistryConsistInfoComp::IsElementValid ( const QByteArray & elementName,
const icomp::IRegistry & registry,
bool ignoreUndef,
bool allReasons,
ilog::IMessageConsumer * reasonConsumerPtr ) const
overridevirtual

Check if element is valid.

Parameters
attributeNamename of registry element in specified registry.
registryregistry object.
ignoreUndefif true, undefined elements will be ignored.
allReasonsif true, all reasons will be explained.
reasonConsumerPtroptional consumer of messages explaining reason of calculated result.

Implements icmpstr::IRegistryConsistInfo.

◆ IsElementWithInfoValid()

bool icmpstr::CRegistryConsistInfoComp::IsElementWithInfoValid ( const QByteArray & elementName,
const icomp::IRegistry::ElementInfo & elementInfo,
const icomp::IComponentStaticInfo * metaInfoPtr,
const icomp::IRegistry & registry,
bool ignoreUndef,
bool allReasons,
ilog::IMessageConsumer * reasonConsumerPtr ) const
protected

◆ IsRegistryValid()

virtual bool icmpstr::CRegistryConsistInfoComp::IsRegistryValid ( const icomp::IRegistry & registry,
bool ignoreUndef,
bool allReasons,
ilog::IMessageConsumer * reasonConsumerPtr ) const
overridevirtual

Check if registry is valid.

A registry is invalid when it contains unresolved component references.

Parameters
registryregistry object.
ignoreUndefif true, undefined elements will be ignored.
allReasonsif true, all reasons will be explained.
reasonConsumerPtroptional consumer of messages explaining reason of calculated result.

Implements icmpstr::IRegistryConsistInfo.


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

© Witold Gantzke and Kirill Lepskiy