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

Inheritance diagram for WorldStateSegment:

Public Member Functions
ObjectInstanceBasePtr	getWorldInstanceById (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) const override

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

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

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

	WorldStateSegment ()

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

WorldStateSegment stores entities of type ObjectInstance corresponding to environmental entities.

Definition at line 39 of file WorldStateSegment.h.

Constructor & Destructor Documentation

◆ WorldStateSegment()

WorldStateSegment ( )

Definition at line 27 of file WorldStateSegment.cpp.

Member Function Documentation

◆ getWorldInstanceById()

ObjectInstanceBasePtr getWorldInstanceById	(	const ::std::string &	id,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)		const

override

Gets the entity with the given ID.

Parameters

id	Entity ID.

Definition at line 34 of file WorldStateSegment.cpp.

Here is the call graph for this function:

◆ getWorldInstanceByName()

ObjectInstanceBasePtr getWorldInstanceByName	(	const ::std::string &	name,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)		const

override

Gets the entity with the given name.

Parameters

name	Entity name.

Definition at line 46 of file WorldStateSegment.cpp.

Here is the call graph for this function:

◆ getWorldInstancesByClass()

ObjectInstanceList getWorldInstancesByClass	(	const ::std::string &	className,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)		const

override

Gets the entities having the given class.

Parameters

className Class name.

Definition at line 58 of file WorldStateSegment.cpp.

Here is the call graph for this function:

◆ getWorldInstancesByClassList()

ObjectInstanceList getWorldInstancesByClassList	(	const NameList &	classList,
		const ::Ice::Current &	c = `Ice::emptyCurrent`
	)		const

override

Gets the entities having a class in the given class list.

Parameters

classList List of class names.

Definition at line 65 of file WorldStateSegment.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

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

MemoryX/libraries/memorytypes/segment/WorldStateSegment.h
MemoryX/libraries/memorytypes/segment/WorldStateSegment.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WorldStateSegment()

Member Function Documentation

◆ getWorldInstanceById()

◆ getWorldInstanceByName()

◆ getWorldInstancesByClass()

◆ getWorldInstancesByClassList()