EntityInstanceMetadata Struct Reference

Metadata of an entity instance. More...

#include <RobotAPI/libraries/armem/core/base/EntityInstanceBase.h>

Public Member Functions

void access () const
 Called whenever the entity instance this metadata belongs to is accessed (e.g. queried). More...
 
bool operator!= (const EntityInstanceMetadata &other) const
 
bool operator== (const EntityInstanceMetadata &other) const
 
virtual ~EntityInstanceMetadata ()=default
 

Public Attributes

Time arrivedTime = Time::Invalid()
 Time when this value has arrived at the memory. More...
 
float confidence = 1.0
 An optional confidence, may be used for things like decay. More...
 
Time lastAccessedTime = Time::Invalid()
 An optional value indicating the time of last access. More...
 
unsigned long numAccessed = 0
 A counter how often the instance has been accessed. More...
 
Time referencedTime = Time::Invalid()
 Time this instance refers to. More...
 
Time sentTime = Time::Invalid()
 Time when this value was sent to the memory. More...
 

Detailed Description

Metadata of an entity instance.

Definition at line 34 of file EntityInstanceBase.h.

Constructor & Destructor Documentation

◆ ~EntityInstanceMetadata()

virtual ~EntityInstanceMetadata ( )
virtualdefault

Member Function Documentation

◆ access()

void access ( ) const

Called whenever the entity instance this metadata belongs to is accessed (e.g. queried).

Definition at line 6 of file EntityInstanceBase.cpp.

+ Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const EntityInstanceMetadata other) const
inline

Definition at line 68 of file EntityInstanceBase.h.

◆ operator==()

bool operator== ( const EntityInstanceMetadata other) const

Definition at line 12 of file EntityInstanceBase.cpp.

+ Here is the call graph for this function:

Member Data Documentation

◆ arrivedTime

Time arrivedTime = Time::Invalid()

Time when this value has arrived at the memory.

Definition at line 51 of file EntityInstanceBase.h.

◆ confidence

float confidence = 1.0

An optional confidence, may be used for things like decay.

Definition at line 54 of file EntityInstanceBase.h.

◆ lastAccessedTime

Time lastAccessedTime = Time::Invalid()
mutable

An optional value indicating the time of last access.

Definition at line 57 of file EntityInstanceBase.h.

◆ numAccessed

unsigned long numAccessed = 0
mutable

A counter how often the instance has been accessed.

Definition at line 60 of file EntityInstanceBase.h.

◆ referencedTime

Time referencedTime = Time::Invalid()

Time this instance refers to.

For example, the physical time point when an image was captured. If the image is processed, the result should have the same referencedTime as the image.

Definition at line 46 of file EntityInstanceBase.h.

◆ sentTime

Time sentTime = Time::Invalid()

Time when this value was sent to the memory.

Definition at line 49 of file EntityInstanceBase.h.


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