MeVisLabToolboxReference
Public Member Functions | Public Attributes | Protected Member Functions
ml::SaveBase Class Reference

saves an ml::base-derived object to a file class SaveBase More...

#include <mlSaveBase.h>

Inheritance diagram for ml::SaveBase:
ml::Engine ml::Module ml::FieldContainer ml::Base

List of all members.

Public Member Functions

 SaveBase ()
 constructor
virtual bool saveObject (void)
 saves the input object to a file

Public Attributes

NotifyField * _fldSaveButton
 Save list.
StringField * _fldNodeName
 Name of the root node of the list when storing/restoring.
StringField * _fldSaveFileName
 Name of the file the list is to be stored in.
StringField * _fldFileStatus
 Field for status messages concerning file I/O.
StringField * _fldSaveDirName
 Name of the directory the file is to be stored in.
BoolField * _fldUseSaveDir
 Indicates whether the save dir field is used.
EnumField * _fldSaveMode
 Specifies the storage format of the list.
BoolField * _fldAutoSave
 Auto-saves the object each time the input is touched. Use with care.
BoolField * _fldUpToDate
 If true, the last saved object file is still consistent with the current object.
BoolField * _fldAllowOverwrite
 Indicates whether the specified file is overwritten if it already exists.
BaseField * _fldBaseInput
 Input connection.

Protected Member Functions

virtual void handleNotification (Field *field)
 Handle field notifications.
void _updateNodeName ()
 Reads a default node name from the input object (if present).

Detailed Description

saves an ml::base-derived object to a file class SaveBase

Definition at line 22 of file mlSaveBase.h.

Constructor & Destructor Documentation

ml::SaveBase::SaveBase ( )

constructor

Member Function Documentation

void ml::SaveBase::_updateNodeName ( ) [protected]

Reads a default node name from the input object (if present).

virtual void ml::SaveBase::handleNotification ( Field *  field) [protected, virtual]

Handle field notifications.

Reimplemented from ml::Module.

virtual bool ml::SaveBase::saveObject ( void  ) [virtual]

saves the input object to a file

Member Data Documentation

BoolField* ml::SaveBase::_fldAllowOverwrite

Indicates whether the specified file is overwritten if it already exists.

Definition at line 41 of file mlSaveBase.h.

BoolField* ml::SaveBase::_fldAutoSave

Auto-saves the object each time the input is touched. Use with care.

Definition at line 39 of file mlSaveBase.h.

BaseField* ml::SaveBase::_fldBaseInput

Input connection.

Definition at line 43 of file mlSaveBase.h.

StringField* ml::SaveBase::_fldFileStatus

Field for status messages concerning file I/O.

Definition at line 35 of file mlSaveBase.h.

StringField* ml::SaveBase::_fldNodeName

Name of the root node of the list when storing/restoring.

Definition at line 33 of file mlSaveBase.h.

NotifyField* ml::SaveBase::_fldSaveButton

Save list.

Definition at line 32 of file mlSaveBase.h.

StringField* ml::SaveBase::_fldSaveDirName

Name of the directory the file is to be stored in.

Definition at line 36 of file mlSaveBase.h.

StringField* ml::SaveBase::_fldSaveFileName

Name of the file the list is to be stored in.

Definition at line 34 of file mlSaveBase.h.

EnumField* ml::SaveBase::_fldSaveMode

Specifies the storage format of the list.

See also:
IOHandler::IO_MODE

Definition at line 38 of file mlSaveBase.h.

BoolField* ml::SaveBase::_fldUpToDate

If true, the last saved object file is still consistent with the current object.

Definition at line 40 of file mlSaveBase.h.

BoolField* ml::SaveBase::_fldUseSaveDir

Indicates whether the save dir field is used.

Definition at line 37 of file mlSaveBase.h.

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