ucar.nc2.stream

Class NcStream

java.lang.Object

ucar.nc2.stream.NcStream

public class NcStream
extends java.lang.Object

Defines the ncstream format, along with ncStream.proto.

 To regenerate ncStreamProto.java from ncStream.proto:
 cd c:/dev/tds4.2/thredds/cdm/src/main/java
 protoc --proto_path=. --java_out=. ucar/nc2/stream/ncStream.proto
 

See Also:

"https://www.unidata.ucar.edu/software/netcdf-java/stream/NcStream.html", "https://www.unidata.ucar.edu/software/netcdf-java/stream/NcstreamGrammer.html"

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	MAGIC_DATA
static byte[]	MAGIC_END
static byte[]	MAGIC_ERR
static byte[]	MAGIC_HEADER
static byte[]	MAGIC_START
static byte[]	MAGIC_VDATA
static byte[]	MAGIC_VEND

Constructor Summary

Constructors

Constructor and Description
NcStream()

Method Summary

Modifier and Type	Method and Description
static ArrayStructureBB	decodeArrayStructure(StructureMembers sm, int[] shape, byte[] proto)
static DataType	decodeDataType(NcStreamProto.DataType dtype)
static java.lang.String	decodeErrorMessage(NcStreamProto.Error err)
static Section	decodeSection(NcStreamProto.Section proto)
static StructureData	decodeStructureData(StructureMembers sm, java.nio.ByteOrder bo, byte[] proto)
static long	encodeArrayStructure(ArrayStructure as, java.nio.ByteOrder bo, java.io.OutputStream os)
static NcStreamProto.DataType	encodeDataType(DataType dtype)
static NcStreamProto.Error	encodeErrorMessage(java.lang.String message)
static NcStreamProto.Section	encodeSection(Section section)
static boolean	readAndTest(java.io.InputStream is, byte[] test)
static boolean	readAndTest(RandomAccessFile raf, byte[] test)
static int	readFully(java.io.InputStream is, byte[] b)
static int	readVInt(java.io.InputStream is)
static int	readVInt(RandomAccessFile raf)
static boolean	test(java.lang.Byte[] b, byte[] test)
static int	writeBytes(java.io.OutputStream out, byte[] b)
static int	writeVInt(java.io.OutputStream out, int value)
static int	writeVInt(RandomAccessFile out, int value)
static int	writeVInt(java.nio.channels.WritableByteChannel wbc, int value)

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC_START

public static final byte[] MAGIC_START

MAGIC_HEADER

public static final byte[] MAGIC_HEADER

MAGIC_DATA

public static final byte[] MAGIC_DATA

MAGIC_VDATA

public static final byte[] MAGIC_VDATA

MAGIC_VEND

public static final byte[] MAGIC_VEND

MAGIC_ERR

public static final byte[] MAGIC_ERR

MAGIC_END

public static final byte[] MAGIC_END

Constructor Detail

NcStream

public NcStream()

Method Detail

encodeErrorMessage

public static NcStreamProto.Error encodeErrorMessage(java.lang.String message)

encodeSection

public static NcStreamProto.Section encodeSection(Section section)

encodeArrayStructure

public static long encodeArrayStructure(ArrayStructure as,
                                        java.nio.ByteOrder bo,
                                        java.io.OutputStream os)
                                 throws java.io.IOException

Throws:

java.io.IOException

decodeArrayStructure

public static ArrayStructureBB decodeArrayStructure(StructureMembers sm,
                                                    int[] shape,
                                                    byte[] proto)
                                             throws java.io.IOException

Throws:

java.io.IOException

decodeStructureData

public static StructureData decodeStructureData(StructureMembers sm,
                                                java.nio.ByteOrder bo,
                                                byte[] proto)
                                         throws java.io.IOException

Throws:

java.io.IOException

writeBytes

public static int writeBytes(java.io.OutputStream out,
                             byte[] b)
                      throws java.io.IOException

Throws:

java.io.IOException

writeVInt

public static int writeVInt(java.io.OutputStream out,
                            int value)
                     throws java.io.IOException

Throws:

java.io.IOException

writeVInt

public static int writeVInt(RandomAccessFile out,
                            int value)
                     throws java.io.IOException

Throws:

java.io.IOException

writeVInt

public static int writeVInt(java.nio.channels.WritableByteChannel wbc,
                            int value)
                     throws java.io.IOException

Throws:

java.io.IOException

readVInt

public static int readVInt(java.io.InputStream is)
                    throws java.io.IOException

Throws:

java.io.IOException

readVInt

public static int readVInt(RandomAccessFile raf)
                    throws java.io.IOException

Throws:

java.io.IOException

readFully

public static int readFully(java.io.InputStream is,
                            byte[] b)
                     throws java.io.IOException

Throws:

java.io.IOException

readAndTest

public static boolean readAndTest(java.io.InputStream is,
                                  byte[] test)
                           throws java.io.IOException

Throws:

java.io.IOException

readAndTest

public static boolean readAndTest(RandomAccessFile raf,
                                  byte[] test)
                           throws java.io.IOException

Throws:

java.io.IOException

test

public static boolean test(java.lang.Byte[] b,
                           byte[] test)
                    throws java.io.IOException

Throws:

java.io.IOException

decodeErrorMessage

public static java.lang.String decodeErrorMessage(NcStreamProto.Error err)

decodeSection

public static Section decodeSection(NcStreamProto.Section proto)

encodeDataType

public static NcStreamProto.DataType encodeDataType(DataType dtype)

decodeDataType

public static DataType decodeDataType(NcStreamProto.DataType dtype)