ADR

java.lang.Object
- gov.nasa.gsfc.spdf.cdfj.ADR

```
public class ADR
extends java.lang.Object
```
Attribute Descriptor Record
Information about an attribute

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AADR_SCOPE_FIELD_OFFSET` The Constant AADR_SCOPE_FIELD_OFFSET.
`static int`	`ADR_ADR_NEXT_FIELD_LENGTH` The Constant ADR_ADR_NEXT_FIELD_LENGTH.
`static int`	`ADR_ADR_NEXT_FIELD_OFFSET` The Constant ADR_ADR_NEXT_FIELD_OFFSET.
`static int`	`ADR_AGR_EDR_HEAD_FIELD_LENGTH` The Constant ADR_AGR_EDR_HEAD_FIELD_LENGTH.
`static int`	`ADR_AGR_EDR_HEAD_FIELD_OFFSET` The Constant ADR_AGR_EDR_HEAD_FIELD_OFFSET.
`static int`	`ADR_AZ_EDR_HEAD_FIELD_LENGTH` The Constant ADR_AZ_EDR_HEAD_FIELD_LENGTH.
`static int`	`ADR_AZ_EDR_HEAD_FIELD_OFFSET` The Constant ADR_AZ_EDR_HEAD_FIELD_OFFSET.
`static int`	`ADR_GLOBAL_SCOPE` The Constant ADR_GLOBAL_SCOPE.
`static int`	`ADR_GLOBAL_SCOPE_ASSUMED` The Constant ADR_GLOBAL_SCOPE_ASSUMED.
`static int`	`ADR_MAX_GR_ENTRY_FIELD_LENGTH` The Constant ADR_MAX_GR_ENTRY_FIELD_LENGTH.
`static int`	`ADR_MAX_GR_ENTRY_FIELD_OFFSET` The Constant ADR_MAX_GR_ENTRY_FIELD_OFFSET
`static int`	`ADR_MAX_Z_ENTRIES_FIELD_LENGTH` The Constant ADR_MAX_Z_ENTRIES_FIELD_LENGTH.
`static int`	`ADR_MAX_Z_ENTRIES_FIELD_OFFSET` The Constant ADR_MAX_Z_ENTRIES_FIELD_OFFSET.
`static int`	`ADR_NAME_FIELD_LENGTH` The Constant ADR_NAME_FIELD_LENGTH.
`static int`	`ADR_NAME_FIELD_OFFSET` The Constant ADR_NAME_FIELD_OFFSET.
`static int`	`ADR_NGR_ENTRIES_FIELD_LENGTH` The Constant ADR_NGR_ENTRIES_FIELD_LENGTH.
`static int`	`ADR_NGR_ENTRIES_FIELD_OFFSET` The Constant ADR_NGR_ENTRIES_FIELD_OFFSET.
`static int`	`ADR_NUM_FIELD_LENGTH` The Constant ADR_NUM_FIELD_LENGTH.
`static int`	`ADR_NUM_FIELD_OFFSET` The Constant ADR_NUM_FIELD_OFFSET.
`static int`	`ADR_NZ_ENTRIES_FIELD_LENGTH` The Constant ADR_AZ_EDR_HEAD_FIELD_LENGTH.
`static int`	`ADR_NZ_ENTRIES_FIELD_OFFSET` The Constant ADR_AZ_EDR_HEAD_FIELD_OFFSET.
`static int`	`ADR_RECORD_SIZE` The Constant ADR_RECORD_SIZE.
`static int`	`ADR_RECORD_SIZE_FIELD_LENGTH` The Constant ADR_RECORD_SIZE_FIELD_BYTE_LEN.
`static int`	`ADR_RECORD_SIZE_FIELD_OFFSET` The Constant ADR_RECORD_SIZE_FIELD_OFFSET.
`static int`	`ADR_RECORD_TYPE_FIELD_LENGTH` The Constant ADR_RECORD_TYPE_FIELD_BYTE_LEN.
`static int`	`ADR_RECORD_TYPE_ID` The Constant ADR_RECORD_TYPE_ID.
`static int`	`ADR_RECORD_TYPE_OFFSET` The Constant ADR_RECORD_TYPE_FIELD_OFFSET.
`static int`	`ADR_RFUA_FIELD_LENGTH` The Constant ADR_RFUA_FIELD_LENGTH.
`static int`	`ADR_RFUA_FIELD_OFFSET` The Constant ADR_RFUA_FIELD_OFFSET.
`static int`	`ADR_RFUE_FIELD_LENGTH` The Constant ADR_RFUE_FIELD_LENGTH.
`static int`	`ADR_RFUE_FIELD_OFFSET` The Constant ADR_RFUE_FIELD_OFFSET.
`static int`	`ADR_SCOPE_FIELD_LENGTH` The Constant ADR_SCOPE_FIELD_LENGTH.
`static int`	`ADR_VARIABLE_SCOPE` The Constant ADR_VARIABLE_SCOPE.
`static int`	`ADR_VARIABLE_SCOPE_ASSUMED` The Constant ADR_VARIABLE_SCOPE_ASSUMED.
`protected java.lang.String`	`name` The name.
`protected int`	`num` The num.
`protected byte[]`	`paddedName` The padded name.
`protected long`	`position` The position.

Constructor Summary

Constructors
Constructor and Description

ADR()

Constructors
Constructor and Description
`ADR()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.nio.ByteBuffer`	`get()` Gets the.
`byte[]`	`getNameBytes(java.lang.String s)` Gets the name bytes.
`int`	`getSize()` Gets the size.
`void`	`setADRNext(long aDRNext)` Sets the ADR next.
`void`	`setAgrEDRHead(long agrEDRHead)` Sets the agr EDR head.
`void`	`setAzEDRHead(long azEDRHead)` Sets the az EDR head.
`void`	`setMAXgrEntry(int mAXgrEntry)` Sets the Max gr entry.
`void`	`setMAXzEntry(int mAXzEntry)` Sets the Max z entry.
`void`	`setName(java.lang.String name)` Sets the name.
`void`	`setNgrEntries(int ngrEntries)` Sets the ngr entries.
`void`	`setNum(int num)` Sets the num.
`void`	`setNzEntries(int nzEntries)` Sets the nz entries.
`void`	`setScope(int scope)` Sets the scope.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ADR_RECORD_TYPE_ID
```
public static final int ADR_RECORD_TYPE_ID
```
    The Constant ADR_RECORD_TYPE_ID.
    
    See Also:
    
    Constant Field Values
  - ADR_RECORD_SIZE_FIELD_OFFSET
```
public static final int ADR_RECORD_SIZE_FIELD_OFFSET
```
    The Constant ADR_RECORD_SIZE_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_RECORD_SIZE_FIELD_LENGTH
```
public static final int ADR_RECORD_SIZE_FIELD_LENGTH
```
    The Constant ADR_RECORD_SIZE_FIELD_BYTE_LEN.
    
    See Also:
    
    Constant Field Values
  - ADR_RECORD_TYPE_OFFSET
```
public static final int ADR_RECORD_TYPE_OFFSET
```
    The Constant ADR_RECORD_TYPE_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_RECORD_TYPE_FIELD_LENGTH
```
public static final int ADR_RECORD_TYPE_FIELD_LENGTH
```
    The Constant ADR_RECORD_TYPE_FIELD_BYTE_LEN.
    
    See Also:
    
    Constant Field Values
  - ADR_ADR_NEXT_FIELD_OFFSET
```
public static final int ADR_ADR_NEXT_FIELD_OFFSET
```
    The Constant ADR_ADR_NEXT_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_ADR_NEXT_FIELD_LENGTH
```
public static final int ADR_ADR_NEXT_FIELD_LENGTH
```
    The Constant ADR_ADR_NEXT_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_AGR_EDR_HEAD_FIELD_OFFSET
```
public static final int ADR_AGR_EDR_HEAD_FIELD_OFFSET
```
    The Constant ADR_AGR_EDR_HEAD_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_AGR_EDR_HEAD_FIELD_LENGTH
```
public static final int ADR_AGR_EDR_HEAD_FIELD_LENGTH
```
    The Constant ADR_AGR_EDR_HEAD_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - AADR_SCOPE_FIELD_OFFSET
```
public static final int AADR_SCOPE_FIELD_OFFSET
```
    The Constant AADR_SCOPE_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_SCOPE_FIELD_LENGTH
```
public static final int ADR_SCOPE_FIELD_LENGTH
```
    The Constant ADR_SCOPE_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_GLOBAL_SCOPE
```
public static final int ADR_GLOBAL_SCOPE
```
    The Constant ADR_GLOBAL_SCOPE.
    
    See Also:
    
    Constant Field Values
  - ADR_VARIABLE_SCOPE
```
public static final int ADR_VARIABLE_SCOPE
```
    The Constant ADR_VARIABLE_SCOPE.
    
    See Also:
    
    Constant Field Values
  - ADR_GLOBAL_SCOPE_ASSUMED
```
public static final int ADR_GLOBAL_SCOPE_ASSUMED
```
    The Constant ADR_GLOBAL_SCOPE_ASSUMED.
    
    See Also:
    
    Constant Field Values
  - ADR_VARIABLE_SCOPE_ASSUMED
```
public static final int ADR_VARIABLE_SCOPE_ASSUMED
```
    The Constant ADR_VARIABLE_SCOPE_ASSUMED.
    
    See Also:
    
    Constant Field Values
  - ADR_NUM_FIELD_OFFSET
```
public static final int ADR_NUM_FIELD_OFFSET
```
    The Constant ADR_NUM_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_NUM_FIELD_LENGTH
```
public static final int ADR_NUM_FIELD_LENGTH
```
    The Constant ADR_NUM_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_NGR_ENTRIES_FIELD_OFFSET
```
public static final int ADR_NGR_ENTRIES_FIELD_OFFSET
```
    The Constant ADR_NGR_ENTRIES_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_NGR_ENTRIES_FIELD_LENGTH
```
public static final int ADR_NGR_ENTRIES_FIELD_LENGTH
```
    The Constant ADR_NGR_ENTRIES_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_MAX_GR_ENTRY_FIELD_OFFSET
```
public static final int ADR_MAX_GR_ENTRY_FIELD_OFFSET
```
    The Constant ADR_MAX_GR_ENTRY_FIELD_OFFSET
    
    See Also:
    
    Constant Field Values
  - ADR_MAX_GR_ENTRY_FIELD_LENGTH
```
public static final int ADR_MAX_GR_ENTRY_FIELD_LENGTH
```
    The Constant ADR_MAX_GR_ENTRY_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_RFUA_FIELD_OFFSET
```
public static final int ADR_RFUA_FIELD_OFFSET
```
    The Constant ADR_RFUA_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_RFUA_FIELD_LENGTH
```
public static final int ADR_RFUA_FIELD_LENGTH
```
    The Constant ADR_RFUA_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_AZ_EDR_HEAD_FIELD_OFFSET
```
public static final int ADR_AZ_EDR_HEAD_FIELD_OFFSET
```
    The Constant ADR_AZ_EDR_HEAD_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_AZ_EDR_HEAD_FIELD_LENGTH
```
public static final int ADR_AZ_EDR_HEAD_FIELD_LENGTH
```
    The Constant ADR_AZ_EDR_HEAD_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_NZ_ENTRIES_FIELD_OFFSET
```
public static final int ADR_NZ_ENTRIES_FIELD_OFFSET
```
    The Constant ADR_AZ_EDR_HEAD_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_NZ_ENTRIES_FIELD_LENGTH
```
public static final int ADR_NZ_ENTRIES_FIELD_LENGTH
```
    The Constant ADR_AZ_EDR_HEAD_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_MAX_Z_ENTRIES_FIELD_OFFSET
```
public static final int ADR_MAX_Z_ENTRIES_FIELD_OFFSET
```
    The Constant ADR_MAX_Z_ENTRIES_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_MAX_Z_ENTRIES_FIELD_LENGTH
```
public static final int ADR_MAX_Z_ENTRIES_FIELD_LENGTH
```
    The Constant ADR_MAX_Z_ENTRIES_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_RFUE_FIELD_OFFSET
```
public static final int ADR_RFUE_FIELD_OFFSET
```
    The Constant ADR_RFUE_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_RFUE_FIELD_LENGTH
```
public static final int ADR_RFUE_FIELD_LENGTH
```
    The Constant ADR_RFUE_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_NAME_FIELD_OFFSET
```
public static final int ADR_NAME_FIELD_OFFSET
```
    The Constant ADR_NAME_FIELD_OFFSET.
    
    See Also:
    
    Constant Field Values
  - ADR_NAME_FIELD_LENGTH
```
public static final int ADR_NAME_FIELD_LENGTH
```
    The Constant ADR_NAME_FIELD_LENGTH.
    
    See Also:
    
    Constant Field Values
  - ADR_RECORD_SIZE
```
public static final int ADR_RECORD_SIZE
```
    The Constant ADR_RECORD_SIZE.
    
    See Also:
    
    Constant Field Values
  - name
```
protected java.lang.String name
```
    The name.
  - paddedName
```
protected byte[] paddedName
```
    The padded name.
  - num
```
protected int num
```
    The num.
  - position
```
protected long position
```
    The position.
- Constructor Detail
  - ADR
```
public ADR()
```
- Method Detail
  - get
```
public java.nio.ByteBuffer get()
```
    Gets the.
    
    Returns:
    
    the byte buffer
  - getNameBytes
```
public byte[] getNameBytes(java.lang.String s)
```
    Gets the name bytes.
    
    Parameters:
    
    s - the s
    
    Returns:
    
    the name bytes
  - getSize
```
public int getSize()
```
    Gets the size.
    
    Returns:
    
    the size
  - setADRNext
```
public void setADRNext(long aDRNext)
```
    Sets the ADR next.
    The file offset of the next ADR.
    Signed 8-byte integer, big-endian byte ordering.
    Beginning with CDF V2.1 the last ADR will contain a file offset of 0x0000000000000000 in this field (to indicate the end of the ADRs).
    Prior to CDF V2.1 this file offset is undefined in the last ADR.
    
    Parameters:
    
    aDRNext - the new ADR next
  - setAgrEDRHead
```
public void setAgrEDRHead(long agrEDRHead)
```
    Sets the agr EDR head.
    The file offset of the first Attribute g/rEntry Descriptor Record (AgrEDR) for this attribute.
    Signed 8-byte integer, big-endian byte ordering.
    The first AgrEDR contains a file offset to the next AgrEDR and so on. An AgrEDR will exist for each g/rEntry for this attribute. This field will contain 0x0000000000000000 if the attribute has no g/rEntries. Beginning with CDF V2.1 the last AgrEDR will contain a file offset of 0x0000000000000000 for the file offset of the next AgrEDR (to indicate the end of 11the AgrEDRs).
    Prior to CDF V2.1 the “next AgrEDR" file offset in the last AgrEDR is undefined.
    Note that the term g/rEntry is used to refer to an entry that may be either a gEntry or an rEntry.
    The type of entry described by an AgrEDR depends on the scope of the corresponding attribute.
    AgrEDRs of a global-scoped attribute describe gEntries.
    AgrEDRs of a variable-scoped attribute describe rEntries.
    
    Parameters:
    
    agrEDRHead - the new agr EDR head
  - setAzEDRHead
```
public void setAzEDRHead(long azEDRHead)
```
    Sets the az EDR head.
    The file offset of the first Attribute zEntry Descriptor Record (AzEDR) for this attribute.
    Signed 8-byte integer, big-endian byte ordering.
    The first AzEDR contains a file offset to the next AzEDR and so on.
    An AzEDR will exist for each zEntry for this attribute.
    This field will contain 0x0000000000000000 if this attribute has no zEntries.
    The last AzEDR will contain a file offset of 0x0000000000000000 for the file offset of the next AzEDR (to indicate the end of the AzEDRs).
    
    Parameters:
    
    azEDRHead - the new az EDR head
  - setMAXgrEntry
```
public void setMAXgrEntry(int mAXgrEntry)
```
    Sets the Max gr entry.
    The maximum numbered g/rEntry for this attribute.
    Signed 4-byte integer, big-endian byte ordering.
    g/rEntries are numbered beginning with zero (0).
    If there are no g/rEntries, this field will contain negative one (-1).
    
    Parameters:
    
    mAXgrEntry - the new MA xgr entry
  - setMAXzEntry
```
public void setMAXzEntry(int mAXzEntry)
```
    Sets the Max z entry.
    The maximum numbered zEntry for this attribute.
    Signed 4-byte integer, big-endian byte ordering.
    zEntries are numbered beginning with zero (0).
    Prior to CDF V2.2 this field will always contain a value of negative one (-1).
    
    Parameters:
    
    mAXzEntry - the new MA xz entry
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name.
    The name of this attribute.
    Character string, ASCII character set.
    This field is always 256 bytes in length.
    If the number of characters in the name is less than 256, a NUL character (0x00) will be used to terminate the string.
    In that case, the characters beyond the NUL-terminator (up to the size of this field) are undefined.
    
    Parameters:
    
    name - the new name, may not be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the name is longer than ADR_NAME_LENGTH.
  - setNgrEntries
```
public void setNgrEntries(int ngrEntries)
```
    Sets the ngr entries.
    The number of g/rEntries for this attribute.
    Signed 4-byte integer, big-endian byte ordering.
    
    Parameters:
    
    ngrEntries - the new ngr entries
  - setNum
```
public void setNum(int num)
```
    Sets the num.
    This attribute's number.
    Signed 4-byte integer, big-endian byte ordering.
    Attributes are numbered beginning with zero (0)
    
    Parameters:
    
    num - the new num
  - setNzEntries
```
public void setNzEntries(int nzEntries)
```
    Sets the nz entries.
    The number of zEntries for this attribute.
    Signed 4-byte integer, big-endian byte ordering.
    Prior to CDF V2.2 this field will always contain a value of zero (0).
    
    Parameters:
    
    nzEntries - the new nz entries
  - setScope
```
public void setScope(int scope)
```
    Sets the scope.
    The intended scope of this attribute.
    Signed 4-byte integer, big-endian byte ordering.
    The following internal values are valid:
    1 Global scope.
    2 Variable scope.
    3 Global scope assumed.
    4 Variable scope assumed.
    
    Parameters:
    
    scope - the new scope
    
    Throws:
    
    {@link - IllegalArgumentException} if the supplied scope is not 1, 2, 3,or 4;

Class ADR

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADR_RECORD_TYPE_ID

ADR_RECORD_SIZE_FIELD_OFFSET

ADR_RECORD_SIZE_FIELD_LENGTH

ADR_RECORD_TYPE_OFFSET

ADR_RECORD_TYPE_FIELD_LENGTH

ADR_ADR_NEXT_FIELD_OFFSET

ADR_ADR_NEXT_FIELD_LENGTH

ADR_AGR_EDR_HEAD_FIELD_OFFSET

ADR_AGR_EDR_HEAD_FIELD_LENGTH

AADR_SCOPE_FIELD_OFFSET

ADR_SCOPE_FIELD_LENGTH

ADR_GLOBAL_SCOPE

ADR_VARIABLE_SCOPE

ADR_GLOBAL_SCOPE_ASSUMED

ADR_VARIABLE_SCOPE_ASSUMED

ADR_NUM_FIELD_OFFSET

ADR_NUM_FIELD_LENGTH

ADR_NGR_ENTRIES_FIELD_OFFSET

ADR_NGR_ENTRIES_FIELD_LENGTH

ADR_MAX_GR_ENTRY_FIELD_OFFSET

ADR_MAX_GR_ENTRY_FIELD_LENGTH

ADR_RFUA_FIELD_OFFSET

ADR_RFUA_FIELD_LENGTH

ADR_AZ_EDR_HEAD_FIELD_OFFSET

ADR_AZ_EDR_HEAD_FIELD_LENGTH

ADR_NZ_ENTRIES_FIELD_OFFSET

ADR_NZ_ENTRIES_FIELD_LENGTH

ADR_MAX_Z_ENTRIES_FIELD_OFFSET

ADR_MAX_Z_ENTRIES_FIELD_LENGTH

ADR_RFUE_FIELD_OFFSET

ADR_RFUE_FIELD_LENGTH

ADR_NAME_FIELD_OFFSET

ADR_NAME_FIELD_LENGTH

ADR_RECORD_SIZE

name

paddedName

num

position

Constructor Detail

ADR

Method Detail

get

getNameBytes

getSize

setADRNext

setAgrEDRHead

setAzEDRHead

setMAXgrEntry

setMAXzEntry

setName

setNgrEntries

setNum

setNzEntries

setScope