ArchestrA.Client.Navigation Namespace
Classes
| Class | Description | |
|---|---|---|
 | AlarmData | Subscribes for and wraps the data included in an Asset's object level AlarmCntsBySeverity array. Fires an event when anything changes.
Also responsible for client side propagation. Deltas are pushed from children to parent (custom hierarchy) nodes whenever a new value comes in. |
| ContentData | This class holds content information such as name and owningobject. |
| FilterOptions | This class holds the filter options that need to be applied on a specific navigation item. |
| NavigationException | A custom exception class wrapping the exception/ Error information related to the Navigation Extension. |
| NavigationItem | Provides a generic view to an individual navigation item in a Navigation Model. It contains the necessary information to show a visual representation of an item in various forms, and one or more actions which should be executed when the user has triggered the Navigation item. |
| NavigationItemNotFoundException | A custom exception class wrapping the exception/ Error information when the item is not found in the navigation items Collection in Navigation Extension. |
| NavigationModel | A generic view of the class representing a single Navigation Model in the system. It encapsulates the hierarchy built by the user either from scratch or using the Asset Model as input. This hierarchy holds Navigation Items for use in runtime, primarily consumed by Hierarchy Controls. This model can also be fed from an IBrowse source rather than a user-built Model. |
| PathUtil | Performs operations on NavigationItem instances that contain item path information. |
| ReadOnlyNavigationItemCollection | This class returns a read only collection of navigation items. |
Enumerations
| Enumeration | Description | |
|---|---|---|
 | LevelsOfSearch | This option provides the different levels of search that the system allows. |
| LocalAlarmExistsBits | This enumeration is used for indexing into the the LocalAlarmExists bitfield returned by the AlarmData class. A bit that is on indicates that the corresponding integer returned as AlarmData contains at least one locally generated alarm (not aggregrated from a child runtime object) |
| NavigationItemType | An enum indicating the nature of the navigation item in the navigation model |
| NavigationSearchMode | This option provides the different navigation search modes that the system allows. |
| NavSearchOptions | This option provides the different navigation search modes for the content search in the navigation hierarchy. |
| SearchLevelOption | This option provides the different levels of search for the contents in the navigation hierarchy. |
| SearchOptionsEnums | This is a dummy enum used to address the code analysis warning. |
| SortOrder | This option controls how the items are sorted while displaying in the control. |
See Also