Is the enclosing element for objects that define the output for Event Recorder.
Example:
<?xml version="1.0" encoding="utf-8"?>
<component_viewer schemaVersion="0.1" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="Component_Viewer.xsd">
<component name="MyExample" version="1.0.0"/> <!-- name and version of the component -->
<events>
<group name="My Events Group">
<component name="MyApp" brief="My Application" no="0x00" prefix="EvrNetMM_" info="Network - System - Dynamic Memory Management"/>
</group>
<event id="1" level="API" property="MyFunction" value="parameter=%x[val1]" info="Event on start of MyFunction" />
<event id="2" level="Error" property="MyFunctionError" info="Event on error in MyFunction" />
<event id="3" level="Op" property="MyFunctionProcess" value="string=%t[val1]" info="Event on operation in MyFunction" />
</events>
</component_viewer>
/component_viewer/events/group
Define groups of software components that are shown together.
Parent Element | Element Chain |
events | /component_viewer/events |
Attributes | Description | Type | Use |
name | Define the name of a group. This name is used for filtering. | xs:string | required |
Child Element | Description | Type | Occurrence |
group | Sub-group. | GroupType | 0..* |
component | Component within the group. | ComponentType | 0..* |
/component_viewer/events/group/component
Define software components that are tied to an event number.
Parent Element | Element Chain |
group | /component_viewer/events/group |
Attributes | Description | Type | Use |
name | Descriptive component name. | xs:string | required |
brief | Short component name for display purposes. | xs:string | required |
no | Event id component number (bits 8..15). See Theory of operation. | xs:string | required |
prefix | Added to hyperlink in context sensitive help system before the <event name>. | xs:string | required |
info | Descriptive text shown when hovering over the component brief. | xs:string | optional |
Example:
<events>
<!-- event groups for Network Component -->
<group name="Network">
<group name="System Events">
<component name="Memory Management" brief="NetMM" no="0x80" prefix="EvrNetMM_" info="Network - System - Dynamic Memory Management"/>
<component name="ETH Interface" brief="NetETH" no="0x81" prefix="EvrNetETH_" info="Network - System - Ethernet Interface"/>
<component name="PPP Interface" brief="NetPPP" no="0x82" prefix="EvrNetPPP_" info="Network - System - Serial PPP Interface"/>
<component name="SLIP Interface" brief="NetSLIP" no="0x83" prefix="EvrNetSLIP_" info="Network - System - Serial SLIP Interface"/>
<component name="Loopback Interface" brief="NetLB" no="0x84" prefix="EvrNetLB_" info="Network - System - Local Loopback Interface"/>
</group>
<group name="IPv4 Core Events">
<component name="IP4 Core" brief="NetIP4C" no="0x85" prefix="EvrNetIP4C_" info="Network - IPv4 - Core/localhost"/>
<component name="ICMP Control" brief="NetICMP" no="0x86" prefix="EvrNetICMP_" info="Network - IPv4 - Internet Control Message"/>
<component name="IGMP Management" brief="NetIGMP" no="0x87" prefix="EvrNetIGMP_" info="Network - IPv4 - Internet Group Message (multicast)"/>
<component name="NBNS Client" brief="NetNBNS" no="0x88" prefix="EvrNetNBNS_" info="Network - IPv4 - NetBIOS Name Service Client"/>
<component name="DHCP Client" brief="NetDHCP" no="0x89" prefix="EvrNetDHCP_" info="Network - IPv4 - Dynamic Host Client"/>
<component name="ARP Address Resolution" brief="NetARP" no="0x8A" prefix="EvrNetARP_" info="Network - IPv4 - Ethernet Address Resolution"/>
</group>
<group name="IPv6 Core Events">
<component name="IP6 Core" brief="NetIP6C" no="0x8B" prefix="EvrNetIP6C_" info="Network - IPv6 - Core/localhost"/>
<component name="ICMP6 Control" brief="NetICMP6" no="0x8C" prefix="EvrNetICMP6_" info="Network - IPv6 - Internet Control Message"/>
<component name="DHCP6 Client" brief="NetDHCP6" no="0x8D" prefix="EvrNetDHCP6_" info="Network - IPv6 - Dynamic Host Client"/>
<component name="NDP Neighbor Discovery" brief="NetNDP" no="0x8E" prefix="EvrNetNDP_" info="Network - IPv4 - Neighbor Discovery"/>
</group>
</group>
:
:
</events>
/component_viewer/events/event
Define an event that can occur for the software component. The attributes property and value can consist of ASCII characters and format specifiers.
Parent Element | Element Chain |
events | /component_viewer/events |
Attributes | Description | Type | Use |
id | 16-bit event id (message and component number) value. See Theory of operation. | xs:anySimpleType | required |
level | Event severance level (OP, API, Error, Detail) used for filtering. See Theory of operation. | xs:anySimpleType | required |
property | Value Output shown in the Event Property column of the Event Recorder window. | xs:string | required |
value | Value Output shown in the Value column of the Event Recorder window. | xs:anySimpleType | optional |
info | Descriptive text with additional information (comment). | xs:string | optional |
doc | Explicit link to documentation. | xs:string | optional |
Example:
<events>
:
:
<event id="0xA00" level="API" property="InitEntry" info="Event on MyComp_initialize start"/>
<event id="0xA01" level="API" property="InitStatus" info="Event on MyComp_initialize return"/>
<event id="0xA0A" level="Error" property="SendNoData" info="Event on MyComp_initialize return"/>
<event id="0xA0B" level="Op" property="SendComplete" value="size=%d[val1]" info="Event on MyComp_send - completed"/>
<event id="0xA0C" level="Error" property="SendFailed" value="" info="Event on MyComp_send - send failed"/>
<event id="0xA15" level="Error" property="ReceiveNoData" value="" info="Event on MyComp_receive - no data received"/>
<event id="0xA16" level="Op" property="ReceiveComplete" value="size=%d[val1]" info="Event on MyComp_receive - completed"/>
<event id="0xA17" level="Error" property="ReceiveFailed" value="" info="Event on MyComp_receive - receive failed"/>
</events>