uk.ac.bristol.star.cdf.record

Class VariableDescriptorRecord

java.lang.Object

uk.ac.bristol.star.cdf.record.Record

uk.ac.bristol.star.cdf.record.VariableDescriptorRecord

Direct Known Subclasses:

VariableDescriptorRecord.RVariant, VariableDescriptorRecord.ZVariant

public abstract class VariableDescriptorRecord
extends Record

Abstract superclass for CDF Variable Descriptor Records. Two concrete subclasses exist for rVDRs and zVDRs.

Since:

19 Jun 2013

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariableDescriptorRecord.RVariant Field data for CDF record of type rVariable Descriptor Record.
static class	VariableDescriptorRecord.ZVariant Field data for CDF record of type zVariable Descriptor Record.

Field Summary

Fields

Modifier and Type	Field and Description
int	blockingFactor
long	cprOrSprOffset
int	dataType
boolean[]	dimVarys
int	flags
int	maxRec
java.lang.String	name
int	num
int	numElems
int	rfuB
int	rfuC
int	rfuF
int	sRecords
long	vdrNext
long	vxrHead
long	vxrTail
int[]	zDimSizes
int	zNumDims

Method Summary

Modifier and Type	Method and Description
long	getPadValueOffset() Returns the file offset at which this record's PadValue can be found.
int	getPadValueSize() Returns the number of bytes in the pad value.

Methods inherited from class uk.ac.bristol.star.cdf.record.Record

checkEndRecord, getBuf, getContentOffset, getRecordSize, getRecordType, getRecordTypeAbbreviation, hasBit, readIntArray, readOffsetArray, toLines, warnFormat

Methods inherited from class java.lang.Object

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

Field Detail

vdrNext

@CdfField
 @OffsetField
public final long vdrNext

dataType

@CdfField
public final int dataType

maxRec

@CdfField
public final int maxRec

vxrHead

@CdfField
 @OffsetField
public final long vxrHead

vxrTail

@CdfField
 @OffsetField
public final long vxrTail

flags

@CdfField
public final int flags

sRecords

@CdfField
public final int sRecords

rfuB

@CdfField
public final int rfuB

rfuC

@CdfField
public final int rfuC

rfuF

@CdfField
public final int rfuF

numElems

@CdfField
public final int numElems

num

@CdfField
public final int num

cprOrSprOffset

@CdfField
 @OffsetField
public final long cprOrSprOffset

blockingFactor

@CdfField
public final int blockingFactor

name

@CdfField
public final java.lang.String name

zNumDims

@CdfField
public final int zNumDims

zDimSizes

@CdfField
public final int[] zDimSizes

dimVarys

@CdfField
public final boolean[] dimVarys

Method Detail

getPadValueOffset

public long getPadValueOffset()

Returns the file offset at which this record's PadValue can be found. If there is no pad value, -1 is returned.

Returns:

pad file offset, or -1

getPadValueSize

public int getPadValueSize()

Returns the number of bytes in the pad value. If there is no pad value, 0 is returned.

Returns:

pad value size in bytes