Conscience Core
Classes | Public Member Functions | Public Attributes | List of all members
conscience_core::ai::CscEntityReflexionDetectionParameters Class Reference

#include <CscEntityReflexion.h>

Classes

struct  DetectionNotificationParameters
 

Public Member Functions

 CscEntityReflexionDetectionParameters (const vector< ConscienceDetectorType > &detectors={}, const vector< ptr< const CscAlertIdentificationConfig >> &alerts={}, const vector< CscDetectionStatsType > &stats={}, bool shouldFocusDetections=false, const optional< DetectionNotificationParameters > &notificationParameters={}, bool locateInSimulator=true, const map< string, string > &additionalParams={}, CscDetectorEngine *detector=nullptr)
 
bool isNotificationEnabled () const
 
bool isStop () const
 
bool shouldVisionBeEnabled () const
 
bool doesAlertTypeNeedVision (CscAlertType alertType) const
 
 operator string () const
 
string toString () const
 

Public Attributes

const vector< ConscienceDetectorTypedetectors
 
const vector< ptr< const CscAlertIdentificationConfig > > alerts
 
const vector< CscDetectionStatsTypestats
 
const bool shouldFocusDetections
 
const optional< DetectionNotificationParametersnotificationParameters
 
const bool locateInSimulator
 
const optional< bool > waitForFirstResult
 
CscDetectorEngine *const detector = nullptr
 
const map< string, string > additionalParams
 

Constructor & Destructor Documentation

◆ CscEntityReflexionDetectionParameters()

conscience_core::ai::CscEntityReflexionDetectionParameters::CscEntityReflexionDetectionParameters ( const vector< ConscienceDetectorType > &  detectors = {},
const vector< ptr< const CscAlertIdentificationConfig >> &  alerts = {},
const vector< CscDetectionStatsType > &  stats = {},
bool  shouldFocusDetections = false,
const optional< DetectionNotificationParameters > &  notificationParameters = {},
bool  locateInSimulator = true,
const map< string, string > &  additionalParams = {},
CscDetectorEngine detector = nullptr 
)

Create detection parameters for an entity.

Parameters
detectorsspecifies a list of detector types to be enabled
alertsspecifies a list of alerts to identify, which will cause some detectors to be enabled
detectorif provided, detectors param is ignored. Useful if you want to force used detector. IMPORTANT : pointer will be deleted on stop
shouldFocusDetectionsif true, entity will focus closest detected object
locateInSimulatorcontrols if object position is relative to camera or not

Member Function Documentation

◆ doesAlertTypeNeedVision()

bool conscience_core::ai::CscEntityReflexionDetectionParameters::doesAlertTypeNeedVision ( CscAlertType  alertType) const

◆ isNotificationEnabled()

bool conscience_core::ai::CscEntityReflexionDetectionParameters::isNotificationEnabled ( ) const

◆ isStop()

bool conscience_core::ai::CscEntityReflexionDetectionParameters::isStop ( ) const

check if those parameters will STOP detection (no detection, no alerts, no stats)

◆ operator string()

conscience_core::ai::CscEntityReflexionDetectionParameters::operator string ( ) const

◆ shouldVisionBeEnabled()

bool conscience_core::ai::CscEntityReflexionDetectionParameters::shouldVisionBeEnabled ( ) const

return true if detectors or alerts require vision (capture engine) to be opened

◆ toString()

string conscience_core::ai::CscEntityReflexionDetectionParameters::toString ( ) const

Member Data Documentation

◆ additionalParams

const map<string, string> conscience_core::ai::CscEntityReflexionDetectionParameters::additionalParams

◆ alerts

const vector<ptr<const CscAlertIdentificationConfig> > conscience_core::ai::CscEntityReflexionDetectionParameters::alerts

Requested alerts NOTE : additional alerts can be generated by some special detector types (Care, Secure) – backward compatibility

◆ detector

CscDetectorEngine* const conscience_core::ai::CscEntityReflexionDetectionParameters::detector = nullptr

◆ detectors

const vector<ConscienceDetectorType> conscience_core::ai::CscEntityReflexionDetectionParameters::detectors

Requested detectors NOTE : additional detectors can be generated by requested alerts

◆ locateInSimulator

const bool conscience_core::ai::CscEntityReflexionDetectionParameters::locateInSimulator

◆ notificationParameters

const optional<DetectionNotificationParameters> conscience_core::ai::CscEntityReflexionDetectionParameters::notificationParameters

◆ shouldFocusDetections

const bool conscience_core::ai::CscEntityReflexionDetectionParameters::shouldFocusDetections

◆ stats

const vector<CscDetectionStatsType> conscience_core::ai::CscEntityReflexionDetectionParameters::stats

Requested stats on detection NOTE : additional stats can be generated by some special detector types (Care, Secure) – backward compatibility

◆ waitForFirstResult

const optional<bool> conscience_core::ai::CscEntityReflexionDetectionParameters::waitForFirstResult

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