urn.h

Go to the documentation of this file.

/* Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2017-03-05
 * Last modified: 2017-03-05
 *
 * License:
 *
 * Copyright (C) 2017 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or (at
 * your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   Utilities for URN manipulation.
 *
 */

#ifndef DATATOOLS_URN_H
#define DATATOOLS_URN_H

// Standard Library:
#include <string>
#include <vector>

// Datatools:
#include <datatools/i_serializable.h>

namespace datatools {


  class urn
    : public datatools::i_serializable
  {
  public:

    static const std::string & urn_scheme();

    static char urn_separator();

    urn();

    urn(const std::vector<std::string> & segments_);

    virtual ~urn();

    bool is_valid() const;

    bool has_namespace() const;

    const std::string & get_namespace() const;

    void set_segments(const std::vector<std::string> & segments_);

    void append_segment(const std::string & segment_);

    std::size_t get_depth() const;

    void reset();

    const std::vector<std::string> & get_segments() const;

    void to_string(std::string &) const;

    std::string to_string() const;

    bool from_string(const std::string &);

    friend std::ostream & operator<<(std::ostream &, const urn &);

  private:

    std::vector<std::string> _segments_; 

    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(urn)

  };

} // end of namespace datatools

#endif // DATATOOLS_URN_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --