File: /home/oboss/Users/gec/sources/PUS_Services/Storage_And_Retrieval/external_packet_store_types.ads

1     --% Compilation Unit:	External_Packet_Store_Types
2     --
3     --% Category: Package Declaration
4     --
5     --% Release:  $Name:  $
6     --
7     --% Version:  $Revision: 2.0 $
8     --
9     --% Author:   $Author: gec $
10     --
11     --% Revision Log:
12     --    $Log: external_packet_store_types.ads,v $
13     --    Revision 2.0  2003/04/04 08:51:20  gec
14     --    Initial release of source files serving as baseline for OBOSS-III project.
15     --
16     --    Revision 1.1.1.1  2003/04/04 08:13:14  gec
17     --    Imported using TkCVS
18     --
19     --
20     --
21     --% Project: OBOSS
22     --
23     --% Copyright (C) 2003 by Terma A/S
24     --  Proprietary and intellectual rights of Terma A/S, Denmark,
25     --  are involved in the subject-matter of this material and
26     --  all manufacturing, reproduction, use, disclosure, and
27     --  sales rights pertaining to such subject-matter are
28     --  expressly reserved. This material is submitted for a
29     --  specific purpose as agreed, and the recipient by
30     --  accepting this material agrees that this material will
31     --  not be used, copied, or reproduced in whole or in part
32     --  nor its contents revealed in any manner or to any person,
33     --  except to meet the purpose for which it was submitted and
34     --  subject to the terms of the agreement.
35     --
36     --% Target Dependencies:
37     --    None
38     --% Compiler Dependencies:
39     --    None
40     
41     --~-----------------------------------------------------------------------------
42     
43     with PUS_Data_Types;
44     with Source_Data_Stream;
45     with Packet_Store_Types;
46     with Parameter_Representation;
47     package External_Packet_Store_Types is
48     
49        --% Library Package:
50        --    Definition of on-board storage external types
51        --% Active Tasks:
52        -->   None
53        --% Passive Tasks:
54        -->   None
55     
56        type Count_Type is new Parameter_Representation.Unsigned_Integer_12;
57     
58        type Downlink_Set_Type is new
59              Parameter_Representation.Enumerated_2 range 0 .. 3;
60        All_Of  : constant Downlink_Set_Type := 0;
61        Between : constant Downlink_Set_Type := 1;
62        Before  : constant Downlink_Set_Type := 2;
63        After   : constant Downlink_Set_Type := 3;
64     
65        type Deletion_Set_Type is new
66              Parameter_Representation.Enumerated_1 range 0 .. 1;
67        Delete_All_Of : constant Deletion_Set_Type := 0;
68        Delete_Before : constant Deletion_Set_Type := 1;
69     
70        type External_TM_Source_Sequence_Count is new
71              Parameter_Representation.Unsigned_Integer_12;
72     
73        --% Subprogram:
74        --    Reads a downlink set specification from a read stream
75        --% Parameter Constraints:
76        -->   None
77        --% Exceptions Raised:
78        -->   Source_Data_Stream.Read_Stream_Exhausted  - When source data stream
79        --+    does not hold a sufficient number of bits for the required type.
80     
81     
82        procedure Get
83              (Stream       : in out Source_Data_Stream.Read_Stream;
84               Downlink_Set :    out Packet_Store_Types.Downlink_Set_Type);
85     
86     
87        --% Subprogram:
88        --    Writes a downlink set specification to a write stream
89        --% Parameter Constraints:
90        -->   None
91        --% Exceptions Raised:
92        -->   Source_Data_Stream.Write_Stream_Exhausted  - When source data stream
93        --+    does not have sufficient space for the required type.
94     
95        procedure Put
96              (Stream       : in out Source_Data_Stream.Write_Stream;
97               Downlink_Set : in     Packet_Store_Types.Downlink_Set_Type);
98     
99     
100        --% Subprogram:
101        --    Reads a deletion set specification from a read stream
102        --% Parameter Constraints:
103        -->   None
104        --% Exceptions Raised:
105        -->   Source_Data_Stream.Read_Stream_Exhausted  - When source data stream
106        --+    does not hold a sufficient number of bits for the required type.
107     
108        procedure Get
109              (Stream       : in out Source_Data_Stream.Read_Stream;
110               Deletion_Set :    out Packet_Store_Types.Deletion_Set_Type);
111     
112     
113        --% Subprogram:
114        --    Writes a deletion set specification to a write stream
115        --% Parameter Constraints:
116        -->   None
117        --% Exceptions Raised:
118        -->   Source_Data_Stream.Write_Stream_Exhausted  - When source data stream
119        --+    does not have sufficient space for the required type.
120     
121        procedure Put
122              (Stream       : in out Source_Data_Stream.Write_Stream;
123               Deletion_Set : in     Packet_Store_Types.Deletion_Set_Type);
124     
125     
126        --% Subprogram:
127        --    Reads a packet store count value from a read stream
128        --% Parameter Constraints:
129        -->   None
130        --% Exceptions Raised:
131        -->   Source_Data_Stream.Read_Stream_Exhausted  - When source data stream
132        --+    does not hold a sufficient number of bits for the required type.
133     
134        procedure Get
135              (Stream : in out Source_Data_Stream.Read_Stream;
136               Count  :    out Packet_Store_Types.Count_Type);
137     
138     
139        --% Subprogram:
140        --    Writes a packet store count value to a write stream
141        --% Parameter Constraints:
142        -->   None
143        --% Exceptions Raised:
144        -->   Source_Data_Stream.Write_Stream_Exhausted  - When source data stream
145        --+    does not have sufficient space for the required type.
146     
147        procedure Put
148              (Stream : in out Source_Data_Stream.Write_Stream;
149               Count  : in     Packet_Store_Types.Count_Type);
150     
151     
152        --% Subprogram:
153        --    Reads a packet store sequence count value from a read stream
154        --% Parameter Constraints:
155        -->   None
156        --% Exceptions Raised:
157        -->   Source_Data_Stream.Read_Stream_Exhausted  - When source data stream
158        --+    does not hold a sufficient number of bits for the required type.
159     
160        procedure Get
161              (Stream : in out Source_Data_Stream.Read_Stream;
162               Val    :    out Packet_Store_Types.Sequence_Count);
163     
164     
165        --% Subprogram:
166        --    Writes a packet store sequence count value to a write stream
167        --% Parameter Constraints:
168        -->   None
169        --% Exceptions Raised:
170        -->   Source_Data_Stream.Write_Stream_Exhausted  - When source data stream
171        --+    does not have sufficient space for the required type.
172     
173        procedure Put
174              (Stream : in out Source_Data_Stream.Write_Stream;
175               Val    : in     Packet_Store_Types.Sequence_Count);
176     
177     end External_Packet_Store_Types;
178     
179     --~-----------------------------------------------------------------------------
180