Rule Param DTOs are used by the following service API:
- Event Service API - Uses Rule Param structures for defining and managing device monitoring rules
Table of Contents
Reading Visitor
| Field | Type | Label | Description |
|---|
| operator()(int i) | string | | |
| operator()(double f) | string | | |
Top
RULE
| Field | Type | Label | Description |
|---|
| TYPE | enum | | |
| SEVERITY | enum | | |
Top
Rule Event
| Field | Type | Label | Description |
|---|
| mrid | string | | |
| event | string | | |
| ruleId | string | | |
| ruleName | string | | |
| severity | uint32_t | | |
Top
Rule Value (Class)
| Field | Type | Label | Description |
|---|
| timestamp | uint64_t | | |
| value | generic(T) | | |
Top
Rule Set Map
| Field | Type | Label | Description |
|---|
| ruleId | string | | |
| equipmentId | string | | |
Top
Rule Param (Class)
| Field | Type | Label | Description |
|---|
| hasMetCriteria() | bool | | |
| compare(int idx) | bool | | |
| addReading(RuleValue<reading_t> reading) | void | | |
| id | string | | |
| enabled | bool | | true |
| name | string | | |
| mrid | string | | |
| jsonPath | string | | |
| op | string | | //operator |
| comment | string | | |
| ruleType | uint32_t | | |
| severity | uint32_t | | |
| hasTriggered | bool | | false |
| duration | uint64_t | | |
| count | uint64_t | | |
| openfmbProfile | string | | |
| event | string | | |
| customEvent | string | | |
| readin\g\s | vector<RuleValue<reading_t>> | | |
| compareValue | reading_t | | |
| ruleSetId | string | | |
| ruleSetMap | vector<RuleSetMap> | | |
Top
Rule Holder
| Field | Type | Label | Description |
|---|
| rules | vector<RuleParam> | | |
Top
Rules Response
| Field | Type | Label | Description |
|---|
| success | vector<string> | | |
| failed | vector<string> | | |
Top
Enable Request
| Field | Type | Label | Description |
|---|
| enable | vector<string> | | |
| disable | vector<string> | | |