Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
List of all members
iMS::FileSystemTableEntry Struct Reference

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.
 
FileSystemTableEntryoperator= (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
 

Detailed Description

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.

Author
Dave Cowan
Date
2016-01-20
Since
1.1

Constructor & Destructor Documentation

iMS::FileSystemTableEntry::FileSystemTableEntry ( )

Empty Constructor for FileSystemTableEntry Object.

Since
1.1
iMS::FileSystemTableEntry::FileSystemTableEntry ( FileSystemTypes  type,
std::uint32_t  addr,
std::uint32_t  length,
FileDefault  def 
)

Constructor for FileSystemTableEntry Object with no FileName specified.

Parameters
[in]typeFile Type of table entry
[in]addrAddress in FileSystem where table entry is stored
[in]lengthnumber of bytes occupied by file in FileSystem
[in]defFlag indicating whether File should be executed at startup
Since
1.1
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.

Parameters
[in]typeFile Type of table entry
[in]addrAddress in FileSystem where table entry is stored
[in]lengthnumber of bytes occupied by file in FileSystem
[in]defFlag indicating whether File should be executed at startup
[in]name8-character string given to table entry describing the contents of the file
Since
1.1

Member Function Documentation

const std::uint32_t iMS::FileSystemTableEntry::Address ( ) const
Returns
Address in FileSystem memory of table entry
const bool iMS::FileSystemTableEntry::IsDefault ( ) const
Returns
true if entry is marked for execution at startup
const std::uint32_t iMS::FileSystemTableEntry::Length ( ) const
Returns
Length in bytes occupied in memory of table entry
const std::string iMS::FileSystemTableEntry::Name ( ) const
Returns
string representing descriptive file name given to table entry
const FileSystemTypes iMS::FileSystemTableEntry::Type ( ) const
Returns
File Type of table entry

The documentation for this struct was generated from the following file: