File: /home/oboss/Users/gec/sources/PUS_Services/TC_Verification/tc_acknowledger.ads

1     --% Compilation Unit:	TC_Acknowledger
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: tc_acknowledger.ads,v $
13     --    Revision 2.0  2003/04/04 08:51:23  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:15  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 Parameter_Representation;
44     with PUS;
45     with PUS_Data_Types;
46     with Verification_Types;
47     package TC_Acknowledger is
48     
49        --% Library Package:
50        --    Provides telecommand verification services according to service type
51        --+    1: Telecommand Verification Service from Packet Utilisation Standard
52        --% Active Tasks:
53        -->   None
54        --% Passive Tasks:
55        -->   None
56     
57        -- Indicates a request for acknowledgement for telemetry packet.
58        Illegal_Packet_Type : exception;
59     
60        --% Subprogram:
61        --    Generate telecommand verification packet acknowledging Stage if
62        --+    requested in TC.
63        --    Stage indicates telecommand execution stage, Status is associated
64        --+    status.
65        --    Step_Number is intermediate step being acknowledged iff Stage =
66        --+     PUS_Data_Types.Progress_Of_Execution
67        --    Additional_Parameters_Bit_Size allocates extra space in source data
68        --+    stream enclosed in resulting telemetry packet.
69        --   Result is telecommand verification telemetry packet - if verification
70        --+    is to be generated - or PUS.Void if verification is not to be
71        --+    generated.
72        --% Parameter Constraints:
73        -->   Step_Number - Only applicable iff
74        --+    PUS_Data_Types.Progress_Of_Execution.
75        --% Exceptions Raised:
76        -->   Illegal_Packet_Type  - Operation has been invoked on a telemetry
77        --+    packet.
78        -->   PUS_State.No_Streams_Available  - Heap of source streams has been
79        --+    exhausted
80        -->   PUS_State.No_Packets_Available  - Heap of PUS packets has been
81        --+    exhausted
82        function Make_TC_Verification
83              (TC          :        PUS.PUS_Packet;
84               Stage       :        PUS_Data_Types.Ack_Stages;
85               Status      :        Verification_Types.Verification_Status;
86               Additional_Parameters_Bit_Size
87                           :        Natural                                     :=
88                                                                               0;
89               Step_Number :        Verification_Types.Verification_Step_Number :=
90                     Verification_Types.Verification_Step_Number'First)
91              return PUS.Optional_PUS_Packet;
92     
93     end TC_Acknowledger;
94     
95     --~-----------------------------------------------------------------------------
96