DriveAPI

#include <VirtualC64.h>

class DriveAPI

Defined in VirtualC64.h:1316

Drive Public API

Public Attributes

Return	Name	Description
DiskAPI	disk	The disk in the drive.

---

disk

DiskAPI disk

Type: DiskAPI

Defined in VirtualC64.h:1325

The disk in the drive.

Public Methods

Return	Name	Description
const DriveConfig &	getConfig const	Returns the component's current configuration.
const DriveInfo &	getInfo const	Returns the component's current state.
const DriveInfo &	getCachedInfo const	Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).
void	insertBlankDisk	Inserts a new disk.
void	insert	Inserts a disk created from an image file.
void	insertAsync	Asynchronous version of insert(): queues the request and returns at once.
void	ejectDisk	Ejects the current disk.
void	save	Saves the current disk as an image file.
void	saveFiles	Exports the current disk to a file.

---

getConfig

const

const DriveConfig & getConfig() const

Defined in VirtualC64.h:1329

Returns the component's current configuration.

---

getInfo

const

const DriveInfo & getInfo() const

Defined in VirtualC64.h:1340

Returns the component's current state.

getInfo() reads the live state on the calling thread. The result is only consistent if the emulator is paused or suspended. getCachedInfo() returns the snapshot the emulator thread has recorded most recently, which is the one to use while the emulator runs. Both return references that can be overwritten by a later call or by the emulator thread, so copy the data if you need to keep it.

---

getCachedInfo

const

const DriveInfo & getCachedInfo() const

Defined in VirtualC64.h:1342

Returns the most recent state snapshot recorded by the emulator thread (see getInfo()).

---

insertBlankDisk

void insertBlankDisk(FSFormat fstype, string name)

Defined in VirtualC64.h:1348

Inserts a new disk.

Parameters

Parameter	Type	Description
fstype	FSFormat	The file system the disk should be formatted with.
name	string	A PET string with the name of the new disk.

---

insert

void insert(const std::filesystem::path & path, bool wp)

Defined in VirtualC64.h:1356

Inserts a disk created from an image file.

Parameters

Parameter	Type	Description
path	const std::filesystem::path &	Path to the disk image.
wp	bool	Write-protection status of the disk.

Exceptions

Exception	Description
Error	if the file cannot be read or does not contain valid data.

---

insertAsync

void insertAsync(const std::filesystem::path & path, bool wp)

Defined in VirtualC64.h:1363

Asynchronous version of insert(): queues the request and returns at once.

The file is read on the emulator thread. Success and failure are both reported by the usual message (e.g., CRT_ATTACHED). If the request failed, the message carries the exception.

---

ejectDisk

void ejectDisk()

Defined in VirtualC64.h:1367

Ejects the current disk.

---

save

void save(const std::filesystem::path & path)

Defined in VirtualC64.h:1372

Saves the current disk as an image file.

Parameters

Parameter	Type	Description
path	const std::filesystem::path &	Path to the destination file.

---

saveFiles

void saveFiles(const std::filesystem::path & path)

Defined in VirtualC64.h:1377

Exports the current disk to a file.

Parameters

Parameter	Type	Description
path	const std::filesystem::path &	Path to the destination folder.