IPSDKCore/html/a14681_source.html

 // FileSerializationUtils.h:
 // -------------------------
 //

 #ifndef __IPSDKSERIALIZATION_FILESERIALIZATIONUTILS_H__
 #define __IPSDKSERIALIZATION_FILESERIALIZATIONUTILS_H__

 #include <IPSDKSerialization/IPSDKSerializationExports.h>
 #include <IPSDKSerialization/Archive/FileSerializationTypes.h>
 #include <boost/filesystem/path.hpp>

 namespace ipsdk {

 class BaseSerializationObject;

 // Xml serialization

 IPSDKSERIALIZATION_API BoolResult
 writeToXmlFile(const boost::filesystem::path& filePath,
                const BaseSerializationObject& object);
 IPSDKSERIALIZATION_API BoolResult
 writeToXmlFile(const boost::filesystem::path& filePath,
                const SerializationObjectConstPtr& pObject);

 IPSDKSERIALIZATION_API BoolResult
 readFromXmlFile(const boost::filesystem::path& filePath,
                 BaseSerializationObject& object);
 IPSDKSERIALIZATION_API FileReadResult
 readFromXmlFile(const boost::filesystem::path& filePath);

 // Binary serialization

 IPSDKSERIALIZATION_API BoolResult
 writeToBinaryFile(const boost::filesystem::path& filePath,
                   const BaseSerializationObject& object);
 IPSDKSERIALIZATION_API BoolResult
 writeToBinaryFile(const boost::filesystem::path& filePath,
                   const SerializationObjectConstPtr& pObject);

 IPSDKSERIALIZATION_API BoolResult
 readFromBinaryFile(const boost::filesystem::path& filePath,
                    BaseSerializationObject& object);
 IPSDKSERIALIZATION_API FileReadResult
 readFromBinaryFile(const boost::filesystem::path& filePath);


 } // end of namespace ipsdk

 #endif // __IPSDKSERIALIZATION_XMLFILESERIALIZATIONUTILS_H__
ipsdk::writeToBinaryFile
IPSDKSERIALIZATION_API BoolResult writeToBinaryFile(const boost::filesystem::path &filePath, const BaseSerializationObject &object)
write a base serialization object to a binary file

ipsdk
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22

ipsdk::SerializationObjectConstPtr
boost::shared_ptr< const BaseSerializationObject > SerializationObjectConstPtr
shared pointer to a const base serialization object
Definition: SerializationTypes.h:32

FileSerializationTypes.h
Predefined types for file serialization functions.

ipsdk::readFromBinaryFile
IPSDKSERIALIZATION_API BoolResult readFromBinaryFile(const boost::filesystem::path &filePath, BaseSerializationObject &object)
read a base serialization object from a binary file

ipsdk::readFromXmlFile
IPSDKSERIALIZATION_API BoolResult readFromXmlFile(const boost::filesystem::path &filePath, BaseSerializationObject &object)
read a base serialization object from a xml file

ipsdk::BoolResult
ProcessingResult< bool > BoolResult
typedef for boolean results associated to a string description
Definition: ProcessingResultTypes.h:29

ipsdk::writeToXmlFile
IPSDKSERIALIZATION_API BoolResult writeToXmlFile(const boost::filesystem::path &filePath, const BaseSerializationObject &object)
write a base serialization object to a xml file

IPSDKSerializationExports.h
Definition of import/export macro for library.

IPSDKSERIALIZATION_API
#define IPSDKSERIALIZATION_API
Import/Export macro for library IPSDKUtil.
Definition: IPSDKSerializationExports.h:27