CLAM::Storage Class Reference

The abstract class for storages. More...

#include <Storage.hxx>

List of all members.

Public Member Functions

virtual ~Storage ()
virtual void Store (const Storable &object)=0
 Stores an storable object on the storage.
virtual bool Load (Storable &object)=0
 Loads an storable object from the storage.

Detailed Description

The abstract class for storages.

An storage is a place where you can save and/or retrieve objects state. Subclasses of Storage will implement the way the storage and loading is done.

Definition at line 51 of file Storage.hxx.


Constructor & Destructor Documentation

virtual CLAM::Storage::~Storage (  )  [inline, virtual]

Definition at line 55 of file Storage.hxx.


Member Function Documentation

virtual bool CLAM::Storage::Load ( Storable object  )  [pure virtual]

Loads an storable object from the storage.

Concrete storages must implement this function as they need.

Once executed the function, no references to the actual storable or its subitems will be kept on the storage so the object itself can be deleted.

Parameters:
A pointer to the Storage object. No references will be keept on the storage.
Returns:
false when the desired object is not present in the storage.

Implemented in CLAM::XmlStorage.

Referenced by CLAM::DynamicType::LoadAttribute(), CLAM::Segmentation::LoadFrom(), CLAM::ScopePool::LoadFrom(), CLAM::ProcessingDefinitionAdapter::LoadFrom(), CLAM::DescriptionDataPool::LoadFrom(), CLAM::Polymorphic< FactoryType >::LoadFrom(), CLAM::FlagsBase::LoadFrom(), CLAM::Enum::LoadFrom(), CLAM::BPFTmpl< TX, TY >::LoadFrom(), CLAM::DynamicType::LoadIterableAttribute(), CLAM::ControlTraceEvent::StoreOn(), CLAM::Attribute< AttributeType >::XmlRestoreData(), and CLAM::DescriptionScheme::~DescriptionScheme().

virtual void CLAM::Storage::Store ( const Storable object  )  [pure virtual]

Stores an storable object on the storage.

Concrete storages must implement this function as they need.

Once executed the function, no references to the actual storable or its subitems will be kept on the storage so the object itself can be deleted.

Parameters:
A pointer to the Storage object. No references will be keept on the storage.

Implemented in CLAM::XmlStorage.

Referenced by CLAM::ControlTraceData::Append(), CLAM::ControlTraceEvent::operator=(), CLAM::DynamicType::StoreAttribute(), CLAM::DynamicType::StoreIterableAttribute(), CLAM::Segmentation::StoreOn(), CLAM::ScopePool::StoreOn(), CLAM::ProcessingDefinitionAdapter::StoreOn(), CLAM::DescriptionDataPool::StoreOn(), CLAM::Polymorphic< FactoryType >::StoreOn(), CLAM::FlagsBase::StoreOn(), CLAM::Enum::StoreOn(), CLAM::AbstractAttribute::StoreOn(), CLAM::BPFTmpl< TX, TY >::StoreOn(), CLAM::Attribute< AttributeType >::XmlDumpData(), and CLAM::Attribute< AttributeType >::XmlDumpSchemaType().


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3