class Core::Session::VisionSession
class Core::Session::VisionSession
: public std::enable_shared_from_this< VisionSession >
Представляет набор возможностей визуального распознавания, используемых в течение конечного периода времени, с заданным набором конфигурации, входных данных и параметров.
Элементы
SessionStarted
Синтаксис: public Core::EventSignal< const SessionStartedEventArgs & > SessionStarted;
Сигнал для событий, указывающих на начало сеанса распознавания (операции).
SessionStopped
Синтаксис: public Core::EventSignal< const SessionStoppedEventArgs & > SessionStopped;
Сигнал для событий, указывающих на окончание сеанса распознавания (операции).
Признанных
Синтаксис: public Core::EventSignal< const SessionResultEventArgs & > Recognized;
Сигнал для событий, содержащих операции распознавания.
Свойства
Синтаксис: public Session::VisionSessionProperties & Properties;
Возвращает коллекцию дополнительных свойств операции вывода.
~VisionSession
Синтаксис: public inline virtual ~VisionSession ( );
Уничтожает экземпляр класса VisionSession.
GetSessionId
Синтаксис: public inline std::string GetSessionId ( ) const;
Возвращает уникальный идентификатор сеанса, из которого возникла эта функция VisionSession.
Возвращаемое значение
Строка идентификатора сеанса.
GetSessionId
Синтаксис: public template< > inline AI::Core::_detail::enable_if_w_or_string_t< T > GetSessionId ( ) const;
Возвращает уникальный идентификатор сеанса, из которого возникла эта функция VisionSession.
Возвращаемое значение
Строка идентификатора сеанса.
RecognizeOnce
Синтаксис: public inline std::shared_ptr< SessionResult > RecognizeOnce ( );
Распознать один SessionResult из входных данных.
Возвращаемое значение
Созданный sessionResult, заключенный в оболочку std::shared_ptr
RecognizeOnceAsync
Синтаксис: public inline std::future< std::shared_ptr< SessionResult > > RecognizeOnceAsync ( );
Распознать один SessionResult из входных данных асинхронно.
Возвращаемое значение
Будущий SessionResult, заключенный в оболочку std::future<std::shared_ptr<>>
StartContinuousRecognition
Синтаксис: public inline void StartContinuousRecognition ( );
Начинает непрерывное распознавание результатов из входных данных.
StartContinuousRecognitionAsync
Синтаксис: public inline std::future< void > StartContinuousRecognitionAsync ( );
Начинает непрерывное распознавание результатов из входных данных.
Возвращаемое значение
Объект , std::future<void>
который должен быть завершен после запуска непрерывного распознавания
StopContinuousRecognition
Синтаксис: public inline void StopContinuousRecognition ( );
Прекращает распознавание результатов из входных данных.
StopContinuousRecognitionAsync
Синтаксис: public inline std::future< void > StopContinuousRecognitionAsync ( );
Останавливает распознавание результатов из входных данных в асинхронном режиме.
Возвращаемое значение
Объект , std::future<void>
который должен быть завершен после остановки непрерывного распознавания
WaitForStop
Синтаксис: public inline bool WaitForStop ( );
Ожидает остановки распознавания.
Возвращаемое значение
True, если сеанс остановлен, false, если не остановлен после, время ожидания по умолчанию
WaitForStop не инициирует остановку. Вызов stopContinuousRecognition или аналогичное для запуска остановки
WaitForStop
Синтаксис: public inline bool WaitForStop ( const std::chrono::milliseconds & timeout );
Ожидает остановки распознавания.
Параметры
timeout
Время ожидания в миллисекундах
Возвращаемое значение
True, если сеанс остановлен, false, если он не был остановлен после истечения времени ожидания
WaitForStop не инициирует остановку. Вызов stopContinuousRecognition или аналогичное для запуска остановки
WaitForStopAsync
Синтаксис: public inline std::future< void > WaitForStopAsync ( );
Ожидает остановки распознавания.
Возвращаемое значение
std::future<void>
представляет остановку сеанса
WaitForStop не инициирует остановку. Вызов stopContinuousRecognition или аналогичное для запуска остановки
Создать
Синтаксис: public template< > inline static std::shared_ptr< VisionSession > Create ( const std::shared_ptr< TConfigOptions > & visionConfigOptions , const std::shared_ptr< Input::VisionSource > & input , const std::shared_ptr< VisionSessionOptions > & sessionOptions );
Инициализирует новый экземпляр класса VisionSession.
Параметры
visionConfigOptions
Параметры конфигурации визуального распознавания (служба или внедренная система).input
Источник визуального представления.sessionOptions
Параметры сеанса визуального распознавания.
Возвращаемое значение
Вновь созданное VisionSession, завернутое в std::shared_ptr
m_properties
Синтаксис: protected AI::Core::_detail::PropertyCollection< Session::VisionSessionProperties > m_properties;