ALBA
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
albaVMEStorage Class Reference

#include <albaVMEStorage.h>

Inheritance diagram for albaVMEStorage:
Inheritance graph
[legend]
Collaboration diagram for albaVMEStorage:
Collaboration graph
[legend]

Public Member Functions

 ALBA_ID_DEC (MSF_FILENAME_CHANGED)
 
 albaTypeMacro (albaVMEStorage, albaXMLStorage) albaVMEStorage()
 
virtual ~albaVMEStorage ()
 
albaVMERootGetRoot ()
 
void SetRoot (albaVMERoot *root)
 
virtual void SetURL (const char *name)
 
virtual void OnEvent (albaEventBase *e)
 
- Public Member Functions inherited from albaXMLStorage
 albaTypeMacro (albaXMLStorage, albaStorage)
 
 albaXMLStorage ()
 
virtual ~albaXMLStorage ()
 
mmuXMLDOMGetXMLDOM ()
 
void SetFileType (const char *filetype)
 
const char * GetFileType ()
 
void SetVersion (const char *version)
 
const char * GetVersion ()
 
const char * GetDocumentVersion ()
 
virtual int ResolveInputURL (const char *url, albaString &filename, albaObserver *observer=NULL)
 
virtual int StoreToURL (const char *filename, const char *url)
 
virtual int ReleaseURL (const char *url)
 
virtual int DeleteURL (const char *url)
 
virtual int OpenDirectory (const char *pathname)
 
virtual void SetURL (const char *name)
 
virtual const char * GetTmpFolder ()
 
virtual void EmptyGarbageCollector ()
 
- Public Member Functions inherited from albaStorage
 albaAbstractTypeMacro (albaStorage, albaObject)
 
 albaStorage ()
 
virtual ~albaStorage ()
 
virtual void SetURL (const char *name)
 
void ForceParserURL ()
 
const char * GetURL ()
 
const char * GetPareserURL ()
 
int Store ()
 
int Restore ()
 
void SetDocument (albaStorable *doc)
 
albaStorableGetDocument ()
 
virtual int ResolveInputURL (const char *url, albaString &filename, albaObserver *observer=NULL)=0
 
virtual int StoreToURL (const char *filename, const char *url=NULL)=0
 
virtual int ReleaseURL (const char *url)=0
 
virtual void GetTmpFile (albaString &filename)
 
void ReleaseTmpFile (const char *filename)
 
bool IsFileInDirectory (const char *filename)
 
virtual void SetTmpFolder (const char *folder)
 
virtual const char * GetTmpFolder ()
 
void SetErrorCode (int err)
 
int GetErrorCode ()
 
bool NeedsUpgrade ()
 
- Public Member Functions inherited from albaObject
 albaObject ()
 
virtual ~albaObject ()
 
virtual void Delete ()
 
virtual const char * GetTypeName () const
 
virtual bool IsA (const char *type_name) const
 
virtual bool IsA (const albaTypeID &type_id) const
 
virtual albaObjectNewObjectInstance () const =0
 
virtual const albaTypeIDGetTypeId () const
 
virtual void Print (std::ostream &os, const int indent=0) const
 
 albaObject (const albaObject &c)
 
- Public Member Functions inherited from albaObserver
 albaObserver ()
 
virtual ~albaObserver ()
 
virtual void OnEvent (albaEventBase *e)=0
 
- Public Member Functions inherited from albaEventSender
 albaEventSender ()
 
virtual void SetListener (albaObserver *o)
 
virtual albaObserverGetListener ()
 
virtual bool HasListener ()
 
virtual void InvokeEvent (albaEventBase &e)
 
virtual void InvokeEvent (albaEventBase *e)
 
virtual void InvokeEvent (void *sender, albaID id=ID_NO_EVENT, void *data=NULL)
 

Protected Member Functions

void SetFileType (const char *filetype)
 
void SetVersion (const char *version)
 
- Protected Member Functions inherited from albaXMLStorage
virtual int InternalStore ()
 
virtual int InternalRestore ()
 
virtual int InternalStore ()=0
 
virtual int InternalRestore ()=0
 
virtual int OpenDirectory (const char *dir_name)=0
 

Protected Attributes

albaVMERootm_Root
 
- Protected Attributes inherited from albaXMLStorage
albaString m_FileType
 
albaString m_Version
 
albaString m_DocumentVersion
 
mmuXMLDOMm_DOM
 
std::set< albaStringm_GarbageCollector
 
albaString m_DefaultTmpFolder
 
- Protected Attributes inherited from albaStorage
bool m_NeedsUpgrade
 
albaStorablem_Document
 
albaStorageElementm_DocumentElement
 
albaString m_URL
 
albaString m_ParserURL
 
albaID m_TmpFileId
 
albaString m_TmpFolder
 
std::set< albaStringm_TmpFileNames
 
std::set< albaStringm_FilesDictionary
 
int m_ErrorCode
 
- Protected Attributes inherited from albaObject
bool m_HeapFlag
 
- Protected Attributes inherited from albaEventSender
albaObserverm_Listener
 

Additional Inherited Members

- Public Types inherited from albaXMLStorage
enum  XML_IO_ERRORS {
  IO_XML_PARSE_ERROR =IO_LAST_ERROR , IO_DOM_XML_ERROR , IO_RESTORE_ERROR , IO_WRONG_FILE_TYPE ,
  IO_WRONG_FILE_VERSION , IO_WRONG_URL , IO_XML_PARSER_INTERNAL_ERROR
}
 
- Public Types inherited from albaStorage
enum  STORAGE_IO_ERRORS { IO_OK =0 , IO_GENERIC_ERROR , IO_WRONG_OBJECT_TYPE , IO_LAST_ERROR }
 
- Static Public Member Functions inherited from albaObject
static const char * GetStaticTypeName ()
 
static bool IsStaticType (const char *type_name)
 
static bool IsStaticType (const albaTypeID &type_id)
 
static const albaTypeIDGetStaticTypeId ()
 
static albaObjectSafeDownCast (albaObject *o)
 

Detailed Description

A storage class for MSF local files.

This is a concrete implementation of storage object for storing MSF local files.

See also
albaXMLStorage
Todo:

Definition at line 48 of file albaVMEStorage.h.

Constructor & Destructor Documentation

◆ ~albaVMEStorage()

virtual albaVMEStorage::~albaVMEStorage ( )
virtual

Member Function Documentation

◆ ALBA_ID_DEC()

albaVMEStorage::ALBA_ID_DEC ( MSF_FILENAME_CHANGED  )

◆ albaTypeMacro()

albaVMEStorage::albaTypeMacro ( albaVMEStorage  ,
albaXMLStorage   
)

◆ GetRoot()

albaVMERoot * albaVMEStorage::GetRoot ( )

return the root node attached to this tree

◆ SetRoot()

void albaVMEStorage::SetRoot ( albaVMERoot root)

Set the root to this Storage.

This is usually not necessary since storage creates the root on its own

◆ SetURL()

virtual void albaVMEStorage::SetURL ( const char *  name)
virtual

Set the URL of the document to be read or written.

Reimplemented from albaXMLStorage.

◆ OnEvent()

virtual void albaVMEStorage::OnEvent ( albaEventBase e)
virtual

process events coming from tree

Implements albaObserver.

◆ SetFileType()

void albaVMEStorage::SetFileType ( const char *  filetype)
inlineprotected

Do not allow changing the file type from external objects.

Definition at line 72 of file albaVMEStorage.h.

◆ SetVersion()

void albaVMEStorage::SetVersion ( const char *  version)
inlineprotected

Do not allow changing the file version from external objects.

Definition at line 75 of file albaVMEStorage.h.

Member Data Documentation

◆ m_Root

albaVMERoot* albaVMEStorage::m_Root
protected

the VME root node

Definition at line 77 of file albaVMEStorage.h.


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