Add overwrite field to SaveFile, ExportRegion (#97)

* Add overwrite field to SaveFile * Increment major version in index * Add overwrite field to ExportRegion * add overwrite confirm required flag * update docs --------- Co-authored-by: yuhsuan <[email protected]> Co-authored-by: Adrianna Pińska <[email protected]>
CARTAvis · Aug 19, 2024 · deaaf0a · deaaf0a
1 parent eff1b21
commit deaaf0a
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 4 deletions.
diff --git a/control/export_region.proto b/control/export_region.proto
@@ -21,6 +21,8 @@ message ExportRegion {
     string directory = 5;
     // Optional file name of server file
     string file = 6;
+    // Optional overwrite existing file
+    bool overwrite = 7;
 }
 
 // EXPORT_REGION_ACK
@@ -32,4 +34,6 @@ message ExportRegionAck {
     string message = 2;
     // File contents for client export (one line per string)
     repeated string contents = 3;
+    // Request for overwrite confirmation
+    bool overwrite_confirmation_required = 4;
 }
diff --git a/docs/src/changelog.rst.txt b/docs/src/changelog.rst.txt
@@ -222,6 +222,9 @@ Changelog
    * - ``28.15.0``
      - 23/05/24
      - Added :carta:ref:`RemoteFileRequest` and :carta:ref:`RemoteFileResponse` messages.
+   * - ``29.0.0``
+     - 26/06/24
+     - Added ``overwrite`` to :carta:ref:`SaveFile` and :carta:ref:`ExportRegion` messages.
 
 Versioning
 ----------

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -1,11 +1,11 @@
 CARTA Interface Control Document
 ================================
 
-:Date: 03 July 2024
+:Date: 11 June 2024
 :Authors: Angus Comrie, Rob Simmonds and the CARTA development team
-:Version: 28.15.0
-:ICD Version Integer: 28
-:CARTA Target: Version 4.0
+:Version: 29.0.0
+:ICD Version Integer: 29
+:CARTA Target: Version 5.0
 
 .. include:: changelog.rst.txt
 

diff --git a/docs/src/messages.rst.txt b/docs/src/messages.rst.txt
@@ -657,6 +657,10 @@ Backend responds with  :carta:refc:`EXPORT_REGION_ACK`
      - string
      - 
      - Optional file name of server file
+   * - overwrite
+     - bool
+     - 
+     - Optional overwrite existing file
 
 .. carta:class:: carta-b2f exportregionack
 
@@ -691,6 +695,10 @@ Response for :carta:refc:`EXPORT_REGION` to indicate success and file contents i
      - string
      - repeated
      - File contents for client export (one line per string)
+   * - overwrite_confirmation_required
+     - bool
+     - 
+     - Request for overwrite confirmation
 
 .. carta:class:: carta-f2b fileinforequest
 
@@ -2356,6 +2364,10 @@ Source file: `request/save_file.proto <https://github.com/CARTAvis/carta-protobu
      - double
      - 
      - Set the rest frequency (Hz) of the image
+   * - overwrite
+     - bool
+     - 
+     - Overwrite existing image
 
 .. carta:class:: carta-f2b savefileack
 
@@ -2389,6 +2401,10 @@ Source file: `request/save_file.proto <https://github.com/CARTAvis/carta-protobu
      - string
      - 
      - 
+   * - overwrite_confirmation_required
+     - bool
+     - 
+     - Request for overwrite confirmation
 
 .. carta:class:: carta-f2b scriptingrequest
 

diff --git a/request/save_file.proto b/request/save_file.proto
@@ -17,10 +17,14 @@ message SaveFile {
     bool keep_degenerate = 8;
     // Set the rest frequency (Hz) of the image
     double rest_freq = 9;
+    // Overwrite existing image
+    bool overwrite = 10;
 }
 
 message SaveFileAck {
     sfixed32 file_id = 1;
     bool success = 2;
     string message = 3;
+    // Request for overwrite confirmation
+    bool overwrite_confirmation_required = 4;
 }