HDF5CompoundType (jhdf5 19.04.1 API)

java.lang.Object
- ch.systemsx.cisd.hdf5.HDF5DataType
- - ch.systemsx.cisd.hdf5.HDF5CompoundType<T>

```
public class HDF5CompoundType<T>
extends HDF5DataType
```
The definition of a HDF5 compound type. For information on how to create and work with compound types, have a look at IHDF5CompoundInformationRetriever. The simplest way of creating a compound type for a Java class, is IHDF5CompoundInformationRetriever.getInferredType(Class).
Once you have a compound type, you may use methods like IHDF5CompoundReader.read(String, HDF5CompoundType) and IHDF5CompoundWriter.write(String, HDF5CompoundType, Object) and to read and write them.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`checkMappingComplete()` Checks whether the mapping between the on-disk representation and the in-memory representation is complete.
`HDF5CompoundMemberInformation[]`	`getCompoundMemberInformation()` Returns an array with the `HDF5CompoundMemberInformation` of all compound members.
`HDF5CompoundMemberInformation[]`	`getCompoundMemberInformation(HDF5DataTypeInformation.DataTypeInfoOptions options)` Returns an array with the `HDF5CompoundMemberInformation` of all compound members.
`java.lang.Class<T>`	`getCompoundType()` Returns the Java type of the compound.
`java.util.Map<java.lang.String,HDF5EnumerationType>`	`getEnumTypeMap()` Returns the map of member names to enumeration types (only enum members will have an entry in the map).
`java.lang.String`	`getMemberName(int idx)` Returns the name of compound member `idx`.
`int`	`getMemberOffsetInMemory(int idx)` Returns the memory offset (within the record) of compound member `idx` (in bytes).
`int`	`getMemberOffSetOnDisk(int idx)` Returns the disk offset (within the record) of compound member `idx` (in bytes).
`int`	`getMemberSize(int idx)` Returns the size of compound member `idx` (in bytes).
`int`	`getNumberOfMembers()` Returns the number of compound members.
`int`	`getRecordSizeInMemory()` Returns the size of the record in memory (in bytes).
`int`	`getRecordSizeOnDisk()` Returns the size of the record on disk (in bytes).
`HDF5CompoundMemberInformation[]`	`getUnmappedCompoundMemberInformation()` Returns an with the `HDF5CompoundMemberInformation` of compound members that are not mapped to the in-memory representation.
`java.lang.String[]`	`getUnmappedCompoundMemberNames()` Returns an array with the names of compound members that are not mapped to the in-memory representation.
`java.lang.String[]`	`getUnmappedFieldNames()` Returns an array with names of fields of the in-memory representation that do not map to any compound member in the on-disk representation.
`boolean`	`isDiskRepresentationIncomplete()` Returns `true` if there are fields in the in-memory representation that are not mapped to any compound member in the on-disk representation.
`boolean`	`isMappingIncomplete()` Returns `true`, if the mapping between the in-memory and the on-disk representation is incomplete, that is if either `isDiskRepresentationIncomplete()` or `isMemoryRepresentationIncomplete()` returns `true`.
`boolean`	`isMemoryRepresentationIncomplete()` Returns `true` if there are compound members in the on-disk representation that are not mapped to fields in the in-memory representation.
`boolean`	`isRequireTypesToBeEqual()` Returns `true`, if this type is expected to be equal to the type of a data set it is used to read.
`java.lang.String`	`toString()`
`java.lang.String`	`tryGetName()` Returns a name for this type, or `null` if this type has no name.

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5DataType
equals, getDataTypeInformation, getDataTypeInformation, getName, hashCode, tryGetDataTypePath

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getCompoundType
```
public java.lang.Class<T> getCompoundType()
```
    Returns the Java type of the compound.
  - getRecordSizeOnDisk
```
public int getRecordSizeOnDisk()
```
    Returns the size of the record on disk (in bytes).
  - getRecordSizeInMemory
```
public int getRecordSizeInMemory()
```
    Returns the size of the record in memory (in bytes).
  - getNumberOfMembers
```
public int getNumberOfMembers()
```
    Returns the number of compound members.
  - getMemberName
```
public java.lang.String getMemberName(int idx)
```
    Returns the name of compound member idx.
  - getMemberSize
```
public int getMemberSize(int idx)
```
    Returns the size of compound member idx (in bytes).
  - getMemberOffSetOnDisk
```
public int getMemberOffSetOnDisk(int idx)
```
    Returns the disk offset (within the record) of compound member idx (in bytes).
  - getMemberOffsetInMemory
```
public int getMemberOffsetInMemory(int idx)
```
    Returns the memory offset (within the record) of compound member idx (in bytes).
  - getCompoundMemberInformation
```
public HDF5CompoundMemberInformation[] getCompoundMemberInformation()
```
    Returns an array with the HDF5CompoundMemberInformation of all compound members.
  - getCompoundMemberInformation
```
public HDF5CompoundMemberInformation[] getCompoundMemberInformation(HDF5DataTypeInformation.DataTypeInfoOptions options)
```
    Returns an array with the HDF5CompoundMemberInformation of all compound members.
  - isMappingIncomplete
```
public boolean isMappingIncomplete()
```
    Returns true, if the mapping between the in-memory and the on-disk representation is incomplete, that is if either isDiskRepresentationIncomplete() or isMemoryRepresentationIncomplete() returns true.
  - isMemoryRepresentationIncomplete
```
public boolean isMemoryRepresentationIncomplete()
```
    Returns true if there are compound members in the on-disk representation that are not mapped to fields in the in-memory representation.
  - isRequireTypesToBeEqual
```
public boolean isRequireTypesToBeEqual()
```
    Returns true, if this type is expected to be equal to the type of a data set it is used to read.
  - getUnmappedCompoundMemberNames
```
public java.lang.String[] getUnmappedCompoundMemberNames()
```
    Returns an array with the names of compound members that are not mapped to the in-memory representation. If no members are unmapped, an empty array is returned.
  - getUnmappedCompoundMemberInformation
```
public HDF5CompoundMemberInformation[] getUnmappedCompoundMemberInformation()
```
    Returns an with the HDF5CompoundMemberInformation of compound members that are not mapped to the in-memory representation. If no members are unmapped, an empty array is returned.
  - isDiskRepresentationIncomplete
```
public boolean isDiskRepresentationIncomplete()
```
    Returns true if there are fields in the in-memory representation that are not mapped to any compound member in the on-disk representation.
  - checkMappingComplete
```
public void checkMappingComplete()
                          throws HDF5JavaException
```
    Checks whether the mapping between the on-disk representation and the in-memory representation is complete.
    
    Throws:
    
    HDF5JavaException - if isMappingIncomplete() returns true.
  - getUnmappedFieldNames
```
public java.lang.String[] getUnmappedFieldNames()
```
    Returns an array with names of fields of the in-memory representation that do not map to any compound member in the on-disk representation.
  - tryGetName
```
public java.lang.String tryGetName()
```
    Description copied from class: HDF5DataType
    
    Returns a name for this type, or null if this type has no name.
    
    Specified by:
    
    tryGetName in class HDF5DataType
  - getEnumTypeMap
```
public java.util.Map<java.lang.String,HDF5EnumerationType> getEnumTypeMap()
```
    Returns the map of member names to enumeration types (only enum members will have an entry in the map).
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class HDF5CompoundType<T>

Method Summary

Methods inherited from class ch.systemsx.cisd.hdf5.HDF5DataType

Methods inherited from class java.lang.Object

Method Detail

getCompoundType

getRecordSizeOnDisk

getRecordSizeInMemory

getNumberOfMembers

getMemberName

getMemberSize

getMemberOffSetOnDisk

getMemberOffsetInMemory

getCompoundMemberInformation

getCompoundMemberInformation

isMappingIncomplete

isMemoryRepresentationIncomplete

isRequireTypesToBeEqual

getUnmappedCompoundMemberNames

getUnmappedCompoundMemberInformation

isDiskRepresentationIncomplete

checkMappingComplete

getUnmappedFieldNames

tryGetName

getEnumTypeMap

toString