mirror of
https://github.com/TomHarte/CLK.git
synced 2024-07-15 15:29:53 +00:00
Added documentation.
This commit is contained in:
parent
6e94d0c19f
commit
f601d796f5
@ -35,18 +35,29 @@ class Drive {
|
|||||||
bool get_is_track_zero();
|
bool get_is_track_zero();
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Steps the disk head the specified number of tracks. Positive numbers step inwards, negative numbers
|
Steps the disk head the specified number of tracks. Positive numbers step inwards (i.e. away from track 0),
|
||||||
step outwards.
|
negative numbers step outwards (i.e. towards track 0).
|
||||||
*/
|
*/
|
||||||
void step(int direction);
|
void step(int direction);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
|
Sets the current read head.
|
||||||
*/
|
*/
|
||||||
void set_head(unsigned int head);
|
void set_head(unsigned int head);
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@returns @c true if the inserted disk is read-only; @c false otherwise.
|
||||||
|
*/
|
||||||
bool get_is_read_only();
|
bool get_is_read_only();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
@returns the track underneath the current head at the location now stepped to.
|
||||||
|
*/
|
||||||
std::shared_ptr<Track> get_track();
|
std::shared_ptr<Track> get_track();
|
||||||
|
|
||||||
|
/*!
|
||||||
|
Attempts to set @c track as the track underneath the current head at the location now stepped to.
|
||||||
|
*/
|
||||||
void set_track(const std::shared_ptr<Track> &track);
|
void set_track(const std::shared_ptr<Track> &track);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
|
Loading…
Reference in New Issue
Block a user