ucar.nc2.write

Class NetcdfFormatWriter.WriteConfig

java.lang.Object

ucar.nc2.write.NetcdfFormatWriter.WriteConfig

Enclosing class:

NetcdfFormatWriter

public class NetcdfFormatWriter.WriteConfig
extends Object

Fluid API for writing.

Constructor Summary

Constructors

Constructor and Description
WriteConfig()

Method Summary

Modifier and Type	Method and Description
NetcdfFormatWriter.WriteConfig	forVariable(String varName) Write to this named Variable.
NetcdfFormatWriter.WriteConfig	forVariable(Variable v) Write to this Variable.
NetcdfFormatWriter.WriteConfig	withArray(Array<?> values) The values to write.
NetcdfFormatWriter.WriteConfig	withOrigin(Index origin) If not set, assume all zeroes.
NetcdfFormatWriter.WriteConfig	withOrigin(int... origin) If not set, assume all zeroes.
NetcdfFormatWriter.WriteConfig	withPrimitiveArray(Object primArray) The values to write as a 1D java primitive array, eg float[].
NetcdfFormatWriter.WriteConfig	withShape(int... shape) Shape of primitive array, not needed for Array.
NetcdfFormatWriter.WriteConfig	withString(String sval) For writing a String into a CHAR Variable.
void	write() Do the write to the file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WriteConfig

public WriteConfig()

Method Detail

forVariable

public NetcdfFormatWriter.WriteConfig forVariable(Variable v)

Write to this Variable.

forVariable

public NetcdfFormatWriter.WriteConfig forVariable(String varName)

Write to this named Variable.

withOrigin

public NetcdfFormatWriter.WriteConfig withOrigin(Index origin)

If not set, assume all zeroes.

withOrigin

public NetcdfFormatWriter.WriteConfig withOrigin(int... origin)

If not set, assume all zeroes.

withArray

public NetcdfFormatWriter.WriteConfig withArray(Array<?> values)

The values to write. ArrayType must match the Variable.

withPrimitiveArray

public NetcdfFormatWriter.WriteConfig withPrimitiveArray(Object primArray)

The values to write as a 1D java primitive array, eg float[].

See Also:

Arrays.factory(ArrayType type, int[] shape, Object primArray)

withShape

public NetcdfFormatWriter.WriteConfig withShape(int... shape)

Shape of primitive array, not needed for Array. If not set, assume v.getShape().

withString

public NetcdfFormatWriter.WriteConfig withString(String sval)

For writing a String into a CHAR Variable.

See Also:

NetcdfFormatWriter.writeStringData(Variable, Index, String)

write

public void write()
           throws IOException,
                  InvalidRangeException,
                  IllegalArgumentException

Do the write to the file.

Throws:

IllegalArgumentException - when not configured correctly.

IOException

InvalidRangeException

See Also:

NetcdfFormatWriter.write(Variable, ucar.array.Index, ucar.array.Array)