nx_metadata_sdk  1.0
Metadata SDK
Classes | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
nx::sdk::analytics::IAction Class Referenceabstract

#include <i_action.h>

Inheritance diagram for nx::sdk::analytics::IAction:
nx::sdk::Interface< IAction > nx::sdk::IRefCountable

Classes

struct  Result
 

Public Member Functions

virtual const char * actionId () const =0
 
Uuid objectTrackId () const
 
Uuid deviceId () const
 
Ptr< IObjectTrackInfoobjectTrackInfo () const
 
virtual int64_t timestampUs () const =0
 
Ptr< const IStringMapparams () const
 
- Public Member Functions inherited from nx::sdk::Interface< IAction >
virtual IRefCountablequeryInterface (const InterfaceId *id)
 
Ptr< InterfacequeryInterface ()
 
Ptr< const InterfacequeryInterface () const
 
- Public Member Functions inherited from nx::sdk::IRefCountable
virtual ~IRefCountable ()=default
 
template<class Interface >
Ptr< InterfacequeryInterface ()
 
template<class Interface >
Ptr< const InterfacequeryInterface () const
 
virtual int addRef () const =0
 
virtual int releaseRef () const =0
 
int refCountThreadUnsafe () const
 

Static Public Member Functions

static auto interfaceId ()
 
- Static Public Member Functions inherited from nx::sdk::IRefCountable
static auto interfaceId ()
 

Protected Member Functions

virtual void getObjectTrackId (Uuid *outValue) const =0
 
virtual void getDeviceId (Uuid *outValue) const =0
 
virtual IObjectTrackInfogetObjectTrackInfo () const =0
 
virtual const IStringMapgetParams () const =0
 
- Protected Member Functions inherited from nx::sdk::Interface< IAction >
virtual IRefCountablequeryInterface (const IRefCountable::InterfaceId *id) override
 
IRefCountablequeryInterfaceSupportingDeprecatedId (const IRefCountable::InterfaceId *id, const Uuid &deprecatedInterfaceId)
 

Additional Inherited Members

- Static Protected Member Functions inherited from nx::sdk::IRefCountable
template<int len>
static constexpr const InterfaceIdmakeId (const char(&charArray)[len])
 
template<class TemplateInstance , class TemplateArg , int len>
static const InterfaceIdmakeIdForTemplate (const char(&baseIdCharArray)[len])
 

Detailed Description

Data supplied to IEngine::executeAction().

Member Function Documentation

◆ actionId()

virtual const char* nx::sdk::analytics::IAction::actionId ( ) const
pure virtual

Id of the action being triggered.

◆ getDeviceId()

virtual void nx::sdk::analytics::IAction::getDeviceId ( Uuid outValue) const
protectedpure virtual

Id of a device from which the action has been triggered.

◆ getObjectTrackId()

virtual void nx::sdk::analytics::IAction::getObjectTrackId ( Uuid outValue) const
protectedpure virtual

Id of an object track for which the action has been triggered.

◆ getObjectTrackInfo()

virtual IObjectTrackInfo* nx::sdk::analytics::IAction::getObjectTrackInfo ( ) const
protectedpure virtual

Info about an object track this action has been triggered for.

◆ getParams()

virtual const IStringMap* nx::sdk::analytics::IAction::getParams ( ) const
protectedpure virtual

If the Engine manifest defines params for this action type, contains the array of their values after they are filled by the user via Client form. Otherwise, null.

◆ timestampUs()

virtual int64_t nx::sdk::analytics::IAction::timestampUs ( ) const
pure virtual

Timestamp of a video frame from which the action has been triggered.


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