ad_rss
Public Types | Public Member Functions | Public Attributes | List of all members
ad::rss::core::RssCheck Class Reference

RssCheck. More...

#include <ad/rss/core/RssCheck.hpp>

Collaboration diagram for ad::rss::core::RssCheck:
Collaboration graph
[legend]

Public Types

typedef std::shared_ptr< RssCheckPtr
 Smart pointer on RssCheck.
 
typedef std::shared_ptr< RssCheck const > ConstPtr
 Smart pointer on constant RssCheck.
 

Public Member Functions

 RssCheck ()=default
 constructor
 
 RssCheck (RssCheck const &other)=default
 default copy constructor
 
 ~RssCheck ()=default
 destructor
 
RssCheckoperator= (RssCheck const &other)=default
 default assignment operator
 
bool calculateProperResponse (world::WorldModel const &worldModel, state::ProperResponse &properResponse)
 calculateProperResponse More...
 
bool calculateProperResponse (world::WorldModel const &worldModel, RssSituationSnapshot &situationSnapshot, state::RssStateSnapshot &rssStateSnapshot, state::ProperResponse &properResponse)
 calculateProperResponse More...
 
void registerCalculateTrajectorySetsCallback (world::ObjectType objectType, unstructured::RssUnstructuredConstellationChecker::CalculateTrajectorySetsCallbackFunctionType calculateTrajectorySetsCallback)
 Register a callback for unstructured trajectory set calculation. More...
 
void dropObjectHistory (world::ObjectId const &object_id)
 drop the history associated with a given object_id More...
 

Public Attributes

RssResponseResolving mResponseResolving
 RssResponseResolving member.
 
RssSituationChecking mSituationChecking
 RssSituationChecking member.
 
RssSituationExtraction mSituationExtraction
 RssSituationExtraction member.
 

Detailed Description

RssCheck.

Class providing the functionality of the RSS check sequence at once with the RSS world model as input and the proper response as output. This class internally makes use of the RssSituationExtraction, RssSituationChecking, RssResponseResolving functionality.

Member Function Documentation

◆ calculateProperResponse() [1/2]

bool ad::rss::core::RssCheck::calculateProperResponse ( world::WorldModel const &  worldModel,
RssSituationSnapshot situationSnapshot,
state::RssStateSnapshot rssStateSnapshot,
state::ProperResponse properResponse 
)

calculateProperResponse

Parameters
[in]worldModel- the current world model information
[out]situationSnapshot- The intermediate situation snapshot
[out]rssStateSnapshot- The intermediate rss state snapshot
[out]properResponse- The intermediate proper response
Returns
return true if the proper response could be calculated, false otherwise.

◆ calculateProperResponse() [2/2]

bool ad::rss::core::RssCheck::calculateProperResponse ( world::WorldModel const &  worldModel,
state::ProperResponse properResponse 
)

calculateProperResponse

Parameters
[in]worldModel- the current world model information
[out]accelerationRestriction- The proper response to become RSS safe.
Returns
return true if the proper response could be calculated, false otherwise.

◆ dropObjectHistory()

void ad::rss::core::RssCheck::dropObjectHistory ( world::ObjectId const &  object_id)

drop the history 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 previous history should be dropped

◆ registerCalculateTrajectorySetsCallback()

void ad::rss::core::RssCheck::registerCalculateTrajectorySetsCallback ( world::ObjectType  objectType,
unstructured::RssUnstructuredConstellationChecker::CalculateTrajectorySetsCallbackFunctionType  calculateTrajectorySetsCallback 
)

Register a callback for unstructured trajectory set calculation.

Parameters
[in]objectTypeThe object type this trajectory set calculation should be applied
[in]calculateTrajectorySetsCallbackThe actual callback function to perform the trajectory set calculation

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