relationship.hpp

Go to the documentation of this file.

// DUNE DAQ modification notice:
// This file has been modified from the original ATLAS oks source for the DUNE DAQ project.
// Fork baseline commit: oks-08-03-04 (2022-04-14).
// Renamed since fork: yes (from oks/relationship.h to include/oks/relationship.hpp).

 
#ifndef OKS_RELATIONSHIP_H
#define OKS_RELATIONSHIP_H
 
#include "oks/defs.hpp"
 
#include <string>
 
namespace dunedaq {
namespace oks {
 
class   OksClass;
class   OksXmlOutputStream;
class   OksXmlInputStream;

 

 
class OksRelationship
{
  friend class  OksKernel;
  friend class  OksClass;
  friend struct OksData;
  friend class  OksObject;
 
 
  public:

 
    enum CardinalityConstraint {
      Zero, One, Many
    };
 
 

 
    OksRelationship (const std::string& name, OksClass * p = nullptr);
 

 
    OksRelationship (const std::string& name,
                     const std::string& type,
                     CardinalityConstraint low_cc,
                     CardinalityConstraint high_cc,
                     bool composite,
                     bool exclusive,
                     bool dependent,
                     const std::string& description,
                     OksClass * p = nullptr);
 
 
    bool operator==(const class OksRelationship &) const;
 
    friend std::ostream& operator<<(std::ostream&, const OksRelationship&);
 

 
    const std::string& get_name() const noexcept {return p_name;}
 

 
    void set_name(const std::string&);
 

 
    OksClass * get_class_type() const noexcept {return p_class_type;}
 

 
    const std::string& get_type() const noexcept {return p_rclass;}
 

 
    void set_type(const std::string& type);
 

 
    const std::string& get_description() const noexcept {return p_description;}

 
 
    void set_description(const std::string& description);
 

 
    CardinalityConstraint get_low_cardinality_constraint() const noexcept {return p_low_cc;}
 

 
    void set_low_cardinality_constraint(CardinalityConstraint cc);
 

 
    CardinalityConstraint get_high_cardinality_constraint() const noexcept {return p_high_cc;}
 

 
    void set_high_cardinality_constraint(CardinalityConstraint);
 

 
    bool get_is_composite() const noexcept {return p_composite;}
 

 
    void set_is_composite(bool composite);
 

 
    bool get_is_exclusive() const noexcept {return p_exclusive;}
 

 
    void set_is_exclusive(bool exclusive);
 

 
    bool get_is_dependent() const noexcept {return p_dependent;}
 

 
    void set_is_dependent(bool dependent);
 

 
    static CardinalityConstraint str2card(const char *) noexcept;
 

 
    static const char * card2str(CardinalityConstraint) noexcept;
 
 
  private:
 
    std::string       p_name;
    std::string       p_rclass;
    CardinalityConstraint p_low_cc;
    CardinalityConstraint p_high_cc;
    bool          p_composite;
    bool          p_exclusive;
    bool          p_dependent;
    std::string       p_description;
    OksClass *        p_class;
    OksClass *        p_class_type;
    bool                  p_ordered;
 

 
    OksRelationship   (OksXmlInputStream&, OksClass*); 
    void                  save(OksXmlOutputStream&) const; 
 
 

 
    static const char relationship_xml_tag[];
    static const char name_xml_attr[];
    static const char description_xml_attr[];
    static const char class_type_xml_attr[];
    static const char low_cc_xml_attr[];
    static const char high_cc_xml_attr[];
    static const char is_composite_xml_attr[];
    static const char is_exclusive_xml_attr[];
    static const char is_dependent_xml_attr[];
    static const char mv_implement_xml_attr[];
    static const char ordered_xml_attr[];
 
};
 
} // namespace oks
} // namespace dunedaq
#endif