Class CatalogueDiscoveryMetadata
- Namespace
- EncDotNet.S100.ExchangeSets
- Assembly
- EncDotNet.S100.ExchangeSets.dll
Discovery metadata for one catalogue file (e.g. a feature or portrayal
catalogue) delivered in an exchange set — an
S100_CatalogueDiscoveryMetadata record from the exchange catalogue.
public sealed class CatalogueDiscoveryMetadata
- Inheritance
-
CatalogueDiscoveryMetadata
- Inherited Members
Remarks
S-100 Part 17. Instances are listed in CatalogueDiscoveryMetadata. Use RelativePath (or FetchCatalogueFileAsync(CatalogueDiscoveryMetadata, CancellationToken)) to locate the file. Dates are kept verbatim and are not parsed.
Properties
CompressionFlag
true when compressionFlag is true, i.e. the
stored file is ZIP-compressed; false when absent or any
other value.
public bool CompressionFlag { get; init; }
Property Value
DefaultLocaleCharacterEncoding
The codeListValue of the lan:MD_CharacterSetCode under the
record's defaultLocale, or null when absent.
public string? DefaultLocaleCharacterEncoding { get; init; }
Property Value
DefaultLocaleLanguage
The codeListValue of the lan:LanguageCode under the record's
defaultLocale, or null when absent.
public string? DefaultLocaleLanguage { get; init; }
Property Value
DigitalSignatureAlgorithm
The parsed digital signature algorithm, derived from DigitalSignatureReference.
public DigitalSignatureAlgorithm DigitalSignatureAlgorithm { get; init; }
Property Value
DigitalSignatureReference
The raw digitalSignatureReference value naming the signature
algorithm (e.g. ECDSA, ECDSA-384-SHA2), or
null when absent. The parsed form is
DigitalSignatureAlgorithm.
public string? DigitalSignatureReference { get; init; }
Property Value
DigitalSignatureValue
The digital signature value for this catalogue file, if present.
public DigitalSignatureValue? DigitalSignatureValue { get; init; }
Property Value
Remarks
S-100 Edition 5.2.1 Part 15 §15-4.2.
DigitalSignatures
All digital signatures declared for this catalogue file, in catalogue order.
public IReadOnlyList<DigitalSignatureValue> DigitalSignatures { get; init; }
Property Value
Remarks
S-100 Edition 5.2.1 Part 15 §15-8.8.
EditionNumber
The edition number (editionNumber), or null when
absent or not an integer.
public int? EditionNumber { get; init; }
Property Value
- int?
ExpectedHash
The declared cryptographic hash for this catalogue file, if the catalogue carries one. Used to integrity-check the file independently of any digital signature.
public CryptographicHash? ExpectedHash { get; init; }
Property Value
Remarks
S-100 Edition 5.2.1 Part 15 §15-8.10, Table 15-12.
FileName
The catalogue file name as declared by fileName, kept verbatim;
see RelativePath.
public required string FileName { get; init; }
Property Value
FilePath
The directory of the catalogue file relative to the exchange set
root, as declared by the catalogue's filePath element.
public string? FilePath { get; init; }
Property Value
Remarks
S-100 Edition 5.2.1 Part 17.
IssueDate
The issue date (issueDate), kept verbatim; null
when absent.
public string? IssueDate { get; init; }
Property Value
ProductSpecification
The product specification the catalogue belongs to
(productSpecification), or null when absent.
public ProductSpecification? ProductSpecification { get; init; }
Property Value
Purpose
The purpose (purpose), kept verbatim; null when absent.
public string? Purpose { get; init; }
Property Value
RelativePath
The source-relative path of the catalogue file, combining FilePath and FileName and normalizing separators, via ResolveRelativePath(string?, string). This is the path to pass to an IAssetSource.
public string RelativePath { get; }
Property Value
Scope
The catalogue scope (scope, e.g. featureCatalogue or
portrayalCatalogue), kept verbatim; null when absent.
public string? Scope { get; init; }
Property Value
VersionNumber
The catalogue version (versionNumber), kept verbatim;
null when absent.
public string? VersionNumber { get; init; }