summaryrefslogtreecommitdiffstats
path: root/xmlserializer/XmlFileDocSink.h
diff options
context:
space:
mode:
Diffstat (limited to 'xmlserializer/XmlFileDocSink.h')
-rw-r--r--xmlserializer/XmlFileDocSink.h29
1 files changed, 24 insertions, 5 deletions
diff --git a/xmlserializer/XmlFileDocSink.h b/xmlserializer/XmlFileDocSink.h
index d06365a..370d175 100644
--- a/xmlserializer/XmlFileDocSink.h
+++ b/xmlserializer/XmlFileDocSink.h
@@ -1,6 +1,6 @@
/*
* INTEL CONFIDENTIAL
- * Copyright © 2011 Intel
+ * Copyright © 2013 Intel
* Corporation All Rights Reserved.
*
* The source code contained or described herein and all documents related to
@@ -19,22 +19,41 @@
* otherwise. Any license under such intellectual property rights must be
* express and approved by Intel in writing.
*
- * CREATED: 2012-08-10
*/
#pragma once
-
#include "XmlDocSink.h"
+#include <string>
+/**
+ * Sink class that save the content of any CXmlDocSource into a file.
+ * The file path is defined in the constructor.
+ */
class CXmlFileDocSink : public CXmlDocSink
{
public:
+ /**
+ * Constructor
+ *
+ * @param[in] strXmlInstanceFile defines the path used to save the file.
+ */
CXmlFileDocSink(const string& strXmlInstanceFile);
private:
- // Source processing
+ /**
+ * Implementation of CXmlDocSink::doProcess()
+ * Write the content of the xmlDocSource to the file opened in strXmlInstanceFile using
+ * UTF-8 encoding
+ *
+ * @param[in] xmlDocSource is the source containing the Xml document
+ * @param[out] serializingContext is used as error output
+ *
+ * @return false if any error occurs
+ */
virtual bool doProcess(CXmlDocSource& xmlDocSource, CXmlSerializingContext& serializingContext);
- // Instance file
+ /**
+ * Name of the instance file
+ */
string _strXmlInstanceFile;
};