Class RuleEngine

Rule Engine

Index

Constructors

Methods

addRule checkRateLimit evaluate getRule getRules getStats removeRule resetStats setRuleEnabled updateRule createDM1FaultRule createHighPriorityEngineRule createRateLimitRule

Constructors

constructor

new RuleEngine(): RuleEngine

Returns RuleEngine

Methods

addRule

addRule(rule: RoutingRule): void
Add rule
Parameters
- rule: RoutingRule
Returns void
- Defined in rules-engine.ts:43

checkRateLimit

checkRateLimit(ruleId: string, lastMessageTime?: number): boolean
Check rate limit
Parameters
- ruleId: string
- OptionallastMessageTime: number
Returns boolean
- Defined in rules-engine.ts:110

evaluate

evaluate(
    pgn: number,
    data: any,
    spnValues?: Map<number, number>,
): { action: RuleAction; rule: RoutingRule | null; transformedData?: any }
Evaluate message against rules
Parameters
- pgn: number
- data: any
- OptionalspnValues: Map<number, number>
Returns { action: RuleAction; rule: RoutingRule | null; transformedData?: any }
- Defined in rules-engine.ts:59

getRule

getRule(ruleId: string): RoutingRule | undefined
Get rule
Parameters
- ruleId: string
Returns RoutingRule | undefined
- Defined in rules-engine.ts:132

getRules

getRules(): RoutingRule[]
Get all rules

Returns RoutingRule[]
- Defined in rules-engine.ts:125

getStats

getStats(): Map<string, { hitCount: number; rule: RoutingRule }>
Get stats

Returns Map<string, { hitCount: number; rule: RoutingRule }>
- Defined in rules-engine.ts:160

removeRule

removeRule(ruleId: string): void
Remove rule
Parameters
- ruleId: string
Returns void
- Defined in rules-engine.ts:52

resetStats

resetStats(): void
Reset stats

Returns void
- Defined in rules-engine.ts:176

setRuleEnabled

setRuleEnabled(ruleId: string, enabled: boolean): void
Enable/disable rule
Parameters
- ruleId: string
- enabled: boolean
Returns void
- Defined in rules-engine.ts:150

updateRule

updateRule(ruleId: string, updates: Partial<RoutingRule>): void
Update rule
Parameters
- ruleId: string
- updates: Partial<RoutingRule>
Returns void
- Defined in rules-engine.ts:139

`Static`createDM1FaultRule

createDM1FaultRule(): RoutingRule
Create DM1 rule template

Returns RoutingRule
- Defined in rules-engine.ts:199

`Static`createHighPriorityEngineRule

createHighPriorityEngineRule(): RoutingRule
Create engine rule template

Returns RoutingRule
- Defined in rules-engine.ts:183

`Static`createRateLimitRule

createRateLimitRule(pgn: number, rateLimit?: number): RoutingRule
Create rate limit rule template
Parameters
- pgn: number
- rateLimit: number = 10
Returns RoutingRule
- Defined in rules-engine.ts:214