ICF 3.0.5.47
Technical documentation of ICF Libraries
ibase::TSerializableContainer< ItemClass, ContainerType > Class Template Referenceabstract

Common implementation for an abstract serializable container. More...

#include <TSerializableContainer.h>

Inheritance diagram for ibase::TSerializableContainer< ItemClass, ContainerType >:
Collaboration diagram for ibase::TSerializableContainer< ItemClass, ContainerType >:

Public Types

typedef TContainer< ItemClass, ContainerType > BaseClass
 
- Public Types inherited from ibase::TContainer< ItemClass, ContainerType >
enum  ChangeFlags { CF_ELEMENT_ADDED = 0x382b230 , CF_ELEMENT_REMOVED , CF_RESET }
 
typedef ContainerType Container
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ICF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,
  CF_DELEGATED , CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,
  SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 , SO_CHANGE_LOCK = 1 << 5
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from ibase::TContainer< ItemClass, ContainerType >
virtual void Reserve (int count)
 
virtual void Resize (int count)
 
const ItemClass & GetAt (int index) const
 
ItemClass & GetAt (int index)
 
ItemClass & PushBack (const ItemClass &item)
 
ItemClass & PushFront (const ItemClass &item)
 
ItemClass & InsertAt (const ItemClass &item, int index)
 
void PopBack ()
 
void PopFront ()
 
void RemoveAt (int index)
 
virtual void Reset ()
 
TContaineroperator= (const TContainer &container)
 
virtual int GetItemsCount () const
 
virtual bool IsEmpty () const
 
virtual bool IsIndexValid (int index) const
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
virtual std::unique_ptr< IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object.
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state.
 
virtual QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction.
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction.
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes.
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes.
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 

Protected Member Functions

virtual bool SerializeItem (ItemClass &item, iser::IArchive &archive, iser::CArchiveTag *parentTagPtr=nullptr)=0
 Serialize a single item in the container.
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event.
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event.
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set.
 
- Protected Types inherited from ibase::TContainer< ItemClass, ContainerType >
typedef ContainerType Items
 
- Protected Attributes inherited from ibase::TContainer< ItemClass, ContainerType >
Items m_items
 
- Static Protected Attributes inherited from ibase::TContainer< ItemClass, ContainerType >
static const ChangeSet s_elementAddChange
 
static const ChangeSet s_elementRemoveChange
 
static const ChangeSet s_resetChange
 

Detailed Description

template<typename ItemClass, class ContainerType = typename TContainer<ItemClass>::Container>
class ibase::TSerializableContainer< ItemClass, ContainerType >

Common implementation for an abstract serializable container.

Derived class must only reimplement the SerializeItem().

Definition at line 25 of file TSerializableContainer.h.

Member Typedef Documentation

◆ BaseClass

template<typename ItemClass , class ContainerType = typename TContainer<ItemClass>::Container>
TContainer<ItemClass, ContainerType> ibase::TSerializableContainer< ItemClass, ContainerType >::BaseClass

Definition at line 28 of file TSerializableContainer.h.

Member Function Documentation

◆ Serialize()

template<typename ItemClass , class ContainerType >
bool ibase::TSerializableContainer< ItemClass, ContainerType >::Serialize ( iser::IArchive & archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

Reimplemented in ibase::TFactorisableContainer< InterfaceClass >.

Definition at line 48 of file TSerializableContainer.h.

References iser::IArchive::BeginMultiTag(), iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsChanging(), iser::CArchiveTag::TT_GROUP, and iser::CArchiveTag::TT_MULTIPLE.

◆ SerializeItem()

template<typename ItemClass , class ContainerType = typename TContainer<ItemClass>::Container>
virtual bool ibase::TSerializableContainer< ItemClass, ContainerType >::SerializeItem ( ItemClass & item,
iser::IArchive & archive,
iser::CArchiveTag * parentTagPtr = nullptr )
protectedpure virtual

Serialize a single item in the container.

Implemented in ibase::TFactorisableContainer< InterfaceClass >.


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

© Witold Gantzke and Kirill Lepskiy