Isomet Modular Synthesiser (iMS) API
v1.4.2
iMS API
|
Contains all the parameters that uniquely locate a File within the Synthesiser FileSystem. More...
#include <include\FileSystem.h>
Public Member Functions | |
Constructor & Destructor | |
FileSystemTableEntry () | |
Empty Constructor for FileSystemTableEntry Object. More... | |
FileSystemTableEntry (FileSystemTypes type, std::uint32_t addr, std::uint32_t length, FileDefault def) | |
Constructor for FileSystemTableEntry Object with no FileName specified. More... | |
FileSystemTableEntry (FileSystemTypes type, std::uint32_t addr, std::uint32_t length, FileDefault def, std::string name) | |
Full Constructor for FileSystemTableEntry Object with FileName. More... | |
~FileSystemTableEntry () | |
Destructor for FileSystemTableEntry. | |
FileSystemTableEntry (const FileSystemTableEntry &) | |
Copy Constructor. | |
FileSystemTableEntry & | operator= (const FileSystemTableEntry &) |
Assignment Constructor. | |
FileSystemTable entry parameter readback | |
const FileSystemTypes | Type () const |
const std::uint32_t | Address () const |
const std::uint32_t | Length () const |
const bool | IsDefault () const |
const std::string | Name () const |
Contains all the parameters that uniquely locate a File within the Synthesiser FileSystem.
A FileSystemTableEntry object stores the length, address, file type, file name and default flag status of any file stored within the Synthesiser FileSystem.
It is not normally necessary for the user application to create a FileSystemTableEntry object since this will be handled by the individual File Writing method (e.g. CompensationTableDownload::Store()), by the FileSystemManager or during IMSSytem initialisation. However the struct is useful for reading parameter data about a file entry in the table using the various const methods.
iMS::FileSystemTableEntry::FileSystemTableEntry | ( | ) |
Empty Constructor for FileSystemTableEntry Object.
iMS::FileSystemTableEntry::FileSystemTableEntry | ( | FileSystemTypes | type, |
std::uint32_t | addr, | ||
std::uint32_t | length, | ||
FileDefault | def | ||
) |
Constructor for FileSystemTableEntry Object with no FileName specified.
[in] | type | File Type of table entry |
[in] | addr | Address in FileSystem where table entry is stored |
[in] | length | number of bytes occupied by file in FileSystem |
[in] | def | Flag indicating whether File should be executed at startup |
iMS::FileSystemTableEntry::FileSystemTableEntry | ( | FileSystemTypes | type, |
std::uint32_t | addr, | ||
std::uint32_t | length, | ||
FileDefault | def, | ||
std::string | name | ||
) |
Full Constructor for FileSystemTableEntry Object with FileName.
[in] | type | File Type of table entry |
[in] | addr | Address in FileSystem where table entry is stored |
[in] | length | number of bytes occupied by file in FileSystem |
[in] | def | Flag indicating whether File should be executed at startup |
[in] | name | 8-character string given to table entry describing the contents of the file |
const std::uint32_t iMS::FileSystemTableEntry::Address | ( | ) | const |
const bool iMS::FileSystemTableEntry::IsDefault | ( | ) | const |
const std::uint32_t iMS::FileSystemTableEntry::Length | ( | ) | const |
const std::string iMS::FileSystemTableEntry::Name | ( | ) | const |
const FileSystemTypes iMS::FileSystemTableEntry::Type | ( | ) | const |