Skip to content

cvedia::rt::iface::Tripwire

Inherits from ModuleImpl, Module

Public Functions

Name
Tripwire(std::string const & moduleName)
virtual NODISCARD expected< std::string > createTripwire(std::string const & name, std::string const & group, std::vector< Point2f > const & shape, std::array< float, 4 > const & color, std::string direction ="Both") =0
virtual NODISCARD expected< void > registerKnownTripwires(bool skipRecalculate =false) =0
virtual NODISCARD expected< void > processTripwires(std::map< std::string, std::vector< Point2f > > const & points, cmap const & options ={}) =0
virtual NODISCARD expected< void > processTripwires(std::map< std::string, std::vector< Point2f > > const & points, std::vector< std::string > const & tripwiresFilter, cmap const & options ={}) =0
virtual NODISCARD expected< void > processTripwires(std::map< std::string, std::vector< Point2f > > const & points, std::string const & groupFilter, cmap const & options ={}) =0
virtual NODISCARD expected< void > registerCallback(sol::protected_function callback) =0
virtual NODISCARD expected< void > unregisterCallback() =0
virtual bool hasTripwireId(std::string const & tripwireId) =0
virtual NODISCARD expected< std::vector< std::string > > getTripwireIds() =0
virtual NODISCARD expected< pCValue > getTripwireById(std::string tripwireId, int dictType =DICT_STATE) =0
virtual NODISCARD expected< cmap > getTripwires(int dictType =DICT_STATE) =0
virtual NODISCARD expected< pCValue > getTripwireValue(std::string const & tripwireId, std::string const & key, int dictType =DICT_STATE) =0
virtual NODISCARD expected< cvec > getTripwireValue(std::string const & tripwireId, std::vector< std::string > const & keys, int dictType =DICT_STATE) =0
virtual NODISCARD expected< void > setTripwireValue(std::string const & tripwireId, std::string const & key, pCValue const & value, int dictType =DICT_STATE) =0
virtual NODISCARD expected< void > setTripwireValue(std::string const & tripwireId, cmap const & values, int dictType =DICT_STATE) =0
virtual NODISCARD expected< void > recalculateTripwire(std::string const & tripwireId) =0
virtual NODISCARD expected< void > recalculateTripwires() =0
virtual NODISCARD expected< void > deleteTripwireById(std::string const & tripwireId) =0
virtual NODISCARD expected< void > resetTripwires() =0
virtual NODISCARD expected< void > deleteTripwires() =0
virtual NODISCARD expected< cvec > getTripwireEvents() =0

Additional inherited members

Public Functions inherited from ModuleImpl

Name
ModuleImpl(std::string moduleName)
virtual void * getPtr() override
virtual void verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) override
virtual pCValue getConfigSpecs() const override
virtual std::string const & getName() const override
virtual void setName(std::string const & name) override
virtual void setParent(iface::Module * parent) override
virtual iface::Module * getParent() const override
virtual expected< pCValue > getValue(std::string const & key, int dictType) const override
virtual expected< cvec > getValue(std::vector< std::string > const & keys, int dictType) const override
virtual expected< void > setValue(std::string const & key, pCValue const & value, int dictType) override
virtual expected< void > setValue(cmap const & values, int dictType) override
expected< void > unsetKey(std::string const & key, int const dictType)
virtual expected< std::unique_ptr< iface::CVDictRoot > > getStateDict() const override
virtual expected< std::unique_ptr< iface::CVDictRoot > > getConfigDict() const override
virtual expected< void > setConfig(pCValue const & conf) const override
virtual std::string getRootNode() const override

Public Attributes inherited from ModuleImpl

Name
std::shared_mutex pluginMut_

Public Functions inherited from Module

Name
Module() =default
virtual ~Module() =default
Module(Module const & other) =default
Module & operator=(Module const & other) =default
Module(Module && other) =default
Module & operator=(Module && other) =default
virtual void * getPtr() =0
virtual void verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) =0
virtual pCValue getConfigSpecs() const =0
virtual std::map< std::string, std::shared_ptr< ConfigDescriptor > > getConfigDescriptors() const
virtual std::string const & getName() const =0
virtual void setName(std::string const & name) =0
virtual void stop()
virtual void setParent(iface::Module * ) =0
virtual iface::Module * getParent() const =0
virtual expected< pCValue > getValue(std::string const & key, int dictType) const =0
virtual expected< cvec > getValue(std::vector< std::string > const & keys, int dictType) const =0
virtual expected< void > setValue(std::string const & key, pCValue const & value, int dictType) =0
virtual expected< void > setValue(cmap const & values, int dictType) =0
virtual expected< std::unique_ptr< iface::CVDictRoot > > getStateDict() const =0
virtual expected< std::unique_ptr< iface::CVDictRoot > > getConfigDict() const =0
virtual expected< void > setConfig(pCValue const & conf) const =0
virtual std::string getRootNode() const =0

Public Functions Documentation

function Tripwire

inline Tripwire(
    std::string const & moduleName
)

function createTripwire

virtual NODISCARD expected< std::string > createTripwire(
    std::string const & name,
    std::string const & group,
    std::vector< Point2f > const & shape,
    std::array< float, 4 > const & color,
    std::string direction ="Both"
) =0

Tripwire API

function registerKnownTripwires

virtual NODISCARD expected< void > registerKnownTripwires(
    bool skipRecalculate =false
) =0

function processTripwires

virtual NODISCARD expected< void > processTripwires(
    std::map< std::string, std::vector< Point2f > > const & points,
    cmap const & options ={}
) =0

function processTripwires

virtual NODISCARD expected< void > processTripwires(
    std::map< std::string, std::vector< Point2f > > const & points,
    std::vector< std::string > const & tripwiresFilter,
    cmap const & options ={}
) =0

function processTripwires

virtual NODISCARD expected< void > processTripwires(
    std::map< std::string, std::vector< Point2f > > const & points,
    std::string const & groupFilter,
    cmap const & options ={}
) =0

function registerCallback

virtual NODISCARD expected< void > registerCallback(
    sol::protected_function callback
) =0

function unregisterCallback

virtual NODISCARD expected< void > unregisterCallback() =0

function hasTripwireId

virtual bool hasTripwireId(
    std::string const & tripwireId
) =0

function getTripwireIds

virtual NODISCARD expected< std::vector< std::string > > getTripwireIds() =0

function getTripwireById

virtual NODISCARD expected< pCValue > getTripwireById(
    std::string tripwireId,
    int dictType =DICT_STATE
) =0

function getTripwires

virtual NODISCARD expected< cmap > getTripwires(
    int dictType =DICT_STATE
) =0

function getTripwireValue

virtual NODISCARD expected< pCValue > getTripwireValue(
    std::string const & tripwireId,
    std::string const & key,
    int dictType =DICT_STATE
) =0

function getTripwireValue

virtual NODISCARD expected< cvec > getTripwireValue(
    std::string const & tripwireId,
    std::vector< std::string > const & keys,
    int dictType =DICT_STATE
) =0

function setTripwireValue

virtual NODISCARD expected< void > setTripwireValue(
    std::string const & tripwireId,
    std::string const & key,
    pCValue const & value,
    int dictType =DICT_STATE
) =0

function setTripwireValue

virtual NODISCARD expected< void > setTripwireValue(
    std::string const & tripwireId,
    cmap const & values,
    int dictType =DICT_STATE
) =0

function recalculateTripwire

virtual NODISCARD expected< void > recalculateTripwire(
    std::string const & tripwireId
) =0

function recalculateTripwires

virtual NODISCARD expected< void > recalculateTripwires() =0

function deleteTripwireById

virtual NODISCARD expected< void > deleteTripwireById(
    std::string const & tripwireId
) =0

function resetTripwires

virtual NODISCARD expected< void > resetTripwires() =0

function deleteTripwires

virtual NODISCARD expected< void > deleteTripwires() =0

function getTripwireEvents

virtual NODISCARD expected< cvec > getTripwireEvents() =0