File: /home/oboss/Users/gec/sources/PUS_Services/Event_Reporting/external_event_reporting_types.ads
1 --% Compilation Unit: External_Event_Reporting_Types
2 --
3 --% Category: Package Declaration
4 --
5 --% Release: $Name: $
6 --
7 --% Version: $Revision: 2.2 $
8 --
9 --% Author: $Author: gec $
10 --
11 --% Revision Log:
12 -- $Log: external_event_reporting_types.ads,v $
13 -- Revision 2.2 2003/10/24 13:53:47 gec
14 -- Refined task exception event report to include all available information on exception leading to task termination.
15 --
16 -- Revision 2.1 2003/10/21 08:44:49 gec
17 -- Merged STADY_Recommendations branch onto trunk.
18 -- Contains numerous updates resulting from STADY fault descriptions.
19 --
20 -- Revision 2.0.2.1 2003/10/17 11:05:32 gec
21 -- Added support for reporting of data loss.
22 --
23 -- Revision 2.0 2003/04/04 08:51:02 gec
24 -- Initial release of source files serving as baseline for OBOSS-III
25 --+ project.
26 --
27 -- Revision 1.1.1.1 2003/04/04 08:13:11 gec
28 -- Imported using TkCVS
29 --
30 --
31 --
32 --% Project: OBOSS
33 --
34 --% Copyright (C) 2003 by Terma A/S
35 -- Proprietary and intellectual rights of Terma A/S, Denmark,
36 -- are involved in the subject-matter of this material and
37 -- all manufacturing, reproduction, use, disclosure, and
38 -- sales rights pertaining to such subject-matter are
39 -- expressly reserved. This material is submitted for a
40 -- specific purpose as agreed, and the recipient by
41 -- accepting this material agrees that this material will
42 -- not be used, copied, or reproduced in whole or in part
43 -- nor its contents revealed in any manner or to any person,
44 -- except to meet the purpose for which it was submitted and
45 -- subject to the terms of the agreement.
46 --
47 --% Target Dependencies:
48 -- None
49 --% Compiler Dependencies:
50 -- None
51
52 --~-----------------------------------------------------------------------------
53
54 with Event_Reporting_Types;
55 with Parameter_Representation;
56 with Source_Data_Stream;
57 package External_Event_Reporting_Types is
58
59 --% Library Package:
60 -- External representation of packet fields and parameters related to
61 --+ service type 5: Event Reporting.
62 -- NB: Type definitions should be derived types as the implementation
63 --+ uses implicitly declared subprograms defined on the types.
64 --% Active Tasks:
65 --> None
66 --% Passive Tasks:
67 --> None
68
69 -- Exception indicating that translation from internal to external
70 --+ representation failed
71 Translation_Failure : exception;
72
73 -- External representation of RID included for all service subtypes.
74 type Report_ID is new Parameter_Representation.Enumerated_8;
75
76 -- External representation of fields enclosed in task exception reports (RID
77 --+ = 1).
78 type Variable_Character_String is new
79 Parameter_Representation.Var_Character_String;
80
81 -- External representation for count of data lost in data lost error
82 --+ reports
83 type Data_Loss_Count is new Parameter_Representation.Unsigned_Integer_12;
84
85 --% Subprogram:
86 -- Read operation extracting report ID field - in external format defined
87 --+ above - from head of Stream returning the field in its internal
88 --+ representation as defined by Event_Reporting_Types.
89 --% Parameter Constraints:
90 --> None
91 --% Exceptions Raised:
92 --> Source_Data_Stream.Read_Stream_Exhausted - End of stream was met while
93 --+ reading report ID.
94 --> Translation_Failure - Transformation from external to internal format
95 --+ failed.
96 procedure Get
97 (Stream : in out Source_Data_Stream.Read_Stream;
98 RID : out Event_Reporting_Types.Report_ID);
99
100 --% Subprogram:
101 -- Write operation inserting report ID field - in external format defined
102 --+ above - at tail of Stream.
103 --% Parameter Constraints:
104 --> None
105 --% Exceptions Raised:
106 --> Source_Data_Stream.Write_Stream_Exhausted - End of stream was met
107 --+ while writing report ID.
108 --> Translation_Failure - Transformation from internal to external format
109 --+ failed.
110 procedure Put
111 (Stream : in out Source_Data_Stream.Write_Stream;
112 RID : in Event_Reporting_Types.Report_ID);
113
114 --% Subprogram:
115 -- Write operation inserting given string - in external format defined by
116 --+ Variable_Character_String - at tail of Stream.
117 --% Parameter Constraints:
118 --> None
119 --% Exceptions Raised:
120 --> Source_Data_Stream.Write_Stream_Exhausted - End of stream was met
121 --+ while writing report ID.
122 --> Translation_Failure - Transformation from internal to external format
123 --+ failed.
124 procedure Put_Variable_String
125 (Stream : in out Source_Data_Stream.Write_Stream;
126 The_String : in String);
127
128 --% Subprogram:
129 -- Write operation inserting genereal event report - in external format -
130 --+ at tail of Stream.
131 --% Parameter Constraints:
132 --> None
133 --% Exceptions Raised:
134 --> Source_Data_Stream.Write_Stream_Exhausted - End of stream was met
135 --+ while writing Rep.
136 --> Translation_Failure - Transformation from internal to external format
137 --+ failed.
138 procedure Put
139 (Stream : in out Source_Data_Stream.Write_Stream;
140 Rep : in Event_Reporting_Types.Report);
141
142 end External_Event_Reporting_Types;
143
144 --~-----------------------------------------------------------------------------
145