/*
 * Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
 *
 * Portions of this software were developed by the Unidata Program at the
 * University Corporation for Atmospheric Research.
 *
 * Access and use of this software shall impose the following obligations
 * and understandings on the user. The user is granted the right, without
 * any fee or cost, to use, copy, modify, alter, enhance and distribute
 * this software, and any derivative works thereof, and its supporting
 * documentation for any purpose whatsoever, provided that this entire
 * notice appears in all copies of the software, derivative works and
 * supporting documentation.  Further, UCAR requests that the user credit
 * UCAR/Unidata in any publications that result from the use of this
 * software or in any product that includes this software. The names UCAR
 * and/or Unidata, however, may not be used in any advertising or publicity
 * to endorse or promote any products or commercial entity unless specific
 * written permission is obtained from UCAR/Unidata. The user also
 * understands that UCAR/Unidata is not obligated to provide the user with
 * any support, consulting, training or assistance of any kind with regard
 * to the use, operation and performance of this software nor to provide
 * the user with any updates, revisions, new versions or "bug fixes."
 *
 * THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */
package ucar.nc2;

import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import ucar.ma2.*;
import ucar.nc2.constants.CDM;

import java.io.IOException;

/**
 * Simple example to create a new netCDF file with a "record structure"
 * @author : John Caron
 */
public class TestWriteRecordStructure {
  @Rule
  public TemporaryFolder tempFolder = new TemporaryFolder();

  @Test
  public void testWriteRecordStructure() throws IOException, InvalidRangeException {
    String fileName = tempFolder.newFile("testWriteRecordStructure.nc").getAbsolutePath();

    try (NetcdfFileWriteable writeableFile = NetcdfFileWriteable.createNew(fileName)) {
      // define dimensions, including unlimited
      Dimension latDim  = writeableFile.addDimension("lat", 3);
      Dimension lonDim  = writeableFile.addDimension("lon", 4);
      Dimension timeDim = writeableFile.addUnlimitedDimension("time");

      // define Variables
      Dimension[] dim3 = new Dimension[3];
      dim3[0] = timeDim;
      dim3[1] = latDim;
      dim3[2] = lonDim;

      writeableFile.addVariable("lat", DataType.FLOAT, new Dimension[] { latDim });
      writeableFile.addVariableAttribute("lat", "units", "degrees_north");

      writeableFile.addVariable("lon", DataType.FLOAT, new Dimension[] { lonDim });
      writeableFile.addVariableAttribute("lon", "units", "degrees_east");

      writeableFile.addVariable("rh", DataType.INT, dim3);
      writeableFile.addVariableAttribute("rh", CDM.LONG_NAME, "relative humidity");
      writeableFile.addVariableAttribute("rh", "units", "percent");

      writeableFile.addVariable("T", DataType.DOUBLE, dim3);
      writeableFile.addVariableAttribute("T", CDM.LONG_NAME, "surface temperature");
      writeableFile.addVariableAttribute("T", "units", "degC");

      writeableFile.addVariable("time", DataType.INT, new Dimension[] { timeDim });
      writeableFile.addVariableAttribute("time", "units", "hours since 1990-01-01");

      // create the file
      writeableFile.create();

      // write out the non-record variables
      writeableFile.write("lat", Array.factory(new float[] { 41, 40, 39 }));
      writeableFile.write("lon", Array.factory(new float[] { -109, -107, -105, -103 }));

      //// heres where we write the record variables

      // different ways to create the data arrays. Note the outer dimension has shape 1.
      ArrayInt       rhData   = new ArrayInt.D3(1, latDim.getLength(), lonDim.getLength());
      ArrayDouble.D3 tempData = new ArrayDouble.D3(1, latDim.getLength(), lonDim.getLength());
      Array          timeData = Array.factory(DataType.INT, new int[] { 1 });

      int[] origin      = new int[] { 0, 0, 0 };
      int[] time_origin = new int[] { 0 };

      // loop over each record
      for (int time = 0; time < 10; time++) {
        // make up some data for this record, using different ways to fill the data arrays.
        timeData.setInt(timeData.getIndex(), time * 12);

        Index ima = rhData.getIndex();
        for (int lat = 0; lat < latDim.getLength(); lat++) {
          for (int lon = 0; lon < lonDim.getLength(); lon++) {
            rhData.setInt(ima.set(0, lat, lon), time * lat * lon);
            tempData.set(0, lat, lon, time * lat * lon / 3.14159);
          }
        }

        // write the data out for this record
        time_origin[0] = time;
        origin[0] = time;

        writeableFile.write("rh", origin, rhData);
        writeableFile.write("T", origin, tempData);
        writeableFile.write("time", time_origin, timeData);
      }
    }
  }
}