ad_rss
Classes | Public Member Functions | List of all members
ad::rss::structured::RssConstellationIdProvider Class Reference

class supporting to keep track of unique constellation ids More...

#include <ad/rss/structured/RssConstellationIdProvider.hpp>

Public Member Functions

 RssConstellationIdProvider ()=default
 default constructor
 
 ~RssConstellationIdProvider ()=default
 default destructor
 
core::RelativeConstellationId getConstellationId (world::TimeIndex const &time_index, world::Constellation const &constellation)
 get the constellation id of the given constellation More...
 
void dropConstellationIds (world::ObjectId const &object_id)
 drop all constallation ids associated with a given object_id More...
 

Detailed Description

class supporting to keep track of unique constellation ids

Constellation id's have to be constant over time.

Member Function Documentation

◆ dropConstellationIds()

void ad::rss::structured::RssConstellationIdProvider::dropConstellationIds ( world::ObjectId const &  object_id)

drop all constallation ids associated with a given object_id

This function might be used to drop previous states referred to a certain object id in case the object id is reused

Parameters
[in]object_idthe object_id all previous constallations should be dropped

◆ getConstellationId()

core::RelativeConstellationId ad::rss::structured::RssConstellationIdProvider::getConstellationId ( world::TimeIndex const &  time_index,
world::Constellation const &  constellation 
)

get the constellation id of the given constellation

Parameters
[in]time_indexthe time index the constellation refers to
[in]constellationthe relevant constellation
Returns
the constellation id assigned to the given constellation

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