Class Hdf5RequiredAttributeExtensions

Namespace

EncDotNet.S100.Hdf5

Assembly

EncDotNet.S100.Core.dll

Extension methods that translate PureHDF's Could not find attribute '{name}' failure (and equivalent "missing" exceptions from other backends) into typed S100DatasetSchemaExceptions carrying spec context. Reader implementations call these for attributes that are required by the spec; optional attributes should still be guarded with AttributeExists(string).

public static class Hdf5RequiredAttributeExtensions

Inheritance

object

Hdf5RequiredAttributeExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ReadRequiredDateTimeAttribute(IHdf5Group, string, string, string?, string, string?)

Reads a required ISO 8601 date or date-time string attribute (such as timePoint or dateTimeOfFirstRecord) from group as a UTC time, using the grammar of TryParseDateOrDateTime(string?, out DateTime). Throws S100DatasetSchemaException if the attribute is missing or its value is not such a date or date-time.

public static DateTime ReadRequiredDateTimeAttribute(this IHdf5Group group, string name, string product, string? file, string groupPath, string? specReference)

Parameters

group IHdf5Group

name string

product string

file string

groupPath string

specReference string

Returns

DateTime

ReadRequiredDoubleAttribute(IHdf5Group, string, string, string?, string, string?)

Reads a required floating-point attribute from group. Throws S100DatasetSchemaException if the attribute is missing, preserving the underlying exception as InnerException.

public static double ReadRequiredDoubleAttribute(this IHdf5Group group, string name, string product, string? file, string groupPath, string? specReference)

Parameters

group IHdf5Group

name string

product string

file string

groupPath string

specReference string

Returns

double

ReadRequiredInt64Attribute(IHdf5Group, string, string, string?, string, string?)

Reads a required fixed-point attribute from group. Throws S100DatasetSchemaException if the attribute is missing.

public static long ReadRequiredInt64Attribute(this IHdf5Group group, string name, string product, string? file, string groupPath, string? specReference)

Parameters

group IHdf5Group

name string

product string

file string

groupPath string

specReference string

Returns

long

ReadRequiredStringAttribute(IHdf5Group, string, string, string?, string, string?)

Reads a required string attribute from group. Throws S100DatasetSchemaException if the attribute is missing.

public static string ReadRequiredStringAttribute(this IHdf5Group group, string name, string product, string? file, string groupPath, string? specReference)

Parameters

group IHdf5Group

name string

product string

file string

groupPath string

specReference string

Returns

string