List of all members | Public Member Functions | Friends
ObjectClass Class Reference

#include <MemoryX/libraries/memorytypes/entity/ObjectClass.h>

+ Inheritance diagram for ObjectClass:

Public Member Functions

void addParentClass (const ::std::string &className, const ::Ice::Current &=Ice::emptyCurrent) override
 
void clearParentClasses (const ::Ice::Current &=Ice::emptyCurrent) override
 
ObjectClassPtr clone (const Ice::Current &c=Ice::emptyCurrent) const
 
ObjectComparisonResult compare (const ObjectClassBasePtr &other, const Ice::Current &=Ice::emptyCurrent) const override
 
::memoryx::NameList getParentClasses (const ::Ice::Current &=Ice::emptyCurrent) const override
 
EntityAttributeBasePtr getParentClassesAttr () const
 
Ice::ObjectPtr ice_clone () const override
 
bool isInstanceable (const ::Ice::Current &=Ice::emptyCurrent) const override
 
 ObjectClass ()
 
 ObjectClass (const ObjectClass &source)
 
void setInstanceable (bool isInstanceable, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setParentClass (const ::std::string &className, const ::Ice::Current &=Ice::emptyCurrent) override
 
 ~ObjectClass () override
 
- Public Member Functions inherited from Entity
void __decRef () override
 
template<typename T>
IceInternal::Handle< T > addWrapper (T *wrapper)
 Add EntityWrapper to entity.
 
EntityPtr clone (const Ice::Current &c=Ice::emptyCurrent) const
 
void deserialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) override
 Subclasses should use serializable attributes and consider these methods final.
 
bool equals (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equals computes if two Entity instances are equal.
 
bool equalsAttributes (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equalsAttributes computes if two Entity instances are equal.
 
virtual EntityRefBaseList getAllParentRefs (bool includeMetaEntities=true) const
 Retrieve all parents by traversing the whole hierarchy.
 
virtual std::vector< std::string > getAllParentsAsStringList () const
 
EntityAttributeBasePtr getAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve attribute from entity.
 
memoryx::NameList getAttributeNames (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve list of all attribute names.
 
virtual armarx::VariantPtr getAttributeValue (const ::std::string &attrName) const
 Retrieve value of an attribute from entity.
 
virtual EntityRefBaseList getDirectParentRefs () const
 Retrieve parent entity references.
 
::std::string getId (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve id of this entity which is an integer in string representation.
 
::std::string getName (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve name of this entity.
 
template<typename T>
IceInternal::Handle< T > getWrapper ()
 Retrieve EntityWrapper that has previously been added with Entity::addWrapper().
 
bool hasAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Check whether this entity has an attribute with the given name.
 
Ice::ObjectPtr ice_clone () const override
 
bool isMetaEntity (const ::Ice::Current &=Ice::emptyCurrent) const override
 Indicates whether this entity only contains meta information.
 
void putAttribute (const ::memoryx::EntityAttributeBasePtr &attr, const ::Ice::Current &=Ice::emptyCurrent) override
 Store attribute in entity.
 
template<typename T>
void putAttribute (const std::string &attrName, T attrValue, ProbabilityMeasureBasePtr uncertainty=ProbabilityMeasureBasePtr())
 Create and store attribute from name, value, and optionally uncertainty measure.
 
void removeAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) override
 Remove attribute with given name from entity.
 
void serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
 Subclasses should use serializable attributes and consider these methods final.
 
virtual void setDirectParentRefs (const EntityRefBaseList &entityRefs)
 Replace parent entity references.
 
void setId (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) override
 Set id of this entity.
 
void setMetaEntity (bool isMetaEntity, const ::Ice::Current &=Ice::emptyCurrent) override
 Mark this entity as meta (i.e.
 
void setName (const ::std::string &name, const ::Ice::Current &=Ice::emptyCurrent) override
 Set name of this entity.
 

Friends

std::ostream & operator<< (std::ostream &stream, const ObjectClass &rhs)
 
std::ostream & operator<< (std::ostream &stream, const ObjectClassBasePtr &rhs)
 
std::ostream & operator<< (std::ostream &stream, const ObjectClassPtr &rhs)
 

Additional Inherited Members

- Static Public Member Functions inherited from Entity
static EntityPtr CreateGenericEntity ()
 Creates an entity without any convenience getter/setter functions.
 
- Protected Member Functions inherited from Entity
 Entity ()
 
 Entity (const Entity &source)
 
void ice_postUnmarshal () override
 
void ice_preMarshal () override
 
void output (std::ostream &stream) const
 
 ~Entity () override
 
- Protected Attributes inherited from Entity
std::mutex attributesMutex
 
std::shared_mutex entityMutex
 
AbstractEntityWrapperBaseList wrappers
 
std::recursive_mutex wrappersMutex
 

Detailed Description

Definition at line 37 of file ObjectClass.h.

Constructor & Destructor Documentation

◆ ObjectClass() [1/2]

ObjectClass ( )

Definition at line 30 of file ObjectClass.cpp.

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

◆ ObjectClass() [2/2]

ObjectClass ( const ObjectClass & source)

Definition at line 38 of file ObjectClass.cpp.

+ Here is the call graph for this function:

◆ ~ObjectClass()

~ObjectClass ( )
override

Definition at line 47 of file ObjectClass.cpp.

Member Function Documentation

◆ addParentClass()

void addParentClass ( const ::std::string & className,
const ::Ice::Current & = Ice::emptyCurrent )
override

Definition at line 68 of file ObjectClass.cpp.

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

◆ clearParentClasses()

void clearParentClasses ( const ::Ice::Current & = Ice::emptyCurrent)
override

Definition at line 81 of file ObjectClass.cpp.

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

◆ clone()

ObjectClassPtr clone ( const Ice::Current & c = Ice::emptyCurrent) const

Definition at line 133 of file ObjectClass.cpp.

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

◆ compare()

ObjectComparisonResult compare ( const ObjectClassBasePtr & other,
const Ice::Current & = Ice::emptyCurrent ) const
override

Definition at line 144 of file ObjectClass.cpp.

+ Here is the call graph for this function:

◆ getParentClasses()

memoryx::NameList getParentClasses ( const ::Ice::Current & = Ice::emptyCurrent) const
override

Definition at line 53 of file ObjectClass.cpp.

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

◆ getParentClassesAttr()

EntityAttributeBasePtr getParentClassesAttr ( ) const

Definition at line 121 of file ObjectClass.cpp.

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

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const
override

Definition at line 127 of file ObjectClass.cpp.

+ Here is the call graph for this function:

◆ isInstanceable()

bool isInstanceable ( const ::Ice::Current & = Ice::emptyCurrent) const
override

Definition at line 102 of file ObjectClass.cpp.

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

◆ setInstanceable()

void setInstanceable ( bool isInstanceable,
const ::Ice::Current & = Ice::emptyCurrent )
override

Definition at line 87 of file ObjectClass.cpp.

+ Here is the call graph for this function:

◆ setParentClass()

void setParentClass ( const ::std::string & className,
const ::Ice::Current & = Ice::emptyCurrent )
override

Definition at line 74 of file ObjectClass.cpp.

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ operator<< [1/3]

std::ostream & operator<< ( std::ostream & stream,
const ObjectClass & rhs )
friend

Definition at line 66 of file ObjectClass.h.

◆ operator<< [2/3]

std::ostream & operator<< ( std::ostream & stream,
const ObjectClassBasePtr & rhs )
friend

Definition at line 80 of file ObjectClass.h.

◆ operator<< [3/3]

std::ostream & operator<< ( std::ostream & stream,
const ObjectClassPtr & rhs )
friend

Definition at line 73 of file ObjectClass.h.

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