MeVisLabToolboxReference
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
ml::LoadBase Class Reference

Allows to load ml::base-derived objects from file. More...

#include <mlLoadBase.h>

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

List of all members.

Public Types

enum  AutoUpdateMode { AutoUpdateModeDoNothing = 0, AutoUpdateModeAutoClear, AutoUpdateModeAutoUpdate, AutoUpdateModeCount }
 auto update mode enum More...

Public Member Functions

 LoadBase ()
 constructor:
 ~LoadBase ()
 destructor:
virtual bool loadObject (void)
 loads a new object
virtual void deleteObject (void)
 deletes the current object

Public Attributes

EnumField * _fldAutoUpdateMode
 Auto-load mode. Use anything other than Auto-Delete with care.
NotifyField * _fldDeleteButton
 Delete loaded object.
NotifyField * _fldLoadButton
 Load object.
StringField * _fldNodeName
 Name of the root node of the object when storing/restoring.
StringField * _fldLoadFileName
 Name of the file the object is to be restored from.
StringField * _fldLoadDirName
 Name of the directory the file is to be restored from.
BoolField * _fldUseLoadDir
 Indicates whether the load dir field is used.
StringField * _fldFileStatus
 Field for status messages concerning file I/O.
EnumField * _fldLoadMode
 Specifies the file format for the object.
BoolField * _fldUpToDate
 Indicates whether the current output corresponds to the filename.
BaseField * _fldBaseOutput
 Output connection.

Protected Member Functions

virtual void handleNotification (Field *field)
 Handle field notifications.
virtual void activateAttachments ()
 resets fldUpToDate, calls handleNotification once after the module is loaded on the network and all field values are assigned.

Protected Attributes

Base * _outputObject
 object behind _fldBaseOutput

Detailed Description

Allows to load ml::base-derived objects from file.

class LoadBase

Definition at line 22 of file mlLoadBase.h.

Member Enumeration Documentation

enum ml::LoadBase::AutoUpdateMode

auto update mode enum

Enumerator:
AutoUpdateModeDoNothing 
AutoUpdateModeAutoClear 
AutoUpdateModeAutoUpdate 
AutoUpdateModeCount 

Definition at line 27 of file mlLoadBase.h.

Constructor & Destructor Documentation

ml::LoadBase::LoadBase ( )

constructor:

ml::LoadBase::~LoadBase ( )

destructor:

Member Function Documentation

virtual void ml::LoadBase::activateAttachments ( ) [protected, virtual]

resets fldUpToDate, calls handleNotification once after the module is loaded on the network and all field values are assigned.

Reimplemented from ml::FieldContainer.

virtual void ml::LoadBase::deleteObject ( void  ) [virtual]

deletes the current object

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

Handle field notifications.

Reimplemented from ml::Module.

virtual bool ml::LoadBase::loadObject ( void  ) [virtual]

loads a new object

Member Data Documentation

EnumField* ml::LoadBase::_fldAutoUpdateMode

Auto-load mode. Use anything other than Auto-Delete with care.

Definition at line 46 of file mlLoadBase.h.

BaseField* ml::LoadBase::_fldBaseOutput

Output connection.

Definition at line 58 of file mlLoadBase.h.

NotifyField* ml::LoadBase::_fldDeleteButton

Delete loaded object.

Definition at line 47 of file mlLoadBase.h.

StringField* ml::LoadBase::_fldFileStatus

Field for status messages concerning file I/O.

Definition at line 53 of file mlLoadBase.h.

NotifyField* ml::LoadBase::_fldLoadButton

Load object.

Definition at line 48 of file mlLoadBase.h.

StringField* ml::LoadBase::_fldLoadDirName

Name of the directory the file is to be restored from.

Definition at line 51 of file mlLoadBase.h.

StringField* ml::LoadBase::_fldLoadFileName

Name of the file the object is to be restored from.

Definition at line 50 of file mlLoadBase.h.

EnumField* ml::LoadBase::_fldLoadMode

Specifies the file format for the object.

See also:
IOHandler::IO_MODE

Definition at line 54 of file mlLoadBase.h.

StringField* ml::LoadBase::_fldNodeName

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

Definition at line 49 of file mlLoadBase.h.

BoolField* ml::LoadBase::_fldUpToDate

Indicates whether the current output corresponds to the filename.

Definition at line 55 of file mlLoadBase.h.

BoolField* ml::LoadBase::_fldUseLoadDir

Indicates whether the load dir field is used.

Definition at line 52 of file mlLoadBase.h.

Base* ml::LoadBase::_outputObject [protected]

object behind _fldBaseOutput

Definition at line 70 of file mlLoadBase.h.

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