{
public:
/** Construct a DCP. You can pass an existing DCP's directory
- * as the parameter, or a non-existant folder to create a new
- * DCP in.
+ * as the parameter; alternatively, directory will be created
+ * if it does not exist. Note that if you pass an existing DCP
+ * into this constructor it will not be read until you call ::read().
*
* @param directory Directory containing the DCP's files.
*/
DCP (boost::filesystem::path directory);
+ typedef std::list<boost::shared_ptr<DCPReadError> > ReadErrors;
+
/** Read the DCP's structure into this object.
* @param keep_going true to try to keep going in the face of (some) errors.
* @param errors List of errors that will be added to if keep_going is true.
*/
- void read (bool keep_going = false, std::list<boost::shared_ptr<DCPReadError> >* errors = 0);
+ void read (bool keep_going = false, ReadErrors* errors = 0);
/** Compare this DCP with another, according to various options.
* @param other DCP to compare this one to.
* @param note Functor to handle notes made by the equality operation.
* @return true if the DCPs are equal according to EqualityOptions, otherwise false.
*/
- bool equals (DCP const & other, EqualityOptions options, boost::function<void (NoteType, std::string)> note) const;
+ bool equals (DCP const & other, EqualityOptions options, NoteHandler note) const;
void add (boost::shared_ptr<Asset> asset);