Home > Articles > Programming > C/C++

  • Print
  • + Share This
Like this article? We recommend

Serializing Containers

In our sample, a Drawing object can contain multiple Polygon objects (which I will store in a vector, one of the container templates in the Standard Library), and each Polygon object can contain multiple Vertex objects (again, which I'll store in a vector).

The serialization library includes features for saving arrays and containers. Because you can store pointers into arrays, the serialization library also supports pointers. Think about this: If you have an array containing Vertex pointers and you write that array to a file directly (as-is), you'll have a bunch of pointers stored in the file, not the actual Vertex data. Those pointers are just numbers (memory locations) that would be meaningless when read back in later. Thus, the library is smart enough to grab the actual data for the object rather than the pointers.

To allow for storing the objects that are containers, you make each of your classes serializable. In the serialization methods, you read and write the containers just as you would any other member. Your containers can be simple built-in arrays (such as Vertex *vertices[10];), or they can be containers from the Standard Library. Because this is the 21st century, I like to keep up with the times, and so I chose in this example to use the Standard Library.

Although you could write code in your serialize class that climbs through the container and writes out each member, you don't have to. Instead, the library is smart enough to traverse through the container itself. All you need to do is write out the container, like this, where vertices is a container:

ar & vertices;

And the library does the rest. Don't believe me? Here's the code for the Polygon class, again with the serialization portions in bold:

class Polygon {
private:
  vector<Vertex *> vertices;
  friend class boost::serialization::access;
  template<class Archive>
  void serialize(Archive & ar, const unsigned int version)
  {
    ar & vertices;
  }
public:
  void addVertex(Vertex *v) {
    vertices.push_back(v);
  }
  void dump() {
    for_each(vertices.begin(), vertices.end(), mem_fun(&Vertex::dump));
  }
};

First, notice that I'm using a vector to store the vertices. (If you're new to templates, just think of vector<Vertex *> as meaning a vector that stores pointers to Vertex instances because that is, in fact, all it is.) Next, in the serialize function I don't climb through the vector, writing each member. Instead, I just read and write the entire vector:

ar & vertices;

The two public methods are handy for manipulating the polygon. The first, addVertex, lets you add another vertex to the polygon; it uses the push_back method, which is the standard method for adding an item to a vector. The dump function climbs through the vector, writing out each vector to the standard output. Even to some of you seasoned seeplusplusers, this line might look unfamiliar:

for_each(vertices.begin(), vertices.end(), mem_fun(&Vertex::dump));

This is a little trick. It's not part of the serialization library; it is part of the Standard Library and available to your C++ programs today at no extra charge and with a money-back guarantee. The word for_each is actually a function, and it takes three parameters: the starting position in the container, the ending condition, and a function to call for each item in the container. (Depending on your implementation of C++, you might have to #include <algorithm> to get for_each. I used the GNU library, and #include <vector> picked it up for me.) In the case of my example, the function I for the third parameter of for_each is the dump member function of the Vertex class. But there's a problem: You can't just call a member function by itself; you need to call it for a particular object. That's where the mem_fun member function adaptor comes in. It's a special function (also part of the Standard Library) that in this case works together with the for_each function, calling the particular object's dump function. In other words, it binds dump() to the Vertex object that for_each is currently manipulating.

To make a long story short, this for_each call iterates through each Vertex in the entire list, calling Vertex::dump—all in one line of code!

Next, the Drawing class is actually quite similar to the Polygon class, except that instead of containing a container of Vertex objects, it contains Polygon objects. No big deal.

Here, then, is the entire program, including some additional destructors that take care of cleaning up the memory:

#include <iostream>
#include <vector>
#include <functional>
#include <algorithm>

#include <fstream>
#include <boost/archive/text_oarchive.hpp>
#include <boost/archive/text_iarchive.hpp>
#include <boost/serialization/vector.hpp>

using namespace std;

class Vertex {
private:
  // Code for serialization
  friend class boost::serialization::access;
  template<class Archive>
  void serialize(Archive & ar, unsigned int version)
  {
    ar & x;
    ar & y;
  }
  // End code for serialization
  double x;
  double y;
public:
  Vertex() {} // Serialization requires a default ctor!
  ~Vertex() {}
  Vertex(double newX, double newY) : x(newX), y(newY) {}
  double getX() const { return x; }
  double getY() const { return y; }
  void dump() {
    cout << x << " " << y << endl;
  }  
};
void delete_vertex(Vertex *v) { delete v; }

class Polygon {
private:
  vector<Vertex *> vertices;
  friend class boost::serialization::access;
  template<class Archive>
  void serialize(Archive & ar, const unsigned int version)
  {
    ar & vertices;
  }
public:
  ~Polygon() {
    for_each(vertices.begin(), vertices.end(), delete_vertex);
  }
  void addVertex(Vertex *v) {
    vertices.push_back(v);
  }
  void dump() {
    for_each(vertices.begin(), vertices.end(), mem_fun(&Vertex::dump));
  }
};
void delete_poly(Polygon *p) { delete p; }

class Drawing {
private:
  vector<Polygon *> polygons;
  friend class boost::serialization::access;
  template<class Archive>
  void serialize(Archive & ar, const unsigned int version)
  {
    ar & polygons;
  }
public:
  ~Drawing() {
    for_each(polygons.begin(), polygons.end(), delete_poly);
  }
  void addPolygon(Polygon *p) {
    polygons.push_back(p);
  }
  void dump() {
    for_each(polygons.begin(), polygons.end(), mem_fun(&Polygon::dump));
  }
};

string getFileOpen() {
  // In real life, this would
  // call a FileOpen dialog of sorts
  return "c:/myfile.grp";
}

string getFileSaveAs() {
  // In real life, this would
  // call a FileSave dialog of sorts
  return "c:/myfile.grp";
}

void saveDocument(Drawing *doc, const string &filename) {
  ofstream ofs(filename.c_str());
  boost::archive::text_oarchive oa(ofs);
  oa << *doc;
  ofs.close();
}

Drawing *openDocument(const string &filename) {
  Drawing *doc = new Drawing();
  std::ifstream ifs(filename.c_str(), std::ios::binary);
  boost::archive::text_iarchive ia(ifs);
  ia >> *doc;
  ifs.close();
  return doc;
}

int main()
{
/*  Polygon *poly1 = new Polygon();
  poly1->addVertex(new Vertex(0.1,0.2));
  poly1->addVertex(new Vertex(1.5,1.5));
  poly1->addVertex(new Vertex(0.5,2.9));
  
  Polygon *poly2 = new Polygon();
  poly2->addVertex(new Vertex(0,0));
  poly2->addVertex(new Vertex(0,1.5));
  poly2->addVertex(new Vertex(1.5,1.5));
  poly2->addVertex(new Vertex(1.5,0));
  
  Drawing *draw = new Drawing();
  draw->addPolygon(poly1);
  draw->addPolygon(poly2);
  
  // Demonstrate saving a document
  saveDocument(draw, getFileSaveAs());

  // Demonstrate opening a document
  string filename2 = getFileOpen();
  Drawing *doc2 = openDocument(getFileOpen());
  doc2->dump();

  return 0;*/
  
  Polygon *poly1 = new Polygon();
  poly1->addVertex(new Vertex(0.1,0.2));
  poly1->addVertex(new Vertex(1.5,1.5));
  poly1->addVertex(new Vertex(0.5,2.9));
  
  Polygon *poly2 = new Polygon();
  poly2->addVertex(new Vertex(0,0));
  poly2->addVertex(new Vertex(0,1.5));
  poly2->addVertex(new Vertex(1.5,1.5));
  poly2->addVertex(new Vertex(1.5,0));
  
  Drawing *draw = new Drawing();
  draw->addPolygon(poly1);
  draw->addPolygon(poly2);
  
  // Demonstrate saving a document
  saveDocument(draw, getFileSaveAs());

  // Demonstrate opening a document
  string filename2 = getFileOpen();
  Drawing *doc2 = openDocument(getFileOpen());
  doc2->dump();

  delete draw;
  return 0;  
}

Now remember the idea here: I'm trying to steer away from the idea that I'm writing Drawing objects to a file. Instead, conceptually I'm considering the Drawing object my document, and I'm storing document files and reading them back in. Those document files have a special file format that I have created specifically for my program, and I assigned them a unique filename extension, .grp, which stands for graphics.

As such, I also created a couple of filler functions: getFileSaveAs and getFileOpen. In this sample, these functions just return a string with a filename hardcoded. In a real program, these functions would get called from a File, Save As and File, Open menu selection, respectively; and would call the system File Open and File Save dialog boxes. These dialog boxes would return a string containing the filename that the user wishes to use. Thus, the user's perspective is the same as ours: opening and saving documents rather than reading and writing Drawing object data to the documents. See the difference in concept, even if they are identical in function?

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020