Namespace Geotab.Checkmate.ObjectModel.Exceptions
Classes
- Condition
Conditions model the logic that govern a Rule and can apply to many different types of data and entities. Conditions are structured in hierarchical tree. A condition's type (see ConditionType) defines the meaning of each condition in the tree and can be an operator, special operator, data or an asset.
Depending on the type of condition, it can have a minimum of 0 and maximum of 1 entity properties (Device, Driver, Diagnostic, WorkTime, Zone or ZoneType) defined per condition. Operator conditions (OR, AND, >, <, ==, NOT) will not have any entity properties populated. Special Operator conditions evaluate against special types of data such as Aux data, Zones, WorkHours, etc. and may have the entity property populated and/or a child condition populated with a Data condition. Asset conditions will only have the asset entity property populated.
The unit of measure for data is described either by the related Diagnostic's UnitOfMeasure or as follows:
A tree of conditions can define simple or complex rules and can be very powerful. Please take into consideration all possible consequences of a series of rules. Overly complex, poorly written or an excessive number of rules can have undesirable performance effects.
This class is in development. Its public interface is a subject to change.
- ConditionFactory
Factory for creating conditions.
- ExceptionEvent
The event of an exception generated by Rule violation.
- ExceptionEventAttachment
An uploaded MediaFile associated with an ExceptionEvent instance.
- ExceptionEventAttachmentSearch
The object used to specify the arguments when searching for ExceptionEventAttachments.
See comments on each nested Search for what parameters are supported.
- ExceptionEventComment
A class representing a user comment on an ExceptionEvent instance.
- ExceptionEventCommentSearch
The object used to specify the arguments when searching for ExceptionEventComments.
See comments on each nested Search for what parameters are supported.
- ExceptionEventMargin
Base class for all Exceptions.
- ExceptionEventMetadata
The metadata monitored by or generated from the ExceptionEventMetadata processing.
- ExceptionEventSearch
The object used to specify the arguments when searching for ExceptionEvent.
This search has been designed to work efficiently with these combinations of parameters:
- ExceptionEventState
Specify the current state of the ExceptionEvent.
- ExceptionEventStateDismissed
Specifies that the ExceptionEvent has been dismissed by a user. It cannot be moved from this ExceptionEventState to any other ExceptionEventState.
- ExceptionEventStateInvalid
Specifies that the ExceptionEvent is no longer valid and has either been replaced or wasn't needed. It cannot be moved from this ExceptionEventState to any other ExceptionEventState.
- ExceptionEventStateValid
Specifies that the ExceptionEvent is valid. It can be moved from this ExceptionEventState to other ExceptionEventStates.
- ExceptionEventWithCoordinate
This class contains the ExceptionEvent and estimated driver and coordinates for the ExceptionEvent. It is used most for Engine ExceptionEvents for they do not associate to Gps Data directly.
- ExceptionEventWithMetadata
false Exception with its corresponding event meta data.
- ExceptionInstance
Base class for all Exceptions.
false
- ExceptionsActivity
false Exception Activity.
- ExceptionsDetail
The exception details for reports.
- ExceptionsSummary
false The Exceptions summary class.
- NoExceptionEvent
A exception event that represents DBNull database value.
- NoRule
A Exceptiopn Rule which represents DBNull database value.
- PostedSpeedUsageInfo
false The posted speed usage info class.
- Rule
A rule is the definition of conditions that, when "violated", will generate an ExceptionEvent. The rule's logic is defined by it's tree of Condition (s). It's condition tree will be evaluated against data for device(s) that are members of the rule's assigned group(s) or the device(s)/driver(s) defined in the rule condition tree. The conditions will be evaluated independently against the assets in the selected groups.
- RuleMonitor
false The event of an exception generated by RuleMonitor violation.
- RuleSearch
true search The object used to specify the arguments when searching for a Rule.
- SpeedLimitConditionTypes
Supported speed limit condition types.
- TripExceptionsSummary
false The trip exceptions summary class.
Interfaces
- IConditionContainer
This is an internal class.
- IExceptionEventProvider
The interface that is used to retrieve ExceptionEvent value from an object that implements this interface.
- IThreeRulesRelationships
Defines the relationships among three Rule.
Enums
- ConditionType
Defines the different types of Condition(s).
- DataSourceKind
Kinds of data sources for Conditions.
- ExceptionRuleBaseType
When exceptions are created based on built-in rules, the base type is always set to "Stock". For rules which are defined by you, the base type will be "Custom". The ZoneStop base type is used to designate exceptions created specifically when a zone is configured with the "MustIdentifyStops" property set to true.
- ExceptionRuleCategory
Specific categories to which the exception rules belong.
- ExceptionRuleMode
The mode of the Rule.
- ExceptionRuleType
This enumerated type allows designating rules to be of a certain type to assist with differentiating them from one another.
- MonitorPredicate
Defines the different types of rule monitor predicates.
- RuleMonitorType
Defines different rule monitor types.
- SpeedLimitRequestOptions
Defines options for a map server request.