aboutsummaryrefslogtreecommitdiff
path: root/examples/cxx/serializer/library/README
diff options
context:
space:
mode:
Diffstat (limited to 'examples/cxx/serializer/library/README')
-rw-r--r--examples/cxx/serializer/library/README44
1 files changed, 44 insertions, 0 deletions
diff --git a/examples/cxx/serializer/library/README b/examples/cxx/serializer/library/README
new file mode 100644
index 0000000..82ca09c
--- /dev/null
+++ b/examples/cxx/serializer/library/README
@@ -0,0 +1,44 @@
+This example shows how to use the Embedded C++/Serializer
+mapping to create XML documents from a custom in-memory
+object model.
+
+The example consists of the following files:
+
+library.xsd
+ XML Schema which describes a library of books.
+
+library.hxx
+ Types that describe a library of books in C++. These are
+ hand-written.
+
+library.map
+ Type map. It maps XML Schema types defined in library.xsd
+ to C++ types defined in library.hxx.
+
+library-sskel.hxx
+library-sskel.ixx
+library-sskel.cxx
+ Serializer skeletons generated by XSD/e from library.xsd
+ and library.map.
+
+library-simpl-mixin.hxx
+library-simpl-mixin.cxx
+
+library-simpl-tiein.hxx
+library-simpl-tiein.cxx
+ Serializer implementations (using either mixin or tiein
+ parser reuse style) that serialize the custom in-memory
+ object model to XML. These are hand-written implementations
+ of the serializer skeletons defined in library-sskel.hxx.
+
+driver.cxx
+ Driver for the example. It first constructs a sample
+ object model using the types from library.hxx. It then
+ creates a serializer instance using all the individual
+ serializers found in one of library-simpl-*.hxx. Finally,
+ it invokes this serializer instance to serialize the sample
+ object model to an XML document which is printed to STDOUT.
+
+To run the example simply execute:
+
+$ ./driver