cvedia::rt::iface::Zone¶
Inherits from ModuleImpl, Module
Public Functions¶
| Name | |
|---|---|
| Zone(std::string const & moduleName) | |
| virtual NODISCARD expected< std::string > | createZone(std::string const & name, std::string const & group, std::vector< Point2f > const & shape, std::array< float, 4 > const & color) =0 |
| virtual NODISCARD expected< void > | registerKnownZones(bool skipRecalculate =false) =0 |
| virtual NODISCARD expected< void > | deleteZoneById(std::string const & zoneid) =0 |
| virtual NODISCARD expected< void > | registerCallback(sol::protected_function callback) =0 |
| virtual NODISCARD expected< void > | unregisterCallback() =0 |
| virtual NODISCARD expected< void > | processZones(std::map< std::string, std::vector< Point2f > > const & points, cmap const & options ={}) =0 |
| virtual NODISCARD expected< void > | processZones(std::map< std::string, std::vector< Point2f > > const & points, std::vector< std::string > const & zonesFilter, cmap const & options ={}) =0 |
| virtual NODISCARD expected< void > | processZones(std::map< std::string, std::vector< Point2f > > const & points, std::string const & groupFilter, cmap const & options ={}) =0 |
| virtual bool | hasZoneId(std::string const & zoneid) =0 |
| virtual NODISCARD expected< std::vector< std::string > > | getZoneIds() =0 |
| virtual NODISCARD expected< pCValue > | getZoneById(std::string const & zoneid, int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< cmap > | getZones(int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< pCValue > | getZoneValue(std::string const & zoneid, std::string const & key, int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< cvec > | getZoneValue(std::string const & zoneid, std::vector< std::string > const & keys, int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< void > | setZoneValue(std::string const & zoneid, std::string const & key, pCValue const & value, int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< void > | setZoneValue(std::string const & zoneid, cmap const & values, int dictType =DICT_STATE) =0 |
| virtual NODISCARD expected< void > | recalculateZone(std::string const & zoneid) =0 |
| virtual NODISCARD expected< void > | recalculateZones() =0 |
| virtual NODISCARD expected< void > | resetZones() =0 |
| virtual NODISCARD expected< void > | deleteZones() =0 |
| virtual NODISCARD expected< std::vector< std::string > > | isPointInZone(Point2f const & pt) =0 |
| virtual NODISCARD expected< cvec > | getZoneEvents() const =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 Zone¶
inline Zone(
std::string const & moduleName
)
function createZone¶
virtual NODISCARD expected< std::string > createZone(
std::string const & name,
std::string const & group,
std::vector< Point2f > const & shape,
std::array< float, 4 > const & color
) =0
Zone API
function registerKnownZones¶
virtual NODISCARD expected< void > registerKnownZones(
bool skipRecalculate =false
) =0
function deleteZoneById¶
virtual NODISCARD expected< void > deleteZoneById(
std::string const & zoneid
) =0
function registerCallback¶
virtual NODISCARD expected< void > registerCallback(
sol::protected_function callback
) =0
function unregisterCallback¶
virtual NODISCARD expected< void > unregisterCallback() =0
function processZones¶
virtual NODISCARD expected< void > processZones(
std::map< std::string, std::vector< Point2f > > const & points,
cmap const & options ={}
) =0
function processZones¶
virtual NODISCARD expected< void > processZones(
std::map< std::string, std::vector< Point2f > > const & points,
std::vector< std::string > const & zonesFilter,
cmap const & options ={}
) =0
function processZones¶
virtual NODISCARD expected< void > processZones(
std::map< std::string, std::vector< Point2f > > const & points,
std::string const & groupFilter,
cmap const & options ={}
) =0
function hasZoneId¶
virtual bool hasZoneId(
std::string const & zoneid
) =0
function getZoneIds¶
virtual NODISCARD expected< std::vector< std::string > > getZoneIds() =0
function getZoneById¶
virtual NODISCARD expected< pCValue > getZoneById(
std::string const & zoneid,
int dictType =DICT_STATE
) =0
function getZones¶
virtual NODISCARD expected< cmap > getZones(
int dictType =DICT_STATE
) =0
function getZoneValue¶
virtual NODISCARD expected< pCValue > getZoneValue(
std::string const & zoneid,
std::string const & key,
int dictType =DICT_STATE
) =0
function getZoneValue¶
virtual NODISCARD expected< cvec > getZoneValue(
std::string const & zoneid,
std::vector< std::string > const & keys,
int dictType =DICT_STATE
) =0
function setZoneValue¶
virtual NODISCARD expected< void > setZoneValue(
std::string const & zoneid,
std::string const & key,
pCValue const & value,
int dictType =DICT_STATE
) =0
function setZoneValue¶
virtual NODISCARD expected< void > setZoneValue(
std::string const & zoneid,
cmap const & values,
int dictType =DICT_STATE
) =0
function recalculateZone¶
virtual NODISCARD expected< void > recalculateZone(
std::string const & zoneid
) =0
function recalculateZones¶
virtual NODISCARD expected< void > recalculateZones() =0
function resetZones¶
virtual NODISCARD expected< void > resetZones() =0
function deleteZones¶
virtual NODISCARD expected< void > deleteZones() =0
function isPointInZone¶
virtual NODISCARD expected< std::vector< std::string > > isPointInZone(
Point2f const & pt
) =0
function getZoneEvents¶
virtual NODISCARD expected< cvec > getZoneEvents() const =0