X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fcollectionsource.h;h=e5647d8231449f2793703eaea083876fd8b0f705;hb=HEAD;hp=90c36f2fce009768874c42b56c21fbf29d11457d;hpb=e3cfc75aa5be3238776caec7f1a437ece7aefa51;p=libs%2Fdatafile.git diff --git a/source/collectionsource.h b/source/collectionsource.h index 90c36f2..eeff10a 100644 --- a/source/collectionsource.h +++ b/source/collectionsource.h @@ -21,21 +21,22 @@ public: typedef std::list NameList; protected: - CollectionSource() { } + CollectionSource() = default; public: - virtual ~CollectionSource() { } + virtual ~CollectionSource() = default; - /** Determines */ + /// Determines whether an object is available from this source. virtual bool is_loadable(const CollectionItemTypeBase &type, const std::string &name) const = 0; - /** Returns the names of loadable objects of a specific type. Implementors - should use the keyword and/or suffixes of the type to */ + /** Returns the names of available objects of a specific type. Implementors + should use type.match_name to check which names are acceptable. */ virtual NameList get_names(const CollectionItemTypeBase &type) const = 0; + /// Loads an item into a collection. virtual void load(Collection &, const CollectionItemTypeBase &, const std::string &) const = 0; - /** Opens a file from the source. The caller is responsible for deleting - the returned object when done with it. */ + /** Opens a raw resource. The caller is responsible for deleting the + returned object when done with it. */ virtual IO::Seekable *open(const std::string &) const = 0; };