class Core::Session::SessionResult

class Core::Session::SessionResult
  : private Core::_detail::ResultBase< SessionResultReason, SessionResultProperties >

Represents the output an AI inference operation (e.g. detection, recognition, prediction, ...).

Members

Properties

Syntax: public const SessionResultProperties & Properties;

Gets a collection of additional inferencing operation properties.

~SessionResult

Syntax: public ~SessionResult ( ) = default;

Destructs an instance of the SessionResult class.

GetSessionId

Syntax: public inline std::string GetSessionId ( ) const;

Gets the unique id for the Session from which this SessionResult originated.

Returns

The Session Id string.

GetSessionId

Syntax: public template< > inline AI::Core::_detail::enable_if_w_or_string_t< T > GetSessionId ( ) const;

Gets the unique id for the Session from which this SessionResult originated.

Returns

The Session Id string.

GetResultId

Syntax: public inline std::string GetResultId ( ) const;

Gets the unique SessionResult ID for this SessionResult.

Returns

The unique SessionResult Id string.

GetResultId

Syntax: public template< > inline AI::Core::_detail::enable_if_w_or_string_t< T > GetResultId ( ) const;

Gets the unique SessionResult ID for this SessionResult.

Returns

The unique SessionResult Id string.

GetReason

Syntax: public inline SessionResultReason GetReason ( ) const;

Gets the SessionResultReason for generation of this result.

Returns

The session result reason.

GetAssociatedMediaPosition

Syntax: public inline uint64_t GetAssociatedMediaPosition ( ) const;

Gets the Media/Frame/FrameSet position that generated this result. Use the Media Source Reader to retrieve the input.

Returns

The position associated with this result.

GetAssociatedFrameSet

Syntax: public inline std::vector< std::shared_ptr< Input::Frames::Frame > > GetAssociatedFrameSet ( );

Gets the FrameSet associated with this result.

Returns

The FrameSet associated with this result.