List of all members | Public Member Functions
ObjectInstanceMemorySegment Class Reference

#include <MemoryX/libraries/memorytypes/segment/ObjectInstanceMemorySegment/ObjectInstanceMemorySegment.h>

+ Inheritance diagram for ObjectInstanceMemorySegment:

Public Member Functions

std::string addObjectInstance (const std::string &instanceName, const std::string &className, const armarx::LinkedPoseBasePtr &objectPose, const ::memoryx::MotionModelInterfacePtr &motionModel, const ::Ice::Current &=Ice::emptyCurrent) override
 
ObjectInstanceBasePtr getCorrespondingObjectInstance (const ObjectInstanceBasePtr &objectInstance, const ::Ice::Current &=Ice::emptyCurrent) const override
 
ObjectInstanceBasePtr getObjectInstanceById (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) const override
 
ObjectInstanceBasePtr getObjectInstanceByName (const ::std::string &name, const ::Ice::Current &=Ice::emptyCurrent) const override
 
ObjectInstanceList getObjectInstancesByClass (const ::std::string &className, const ::Ice::Current &c=Ice::emptyCurrent) const override
 
ObjectInstanceList getObjectInstancesByClassList (const NameList &classList, const ::Ice::Current &=Ice::emptyCurrent) const override
 
 ObjectInstanceMemorySegment (float matchThreshold, bool matchByClass)
 
void setNewMotionModel (const ::std::string &entityId, const ::memoryx::MotionModelInterfacePtr &newMotionModel, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setObjectPose (const std::string &entityId, const armarx::LinkedPoseBasePtr &objectPose, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setObjectPoseWithoutMotionModel (const std::string &entityId, const armarx::FramedPoseBasePtr &objectPose, const ::Ice::Current &=Ice::emptyCurrent) override
 
void updateEntity (const std::string &entityId, const EntityBasePtr &update, const ::Ice::Current &=Ice::emptyCurrent) override
 
void updateEntityInternal (const std::string &entityId, const EntityBasePtr &update, const ::Ice::Current &c=Ice::emptyCurrent)
 
void updateEntityInternal (const std::string &entityId, const EntityBasePtr &update, const Ice::StringSeq &deactivatedFusionMethods)
 
- Public Member Functions inherited from WorkingMemoryEntitySegment< ObjectInstance >
std::string addEntity (const EntityBasePtr &entity, const ::Ice::Current &c=Ice::emptyCurrent) override
 addEntity addes an entity to this segment. The registered fusion methods are applied in order to fuse the entity entry. More...
 
EntityIdList addEntityList (const EntityBaseList &entityList, const ::Ice::Current &c) override
 
void addFusionMethod (const ::memoryx::EntityFusionMethodBasePtr &fusionMethod, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void clear (const ::Ice::Current &c=Ice::emptyCurrent) override
 
EntityBaseList getAllEntities (const Ice::Current &c=Ice::emptyCurrent) const override
 
EntityIdList getAllEntityIds (const Ice::Current &c=Ice::emptyCurrent) const override
 
EntityBaseList getEntitiesByAttrValue (const ::std::string &attrName, const ::std::string &attrValue) const
 
EntityBaseList getEntitiesByAttrValue (const ::std::string &attrName, const ::std::string &attrValue, const ::Ice::Current &c) const override
 
EntityBaseList getEntitiesByAttrValueList (const ::std::string &attrName, const NameList &attrValueList) const
 
EntityBaseList getEntitiesByAttrValueList (const ::std::string &attrName, const NameList &attrValueList, const ::Ice::Current &c) const override
 
EntityBasePtr getEntityById (const ::std::string &id) const
 
EntityBasePtr getEntityById (const ::std::string &id, const ::Ice::Current &c) const override
 
EntityBasePtr getEntityByName (const ::std::string &name) const
 
EntityBasePtr getEntityByName (const ::std::string &name, const ::Ice::Current &c) const override
 
EntityRefBasePtr getEntityRefById (const std::string &id, const Ice::Current &c) const override
 
EntityRefBasePtr getEntityRefByName (const std::string &name, const Ice::Current &c) const override
 
Ice::Identity getIceId (const ::Ice::Current &c) const override
 
IdEntityMap getIdEntityMap (const Ice::Current &c=Ice::emptyCurrent) const override
 
WorkingMemoryListenerInterfacePrx getListenerProxy (const ::Ice::Current &c=Ice::emptyCurrent) override
 getListener The topic on which changes are reported. More...
 
std::string getObjectTypeId (const ::Ice::Current &c=Ice::emptyCurrent) const override
 getObjectTypeId returns the ice_staticId() of the entities stored inside this WorkingMemorySegment More...
 
std::string getSegmentName (const ::Ice::Current &c=Ice::emptyCurrent) const override
 
bool hasEntityById (const std::string &entityId, const ::Ice::Current &c) const override
 
bool hasEntityByName (const std::string &entityName, const ::Ice::Current &c) const override
 
void print (const ::Ice::Current &c=Ice::emptyCurrent) const override
 
void removeAllEntities (const ::Ice::Current &c=Ice::emptyCurrent) override
 
void removeEntity (const ::std::string &id, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void setEntityAttribute (const std::string &entityId, const EntityAttributeBasePtr &attribute, const ::Ice::Current &c) override
 
void setEntityAttributes (const std::string &entityId, const EntityAttributeList &attributeMap, const ::Ice::Current &c) override
 
Ice::Int size (const ::Ice::Current &c=Ice::emptyCurrent) const override
 
void updateEntity (const std::string &entityId, const EntityBasePtr &update, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void updateEntity (const std::string &entityId, const EntityBasePtr &update, const Ice::StringSeq &deactivatedFusionMethods, const ::Ice::Current &c=Ice::emptyCurrent)
 
std::string upsertEntity (const std::string &entityId, const EntityBasePtr &newEntity, const ::Ice::Current &c=Ice::emptyCurrent) override
 
std::string upsertEntityByName (const std::string &entityName, const EntityBasePtr &newEntity, const ::Ice::Current &c=Ice::emptyCurrent) override
 
EntityIdList upsertEntityList (const EntityBaseList &entityList, const ::Ice::Current &c) override
 
 WorkingMemoryEntitySegment ()
 
- Public Member Functions inherited from SegmentUtilImplementations
EntityBaseList getEntityWithChildrenById (const std::string &id, bool includeMetaEntities, const Ice::Current &c=Ice::emptyCurrent) const override
 
EntityBaseList getEntityWithChildrenByName (const std::string &, bool includeMetaEntities, const Ice::Current &c=Ice::emptyCurrent) const override
 
std::string getJSONEntityById (const std::string &id, const Ice::Current &) const override
 
ScopedSharedLockPtr getReadLock (const Ice::Current &c) const
 
ScopedUniqueLockPtr getWriteLock (const Ice::Current &c) const
 
bool keepLockAlive (const std::string &token, const Ice::Current &) override
 
SegmentLockBasePtr lockSegment (const Ice::Current &c) override
 
 SegmentUtilImplementations ()
 
bool unlockSegment (const SegmentLockBasePtr &lock, const Ice::Current &c) override
 
bool unlockSegmentWithToken (const std::string &token, const Ice::Current &c) override
 

Additional Inherited Members

- Public Types inherited from SegmentUtilImplementations
using ScopedSharedLock = std::unique_lock< std::shared_mutex >
 
using ScopedSharedLockPtr = std::unique_ptr< ScopedSharedLock >
 
using ScopedUniqueLock = std::unique_lock< std::shared_mutex >
 
using ScopedUniqueLockPtr = std::unique_ptr< ScopedSharedLock >
 
- Protected Member Functions inherited from WorkingMemoryEntitySegment< ObjectInstance >
std::string addEntityThreadUnsafe (const EntityBasePtr &newEntity)
 adds the entity to the segment. More...
 
void fuseEntity (const EntityBasePtr &entity)
 
EntityBasePtr getEntityByIdUnsafe (const ::std::string &id) const
 
EntityBasePtr getEntityByNameThreadUnsafe (const ::std::string &name) const
 
bool hasEntityByIdThreadUnsafe (const std::string &entityId) const
 
void setListenerProxy (const WorkingMemoryListenerInterfacePrx &listenerProxy, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void setParentMemory (const MemoryInterfacePtr &memory, const ::Ice::Current &c) override
 
void setSegmentName (const std::string &segmentName, const ::Ice::Current &c=Ice::emptyCurrent) override
 
void updateEntityThreadUnsafe (const std::string &entityId, const EntityBasePtr &update, const Ice::StringSeq &deactivatedFusionMethods)
 
- Protected Member Functions inherited from SegmentUtilImplementations
void keepAliveCheck ()
 
- Protected Attributes inherited from WorkingMemoryEntitySegment< ObjectInstance >
IdEntityMap entityMap
 
EntityFusionMethodPtr fusionMethod
 
int lastEntityId
 
MemoryInterfacePtr parentMemory
 
std::string segmentName
 
- Protected Attributes inherited from SegmentUtilImplementations
armarx::PeriodicTask< SegmentUtilImplementations >::pointer_type keepAliveCheckTask
 
IceUtil::Time keepAliveTimestamp
 
std::mutex keepAliveTimestampMutex
 
std::string lockToken
 
std::mutex mutex
 
ScopedSharedLockPtr readLock
 
std::shared_mutex segmentMutex
 
EntityMemorySegmentInterfacePrx selfProxy
 
std::mutex tokenMutex
 
ScopedUniqueLockPtr writeLock
 

Detailed Description

The ObjectInstanceMemorySegment is a specialization of the WorkingMemoryEntitySegment template.

See also
WorkingMemoryEntitySegment

Definition at line 43 of file ObjectInstanceMemorySegment.h.

Constructor & Destructor Documentation

◆ ObjectInstanceMemorySegment()

ObjectInstanceMemorySegment ( float  matchThreshold,
bool  matchByClass 
)

Definition at line 36 of file ObjectInstanceMemorySegment.cpp.

Member Function Documentation

◆ addObjectInstance()

std::string addObjectInstance ( const std::string &  instanceName,
const std::string &  className,
const armarx::LinkedPoseBasePtr &  objectPose,
const ::memoryx::MotionModelInterfacePtr &  motionModel,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 297 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ getCorrespondingObjectInstance()

ObjectInstanceBasePtr getCorrespondingObjectInstance ( const ObjectInstanceBasePtr &  objectInstance,
const ::Ice::Current &  c = Ice::emptyCurrent 
) const
override

Definition at line 98 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ getObjectInstanceById()

ObjectInstanceBasePtr getObjectInstanceById ( const ::std::string &  id,
const ::Ice::Current &  = Ice::emptyCurrent 
) const
override

Definition at line 44 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ getObjectInstanceByName()

ObjectInstanceBasePtr getObjectInstanceByName ( const ::std::string &  name,
const ::Ice::Current &  = Ice::emptyCurrent 
) const
override

Definition at line 56 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ getObjectInstancesByClass()

ObjectInstanceList getObjectInstancesByClass ( const ::std::string &  className,
const ::Ice::Current &  c = Ice::emptyCurrent 
) const
override

Definition at line 68 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ getObjectInstancesByClassList()

ObjectInstanceList getObjectInstancesByClassList ( const NameList &  classList,
const ::Ice::Current &  c = Ice::emptyCurrent 
) const
override

Definition at line 75 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setNewMotionModel()

void setNewMotionModel ( const ::std::string &  entityId,
const ::memoryx::MotionModelInterfacePtr &  newMotionModel,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 194 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ setObjectPose()

void setObjectPose ( const std::string &  entityId,
const armarx::LinkedPoseBasePtr &  objectPose,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 245 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ setObjectPoseWithoutMotionModel()

void setObjectPoseWithoutMotionModel ( const std::string &  entityId,
const armarx::FramedPoseBasePtr &  objectPose,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 272 of file ObjectInstanceMemorySegment.cpp.

+ Here is the call graph for this function:

◆ updateEntity()

void updateEntity ( const std::string &  entityId,
const EntityBasePtr &  update,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 319 of file ObjectInstanceMemorySegment.cpp.

◆ updateEntityInternal() [1/2]

void updateEntityInternal ( const std::string &  entityId,
const EntityBasePtr &  update,
const ::Ice::Current &  c = Ice::emptyCurrent 
)
inline

Definition at line 80 of file ObjectInstanceMemorySegment.h.

+ Here is the call graph for this function:

◆ updateEntityInternal() [2/2]

void updateEntityInternal ( const std::string &  entityId,
const EntityBasePtr &  update,
const Ice::StringSeq &  deactivatedFusionMethods 
)
inline

Definition at line 86 of file ObjectInstanceMemorySegment.h.

+ Here is the call graph for this function:
The documentation for this class was generated from the following files: