List of all members | Public Member Functions
EntityFusionMethod Class Referenceabstract

Interface for fusion methods used for entities in working memory. More...

#include <MemoryX/libraries/workingmemory/fusion/EntityFusionMethod.h>

+ Inheritance diagram for EntityFusionMethod:

Public Member Functions

 EntityFusionMethod (std::string methodName)
 Constructs a new fusion method. More...
 
EntityBasePtr fuseEntity (const EntityBasePtr &baseEntity, const EntityBasePtr &updateEntity, const ::Ice::Current &=Ice::emptyCurrent) override=0
 Fusion method. More...
 
std::string getMethodName (const ::Ice::Current &=Ice::emptyCurrent) const override
 
EntityBasePtr initEntity (const EntityBasePtr &updateEntity, const ::Ice::Current &=Ice::emptyCurrent) override
 Initialization of an entity. More...
 

Detailed Description

Interface for fusion methods used for entities in working memory.

Define fusion methods by subclassing EntityFusionMethod. The pure virtual method fuse() needs to be implemented.

Definition at line 43 of file EntityFusionMethod.h.

Constructor & Destructor Documentation

◆ EntityFusionMethod()

EntityFusionMethod ( std::string  methodName)
inline

Constructs a new fusion method.

Parameters
nameof the fusion method

Definition at line 52 of file EntityFusionMethod.h.

Member Function Documentation

◆ fuseEntity()

EntityBasePtr fuseEntity ( const EntityBasePtr &  baseEntity,
const EntityBasePtr &  updateEntity,
const ::Ice::Current &  = Ice::emptyCurrent 
)
overridepure virtual

Fusion method.

Fuses two entities with the same key. Implement this in a concrete EntityFusionMethod.

Parameters
baseEntitybase entity for fusion
updateEntityentity to be fused with base entity
Returns
fused entity

Implemented in GaussianMixturePositionFusion, KalmanFilterFusion, PriorAttributeEnrichmentFusion, and AttributeReplacementFusion.

◆ getMethodName()

std::string getMethodName ( const ::Ice::Current &  = Ice::emptyCurrent) const
inlineoverride

Definition at line 78 of file EntityFusionMethod.h.

◆ initEntity()

EntityBasePtr initEntity ( const EntityBasePtr &  updateEntity,
const ::Ice::Current &  = Ice::emptyCurrent 
)
inlineoverride

Initialization of an entity.

Implement this method in order to add attributes which are fusion method specific, if you need it. The default implementation just returns the updateEntity.

Parameters
updateEntityentity to be initilialized
Returns
initialized entity

Definition at line 64 of file EntityFusionMethod.h.

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