ICF 3.0.5.47
Technical documentation of ICF Libraries
icmpstr::IRegistryConsistInfo Class Referenceabstract

#include <IRegistryConsistInfo.h>

Inheritance diagram for icmpstr::IRegistryConsistInfo:
Collaboration diagram for icmpstr::IRegistryConsistInfo:

Public Types

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=QF_NONE) const =0
 Get list of compatible element names.
 
virtual bool IsRegistryValid (const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const =0
 Check if registry is valid.
 
virtual bool IsElementValid (const QByteArray &elementName, const icomp::IRegistry &registry, bool ignoreUndef, bool allReasons, ilog::IMessageConsumer *reasonConsumerPtr) const =0
 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 =0
 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 =0
 Check if attribute is valid.
 
virtual QIcon GetComponentIcon (const icomp::CComponentAddress &address) const =0
 Get icon of component.
 

Detailed Description

Definition at line 24 of file IRegistryConsistInfo.h.

Member Enumeration Documentation

◆ QueryFlags

Enumerator
QF_NONE 
QF_ANY_INTERFACE 

Supporting of any specified interfaces is enough to interprete component as compatible one.

QF_INCLUDE_UNDEFINED 

If active, all undefined (without available meta information) elements will be also included.

QF_INCLUDE_SUBELEMENTS 

If active, subelements will be also considered.

QF_DETACHED_FROM_CONTAINER 

If active, subelements will be also considered.

Definition at line 27 of file IRegistryConsistInfo.h.

Member Function Documentation

◆ GetCompatibleElements()

virtual icomp::IRegistry::Ids icmpstr::IRegistryConsistInfo::GetCompatibleElements ( const icomp::IElementStaticInfo::Ids & interfaceNames,
const icomp::IRegistry & registry,
int queryFlags = QF_NONE ) const
pure virtual

Get list of compatible element names.

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

Implemented in icmpstr::CRegistryConsistInfoComp.

◆ GetComponentIcon()

virtual QIcon icmpstr::IRegistryConsistInfo::GetComponentIcon ( const icomp::CComponentAddress & address) const
pure virtual

Get icon of component.

Implemented in icmpstr::CRegistryConsistInfoComp.

◆ IsAttributeValid()

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

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

Implemented in icmpstr::CRegistryConsistInfoComp.

◆ IsAttributeValueValid()

virtual bool icmpstr::IRegistryConsistInfo::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
pure virtual

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

Implemented in icmpstr::CRegistryConsistInfoComp.

◆ IsElementValid()

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

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.

Implemented in icmpstr::CRegistryConsistInfoComp.

◆ IsRegistryValid()

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

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.

Implemented in icmpstr::CRegistryConsistInfoComp.


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

© Witold Gantzke and Kirill Lepskiy