@Deprecated
public interface IHDF5EnumBasicWriter
Modifier and Type | Method and Description |
---|---|
HDF5EnumerationType |
createEnumArray(java.lang.String objectPath,
HDF5EnumerationType enumType,
int size)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
HDF5EnumerationType |
createEnumArray(java.lang.String objectPath,
HDF5EnumerationType enumType,
long size,
HDF5IntStorageFeatures features)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
HDF5EnumerationType |
createEnumArray(java.lang.String objectPath,
HDF5EnumerationType enumType,
long size,
int blockSize)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
HDF5EnumerationType |
createEnumArray(java.lang.String objectPath,
HDF5EnumerationType enumType,
long size,
int blockSize,
HDF5IntStorageFeatures features)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
HDF5EnumerationType |
getEnumType(java.lang.String dataTypeName,
java.lang.String[] values)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
HDF5EnumerationType |
getEnumType(java.lang.String dataTypeName,
java.lang.String[] values,
boolean check)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
setEnumArrayAttribute(java.lang.String objectPath,
java.lang.String name,
HDF5EnumerationValueArray value)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
setEnumAttribute(java.lang.String objectPath,
java.lang.String name,
java.lang.Enum<?> value)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
setEnumAttribute(java.lang.String objectPath,
java.lang.String name,
HDF5EnumerationValue value)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
<T extends java.lang.Enum<T>> |
writeEnum(java.lang.String objectPath,
java.lang.Enum<T> value)
Deprecated.
Writes out an enum value.
|
void |
writeEnum(java.lang.String objectPath,
HDF5EnumerationValue value)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
writeEnum(java.lang.String objectPath,
java.lang.String[] options,
java.lang.String value)
Deprecated.
Writes out an enum value.
|
<T extends java.lang.Enum<T>> |
writeEnumArray(java.lang.String objectPath,
java.lang.Enum<T>[] data)
Deprecated.
Writes out an array of enum values.
|
void |
writeEnumArray(java.lang.String objectPath,
HDF5EnumerationValueArray data)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
writeEnumArray(java.lang.String objectPath,
HDF5EnumerationValueArray data,
HDF5IntStorageFeatures features)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
writeEnumArray(java.lang.String objectPath,
java.lang.String[] options,
java.lang.String[] data)
Deprecated.
Writes out an array of enum values.
|
void |
writeEnumArrayBlock(java.lang.String objectPath,
HDF5EnumerationValueArray data,
long blockNumber)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
void |
writeEnumArrayBlockWithOffset(java.lang.String objectPath,
HDF5EnumerationValueArray data,
int dataSize,
long offset)
Deprecated.
Use the corresponding method in
IHDF5Writer.enumeration() instead. |
@Deprecated HDF5EnumerationType getEnumType(java.lang.String dataTypeName, java.lang.String[] values) throws HDF5JavaException
IHDF5Writer.enumeration()
instead.dataTypeName
- The name of the enumeration in the HDF5 file.values
- The values of the enumeration.HDF5JavaException
- If the data type exists and is not compatible with the
values provided.@Deprecated HDF5EnumerationType getEnumType(java.lang.String dataTypeName, java.lang.String[] values, boolean check) throws HDF5JavaException
IHDF5Writer.enumeration()
instead.dataTypeName
- The name of the enumeration in the HDF5 file.values
- The values of the enumeration.check
- If true
and if the data type already exists, check whether it is
compatible with the values provided.HDF5JavaException
- If check = true
, the data type exists and is not
compatible with the values provided.@Deprecated void setEnumAttribute(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValue value)
IHDF5Writer.enumeration()
instead.
The referenced object must exist, that is it need to have been written before by one of the
write()
methods.
objectPath
- The name of the object to add the attribute to.name
- The name of the attribute.value
- The value of the attribute.@Deprecated void setEnumAttribute(java.lang.String objectPath, java.lang.String name, java.lang.Enum<?> value)
IHDF5Writer.enumeration()
instead.
The referenced object must exist, that is it need to have been written before by one of the
write()
methods.
objectPath
- The name of the object to add the attribute to.name
- The name of the attribute.value
- The value of the attribute.@Deprecated void setEnumArrayAttribute(java.lang.String objectPath, java.lang.String name, HDF5EnumerationValueArray value)
IHDF5Writer.enumeration()
instead.
The referenced object must exist, that is it need to have been written before by one of the
write()
methods.
objectPath
- The name of the object to add the attribute to.name
- The name of the attribute.value
- The value of the attribute.@Deprecated void writeEnum(java.lang.String objectPath, HDF5EnumerationValue value)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.value
- The value of the data set.<T extends java.lang.Enum<T>> void writeEnum(java.lang.String objectPath, java.lang.Enum<T> value)
objectPath
- The name (including path information) of the data set object in the file.value
- The value of the data set.void writeEnum(java.lang.String objectPath, java.lang.String[] options, java.lang.String value)
objectPath
- The name (including path information) of the data set object in the file.options
- The allowed values of the enumeration type.value
- The value of the data set.@Deprecated void writeEnumArray(java.lang.String objectPath, HDF5EnumerationValueArray data)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.data
- The data to write.<T extends java.lang.Enum<T>> void writeEnumArray(java.lang.String objectPath, java.lang.Enum<T>[] data)
objectPath
- The name (including path information) of the data set object in the file.data
- The data to write.void writeEnumArray(java.lang.String objectPath, java.lang.String[] options, java.lang.String[] data)
objectPath
- The name (including path information) of the data set object in the file.options
- The allowed values of the enumeration type.data
- The data to write.@Deprecated void writeEnumArray(java.lang.String objectPath, HDF5EnumerationValueArray data, HDF5IntStorageFeatures features)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.data
- The data to write.features
- The storage features of the data set. Note that for scaling compression the
compression factor is ignored. Instead, the scaling factor is computed from the
number of entries in the enumeration.@Deprecated HDF5EnumerationType createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, int size)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.enumType
- The enumeration type of this array.size
- The size of the byte array to create. This will be the total size for
non-extendable data sets and the size of one chunk for extendable (chunked) data
sets. For extendable data sets the initial size of the array will be 0, see
IHDF5WriterConfigurator.dontUseExtendableDataTypes()
.@Deprecated HDF5EnumerationType createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.enumType
- The enumeration type of this array.size
- The size of the enum array to create. When using extendable data sets ((see
IHDF5WriterConfigurator.dontUseExtendableDataTypes()
)), then no data set
smaller than this size can be created, however data sets may be larger.blockSize
- The size of one block (for block-wise IO). Ignored if no extendable data
sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()
).@Deprecated HDF5EnumerationType createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, int blockSize, HDF5IntStorageFeatures features)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.enumType
- The enumeration type of this array.size
- The size of the enum array to create. When using extendable data sets ((see
IHDF5WriterConfigurator.dontUseExtendableDataTypes()
)), then no data set
smaller than this size can be created, however data sets may be larger.blockSize
- The size of one block (for block-wise IO). Ignored if no extendable data
sets are used (see IHDF5WriterConfigurator.dontUseExtendableDataTypes()
).features
- The storage features of the data set.@Deprecated HDF5EnumerationType createEnumArray(java.lang.String objectPath, HDF5EnumerationType enumType, long size, HDF5IntStorageFeatures features)
IHDF5Writer.enumeration()
instead.objectPath
- The name (including path information) of the data set object in the file.enumType
- The enumeration type of this array.size
- The size of the enum array to create. This will be the total size for
non-extendable data sets and the size of one chunk for extendable (chunked) data
sets. For extendable data sets the initial size of the array will be 0, see
HDF5IntStorageFeatures
.features
- The storage features of the data set.@Deprecated void writeEnumArrayBlock(java.lang.String objectPath, HDF5EnumerationValueArray data, long blockNumber)
IHDF5Writer.enumeration()
instead.createEnumArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures)
beforehand. Obviously the HDF5EnumerationType
of the create call and this call needs
to match.
Note: For best performance, the block size in this method should be chosen to be equal
to the blockSize argument of the
createEnumArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures)
call
that was used to create the data set.
objectPath
- The name (including path information) of the data set object in the file.data
- The data to write. The value of HDF5EnumerationValueArray.getLength()
defines the block size. Must not be null
or of length 0.blockNumber
- The number of the block to write.@Deprecated void writeEnumArrayBlockWithOffset(java.lang.String objectPath, HDF5EnumerationValueArray data, int dataSize, long offset)
IHDF5Writer.enumeration()
instead.createEnumArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures)
beforehand. Obviously the HDF5EnumerationType
of the create call and this call needs
to match.
Note: For best performance, the block size in this method should be chosen to be equal
to the blockSize argument of the
createEnumArray(String, HDF5EnumerationType, long, int, HDF5IntStorageFeatures)
call
that was used to create the data set.
objectPath
- The name (including path information) of the data set object in the file.data
- The data to write. The value of HDF5EnumerationValueArray.getLength()
defines the block size. Must not be null
or of length 0.dataSize
- The (real) size of data
(needs to be
<= data.getLength()
)offset
- The offset in the data set to start writing to.