aaru-dps/Aaru.CommonTypes
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.CommonTypes.git synced 2025-12-16 11:14:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add flux image interfaces

Browse Source
This commit is contained in:
Rebecca Wallander
2023-02-06 12:02:18 +01:00
parent 39c2a7e230
commit 69b26f6cd5
2 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
Interfaces/IFluxImage.cs
View File

@@ -44,6 +44,15 @@ namespace Aaru.CommonTypes.Interfaces;
/// <summary>Abstract class to implement flux reading plugins.</summary>
public interface IFluxImage : IBaseImage
{
/// <summary>
/// An image may have tracks split into sub-steps. This returns the highest sub-step index for the track.
/// </summary>
/// <returns>Error number</returns>
/// <param name="head">Physical head (0-based)</param>
/// <param name="track">Physical track (position of the heads over the floppy media, 0-based)</param>
/// <param name="length">The number of captures</param>
ErrorNumber SubTrackLength(uint head, ushort track, out byte length);
/// <summary>
/// An image may have more than one capture for a specific head/track/sub-track combination. This returns
/// the amount of captures in the image for the specified head/track/sub-track combination.

7
Interfaces/IWritableFluxImage.cs
View File

@@ -46,9 +46,10 @@ public interface IWritableFluxImage : IFluxImage, IWritableImage
{
/// <summary>Writes a flux capture.</summary>
/// <returns>Error number</returns>
/// <param name="resolution">The capture's resolution (sample rate) in picoseconds</param>
/// <param name="index">Flux representation of the index signal</param>
/// <param name="data">Flux representation of the data signal</param>
/// <param name="indexResolution">The capture's index resolution (sample rate) in picoseconds</param>
/// <param name="dataResolution">The capture's data resolution (sample rate) in picoseconds</param>
/// <param name="indexBuffer">Flux representation of the index signal</param>
/// <param name="dataBuffer">Flux representation of the data signal</param>
/// <param name="head">Physical head (0-based)</param>
/// <param name="track">Physical track (position of the heads over the floppy media, 0-based)</param>
/// <param name="subTrack">Physical sub-step of track (e.g. half-track)</param>