KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
data.FileData Class Reference

FileData: Base class for access of files stored in a specific folder in the local file system. More...

Detailed Description

FileData: Base class for access of files stored in a specific folder in the local file system.

Author
Daniel Wirtz
Date
2012-07-09
New in 0.6:
(Daniel Wirtz, 2012-07-09) Added this class.
Change in 0.7:
(Daniel Wirtz, 2013-03-27) Improved the modularity of FileData with more verbosity and implemented a basic "relocate" method.

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Definition at line 18 of file FileData.m.

Public Member Functions

 FileData (data_dir)
 
function  relocate (char new_root)
 Relocates this FileData instance to a different folder. More...
 
function  delete ()
 

Public Attributes

char Host = ""
 The host machine this file data is created on. More...
 
char DataDirectory = ""
 The root folder where the FileData's files are saved. More...
 
- Public Attributes inherited from handle
 addlistener
 Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...
 
 notify
 Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...
 
 delete
 Handle object destructor method that is called when the object's lifecycle ends. More...
 
 disp
 Handle object disp method which is called by the display method. See the MATLAB disp function. More...
 
 display
 Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...
 
 findobj
 Finds objects matching the specified conditions from the input array of handle objects. More...
 
 findprop
 Returns a meta.property objects associated with the specified property name. More...
 
 fields
 Returns a cell array of string containing the names of public properties. More...
 
 fieldnames
 Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...
 
 isvalid
 Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...
 
 eq
 Relational functions example. See details for more information. More...
 
 transpose
 Transposes the elements of the handle object array. More...
 
 permute
 Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...
 
 reshape
 hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...
 
 sort
 ort the handle objects in any array in ascending or descending order. More...
 

Protected Member Functions

function file = getfile (file)
 
function this = saveobj ()
 Set saved flag so that the data files do not get deleted on the delete method. More...
 

Static Protected Member Functions

static function this = loadobj (this, initfrom)
 Loads a FileData instance. More...
 

Protected Attributes

logical isSaved = false
 This flag indicates that this FileData instance has been stored to disk via the save method somewhere. More...
 

Constructor & Destructor Documentation

data.FileData.FileData (   data_dir)

Definition at line 95 of file FileData.m.

References DataDirectory, KerMor.getHost(), and Host.

Here is the call graph for this function:

Member Function Documentation

function data.FileData.delete ( )

Definition at line 120 of file FileData.m.

function file = data.FileData.getfile (   file)
protected

Definition at line 162 of file FileData.m.

References KerMor.getHost(), and Host.

Referenced by data.FileDataCollection.clear(), data.FileDataCollection.getData(), and data.FileDataCollection.getDataNr().

Here is the call graph for this function:

Here is the caller graph for this function:

function this = data.FileData.loadobj (   this,
  initfrom 
)
staticprotected

Loads a FileData instance.

Ensures that the directory associated with this FileData is existent.

Required fields of initfrom:
Generated fields of this:

Definition at line 192 of file FileData.m.

References KerMor.getHost(), Host, and isSaved.

Here is the call graph for this function:

function data.FileData.relocate ( char  new_root)

Relocates this FileData instance to a different folder.

Currently, moving it's files must be done manually.

Todo:
Implement multiple-host FileData's with different storage_root folders (per host for example)
Parameters
new_rootThe new data directory.

Definition at line 103 of file FileData.m.

References DataDirectory, KerMor.getHost(), and Host.

Referenced by data.ModelData.relocate().

Here is the call graph for this function:

Here is the caller graph for this function:

function this = data.FileData.saveobj ( )
protected

Set saved flag so that the data files do not get deleted on the delete method.

Generated fields of this:

Definition at line 178 of file FileData.m.

References isSaved.

Member Data Documentation

data.FileData.Host = ""

The host machine this file data is created on.

Default: '

Note
This property has non-standard access specifiers: SetAccess = Protected, GetAccess = Public
Matlab documentation of property attributes.

Definition at line 41 of file FileData.m.

Referenced by FileData(), getfile(), loadobj(), and relocate().

data.FileData.isSaved = false
protected

This flag indicates that this FileData instance has been stored to disk via the save method somewhere.

In subclasses, this can be used to clean up any files in the DataDirectory when the object's delete method is called.

Default: false

See Also
DataDirectory delete

Definition at line 72 of file FileData.m.

Referenced by data.FileDataCollection.delete(), loadobj(), and saveobj().


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