Oac Class Reference

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

+ Inheritance diagram for Oac:

Public Member Functions

OacPtr clone (const Ice::Current &c=Ice::emptyCurrent) const
 
std::vector< std::string > getParameters (const ::Ice::Current &=Ice::emptyCurrent) const override
 
OacPredictionFunctionBasePtr getPredictionFunction (const ::Ice::Current &=Ice::emptyCurrent) const override
 
std::string getStatechartProxyName (const ::Ice::Current &=Ice::emptyCurrent) const override
 
std::string getStateUUID (const ::Ice::Current &=Ice::emptyCurrent) const override
 
OacStatisticalMeasureBasePtr getStatisticalMeasure (const ::Ice::Current &=Ice::emptyCurrent) const override
 
Ice::ObjectPtr ice_clone () const override
 
bool isPlannable (const ::Ice::Current &=Ice::emptyCurrent) const override
 
 Oac (const std::string &name=std::string(), const std::string &id="", const std::string &statechartProxyName="", const std::string &stateUUID="", bool isPlannable=true)
 Constructs a new Oac entity. More...
 
void setParameters (const std::vector< std::string > &parameters, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setPlannable (bool isPlannable, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setPredictionFunction (const ::memoryx::OacPredictionFunctionBasePtr &prediction, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setStatechartProxyName (const std::string &statechartProxyName, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setStateUUID (const std::string &stateUUID, const ::Ice::Current &=Ice::emptyCurrent) override
 
void setStatisticalMeasure (const ::memoryx::OacStatisticalMeasureBasePtr &measure, const ::Ice::Current &=Ice::emptyCurrent) override
 
- Public Member Functions inherited from Entity
void __decRef () override
 
template<typename T >
IceInternal::Handle< TaddWrapper (T *wrapper)
 Add EntityWrapper to entity. More...
 
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. More...
 
bool equals (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equals computes if two Entity instances are equal. More...
 
bool equalsAttributes (const EntityBasePtr &otherEntity, const ::Ice::Current &=Ice::emptyCurrent) const override
 equalsAttributes computes if two Entity instances are equal. More...
 
virtual EntityRefBaseList getAllParentRefs (bool includeMetaEntities=true) const
 Retrieve all parents by traversing the whole hierarchy. More...
 
virtual std::vector< std::string > getAllParentsAsStringList () const
 
EntityAttributeBasePtr getAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve attribute from entity. More...
 
memoryx::NameList getAttributeNames (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve list of all attribute names. More...
 
virtual armarx::VariantPtr getAttributeValue (const ::std::string &attrName) const
 Retrieve value of an attribute from entity. More...
 
virtual EntityRefBaseList getDirectParentRefs () const
 Retrieve parent entity references. More...
 
::std::string getId (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve id of this entity which is an integer in string representation. More...
 
::std::string getName (const ::Ice::Current &=Ice::emptyCurrent) const override
 Retrieve name of this entity. More...
 
template<typename T >
IceInternal::Handle< TgetWrapper ()
 Retrieve EntityWrapper that has previously been added with Entity::addWrapper(). More...
 
bool hasAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) const override
 Check whether this entity has an attribute with the given name. More...
 
Ice::ObjectPtr ice_clone () const override
 
bool isMetaEntity (const ::Ice::Current &=Ice::emptyCurrent) const override
 Indicates whether this entity only contains meta information. More...
 
void putAttribute (const ::memoryx::EntityAttributeBasePtr &attr, const ::Ice::Current &=Ice::emptyCurrent) override
 Store attribute in entity. More...
 
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. More...
 
void removeAttribute (const ::std::string &attrName, const ::Ice::Current &=Ice::emptyCurrent) override
 Remove attribute with given name from entity. More...
 
void serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &=Ice::emptyCurrent) const override
 Subclasses should use serializable attributes and consider these methods final. More...
 
virtual void setDirectParentRefs (const EntityRefBaseList &entityRefs)
 Replace parent entity references. More...
 
void setId (const ::std::string &id, const ::Ice::Current &=Ice::emptyCurrent) override
 Set id of this entity. More...
 
void setMetaEntity (bool isMetaEntity, const ::Ice::Current &=Ice::emptyCurrent) override
 Mark this entity as meta (i.e. More...
 
void setName (const ::std::string &name, const ::Ice::Current &=Ice::emptyCurrent) override
 Set name of this entity. More...
 

Friends

class OacObjectFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from Entity
static EntityPtr CreateGenericEntity ()
 Creates an entity without any convenience getter/setter functions. More...
 
- 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 42 of file Oac.h.

Constructor & Destructor Documentation

◆ Oac()

Oac ( const std::string &  name = std::string(),
const std::string &  id = "",
const std::string &  statechartProxyName = "",
const std::string &  stateUUID = "",
bool  isPlannable = true 
)

Constructs a new Oac entity.

A name needs to be assigned. The id is optional. The Oac can also be associated with a state via UUID and the statechart this state can be found in

Parameters
namefriendly name of the OAC
idoptional id of the OAC
statechartProxyNameoptional statechart proxy name this OAC is associated with
stateUUIDoptional stateUUID this OAC is associated with

Definition at line 30 of file Oac.cpp.

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

Member Function Documentation

◆ clone()

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

Definition at line 117 of file Oac.cpp.

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

◆ getParameters()

std::vector< std::string > getParameters ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 44 of file Oac.cpp.

+ Here is the call graph for this function:

◆ getPredictionFunction()

OacPredictionFunctionBasePtr getPredictionFunction ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 88 of file Oac.cpp.

+ Here is the call graph for this function:

◆ getStatechartProxyName()

std::string getStatechartProxyName ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 58 of file Oac.cpp.

+ Here is the call graph for this function:

◆ getStateUUID()

std::string getStateUUID ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 68 of file Oac.cpp.

+ Here is the call graph for this function:

◆ getStatisticalMeasure()

OacStatisticalMeasureBasePtr getStatisticalMeasure ( const ::Ice::Current &  = Ice::emptyCurrent) const
override

Definition at line 100 of file Oac.cpp.

+ Here is the call graph for this function:

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const
override

Definition at line 112 of file Oac.cpp.

+ Here is the call graph for this function:

◆ isPlannable()

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

Definition at line 78 of file Oac.cpp.

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

◆ setParameters()

void setParameters ( const std::vector< std::string > &  parameters,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 51 of file Oac.cpp.

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

◆ setPlannable()

void setPlannable ( bool  isPlannable,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 83 of file Oac.cpp.

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

◆ setPredictionFunction()

void setPredictionFunction ( const ::memoryx::OacPredictionFunctionBasePtr &  prediction,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 95 of file Oac.cpp.

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

◆ setStatechartProxyName()

void setStatechartProxyName ( const std::string &  statechartProxyName,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 63 of file Oac.cpp.

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

◆ setStateUUID()

void setStateUUID ( const std::string &  stateUUID,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 73 of file Oac.cpp.

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

◆ setStatisticalMeasure()

void setStatisticalMeasure ( const ::memoryx::OacStatisticalMeasureBasePtr &  measure,
const ::Ice::Current &  = Ice::emptyCurrent 
)
override

Definition at line 107 of file Oac.cpp.

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

Friends And Related Function Documentation

◆ OacObjectFactory

friend class OacObjectFactory
friend

Definition at line 44 of file Oac.h.


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