![]() |
ICF 3.1.1.10
Technical documentation of ICF Libraries
|
Represent input/output persistence archive. More...
#include <IArchive.h>
Public Types | |
| enum | MessageId { MI_TAG_ERROR = 0x3f320a0 , MI_TAG_SKIPPED } |
Public Member Functions | |
| virtual bool | IsChanging () const =0 |
| Check if this archive processing change the object state. | |
| virtual bool | IsTagSkippingSupported () const =0 |
| Check if skiping to the end of tag on EndTag is supported. | |
| virtual const IVersionInfo & | GetVersionInfo () const =0 |
| Get version of archived stream for specific versioning type. | |
| virtual bool | ProcessGroup (const CArchiveTag &tag, std::function< bool(IArchive &)> groupArchiveFn)=0 |
| Process some group of elements encapsulated in single tag. | |
| virtual bool | ProcessAnyList (const CArchiveTag &listTag, const CArchiveTag &subTag, int count, std::function< bool(int, IArchive &)> iterArchiveFn, std::function< bool(int)> resizeFn=nullptr)=0 |
| Process some list of elements. | |
| virtual bool | ProcessGroupList (const CArchiveTag &listTag, const CArchiveTag &groupTag, int count, std::function< bool(int, IArchive &)> groupArchiveFn, std::function< bool(int)> resizeFn=nullptr)=0 |
| Process list of elements in groups. | |
| virtual bool | ProcessObject (const CArchiveTag &tag, ISerializable &object)=0 |
| Process object enclosed by some tag. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, bool &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, char &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, quint8 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, qint8 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, quint16 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, qint16 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, quint32 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, qint32 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, quint64 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, qint64 &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, float &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, double &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, QByteArray &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessLeaf (const CArchiveTag &tag, QString &value)=0 |
| Process primitive type. | |
| virtual bool | ProcessBytes (const CArchiveTag &tag, void *dataPtr, int size)=0 |
| Process binary data block. | |
Represent input/output persistence archive.
Definition at line 33 of file IArchive.h.
| Enumerator | |
|---|---|
| MI_TAG_ERROR | |
| MI_TAG_SKIPPED | |
Definition at line 36 of file IArchive.h.
|
pure virtual |
Get version of archived stream for specific versioning type.
| versionId | versioning type. It allows you to distinguish different version aspects. For example version number of framework cann differ from application version. |
Implemented in iser::CReadArchiveBase, and iser::CWriteArchiveBase.
|
pure virtual |
Check if this archive processing change the object state.
Implemented in iser::CReadArchiveBase, and iser::CWriteArchiveBase.
Referenced by ialgo::TGeneralHoughSpace< Dimensions, Element >::Serialize(), iattr::TAttribute< Value >::Serialize(), iattr::TMultiAttribute< Value >::Serialize(), ibase::TSerializableContainer< ItemClass, ContainerType >::Serialize(), icmm::TComposedColor< Size >::Serialize(), idoc::TMultiPageDocumentWrap< Base >::Serialize(), iipr::TWeightedFeatureWrap< BaseObject >::Serialize(), imath::TFulcrumGrid< Position, Fulcrums >::Serialize(), imath::TMatrix< Width, Height, Element >::Serialize(), imath::TMultidimensionalPolynomial< Dimensions, Element >::Serialize(), imeas::TDiscreteDataSequence< Element >::Serialize(), imeas::TMeasurementMessage< BaseMessageType, ValueType >::Serialize(), imeas::TMeasurementValue< ValueType >::Serialize(), iser::CPrimitiveTypesSerializer::SerializeEnum(), iser::CPrimitiveTypesSerializer::SerializeEnum(), and iser::CPrimitiveTypesSerializer::SerializeRanges().
|
pure virtual |
Check if skiping to the end of tag on EndTag is supported.
Implemented in ifile::CFileReadArchive, ifile::CFileWriteArchive, iser::CArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process some list of elements.
| listTag | main root tag. |
| subTag | subelement tag. Please note, in oposite to ProcessGroupList, that tag must be used as a root inside of iteration function. |
| count | number of subelements. If it is read archive and the number of subelements differs, the resize function will be called. If it storing archive this value determines the number of iterations. |
| iterArchiveFn | iteration function called every iteration for processing subelements. This function must use the tag subTag as a root of processing. |
| resizeFn | resize function called by reading, if the number of elements differs from the entered count. This function is optional. |
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, and iser::CBinaryWriteArchiveBase.
Referenced by ialgo::TGeneralHoughSpace< Dimensions, Element >::Serialize(), iattr::TMultiAttribute< Value >::Serialize(), icmm::TComposedColor< Size >::Serialize(), imath::TFastVector< MaxSize, Element >::Serialize(), imath::TFulcrumGrid< Position, Fulcrums >::Serialize(), iser::CPrimitiveTypesSerializer::SerializeLeafContainer(), and iser::CPrimitiveTypesSerializer::SerializeRanges().
|
pure virtual |
Process binary data block.
| dataPtr | pointer to memory block. |
| size | size of memory block in bytes. |
Implemented in iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CTextReadArchiveBase, and iser::CTextWriteArchiveBase.
|
pure virtual |
Process some group of elements encapsulated in single tag.
| tag | tag object. |
| groupArchiveFn | user function processing elements inside the group. |
Implemented in iser::CBinaryReadArchiveBase, and iser::CBinaryWriteArchiveBase.
Referenced by ialgo::TGeneralHoughSpace< Dimensions, Element >::Serialize(), idoc::TMultiPageDocumentWrap< Base >::Serialize(), ilog::TExtMessage< Element >::Serialize(), imath::TMatrix< Width, Height, Element >::Serialize(), imath::TMultidimensionalPolynomial< Dimensions, Element >::Serialize(), imeas::TDiscreteDataSequence< Element >::Serialize(), and iser::CPrimitiveTypesSerializer::SerializeRange().
|
pure virtual |
Process list of elements in groups.
| listTag | main root tag. |
| groupTag | tag of the group enclosing each subelement. Please note, in oposite to ProcessAnyList, this tag should not be used inside of iteration function. |
| count | number of subelements. If it is read archive and the number of subelements differs, the resize function will be called. If it storing archive this value determines the number of iterations. |
| iterArchiveFn | iteration function called every iteration for processing subelements. This function should not use the tag subTag as a part of processing, except you know what you do. |
| resizeFn | resize function called by reading, if the number of elements differs from the entered count. This function is optional. |
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, and iser::CBinaryWriteArchiveBase.
Referenced by ibase::TSerializableContainer< ItemClass, ContainerType >::Serialize(), idoc::TMultiPageDocumentWrap< Base >::Serialize(), and iser::CPrimitiveTypesSerializer::SerializeContainer().
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
Referenced by ialgo::TGeneralHoughSpace< Dimensions, Element >::Serialize(), iattr::TAttribute< Value >::Serialize(), icmm::TComposedColor< Size >::Serialize(), iipr::TWeightedFeatureWrap< BaseObject >::Serialize(), imath::TFastVector< MaxSize, Element >::Serialize(), imath::TMatrix< Width, Height, Element >::Serialize(), imath::TMultidimensionalPolynomial< Dimensions, Element >::Serialize(), imath::TVector< Size, Element >::Serialize(), imeas::TDiscreteDataSequence< Element >::Serialize(), imeas::TMeasurementValue< ValueType >::Serialize(), iser::CPrimitiveTypesSerializer::SerializeEnum(), iser::CPrimitiveTypesSerializer::SerializeEnum(), iser::CPrimitiveTypesSerializer::SerializeIndex(), iser::CPrimitiveTypesSerializer::SerializeIntEnum(), iser::CPrimitiveTypesSerializer::SerializeRange(), and iser::CPrimitiveTypesSerializer::SerializeRanges().
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process primitive type.
Implemented in ifile::CSettingsReadArchive, ifile::CSettingsWriteArchive, iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CCompactXmlReadArchiveBase, iser::CCompactXmlWriteArchiveBase, iser::CJsonStringWriteArchive, iser::CTextReadArchiveBase, iser::CTextWriteArchiveBase, iser::CXmlReadArchiveBase, and iser::CXmlWriteArchiveBase.
|
pure virtual |
Process object enclosed by some tag.
This function is introduced mostly for convinience and performance.
| tag | tag object. |
| object | object to serialize. |
Implemented in iser::CBinaryReadArchiveBase, iser::CBinaryWriteArchiveBase, iser::CTextReadArchiveBase, and iser::CTextWriteArchiveBase.
Referenced by idoc::TMultiPageDocumentWrap< Base >::SerializePage().
© Witold Gantzke and Kirill Lepskiy