#include <Schema.hpp>

Public Member Functions
	relationship_t (const std::string &name, const std::string &type, bool can_be_null, bool is_multi_value, bool is_aggregation, const std::string &description)
	relationship_t ()
void	print (std::ostream &out, const std::string &prefix="") const

Static Public Member Functions
static const char *	card2str (cardinality_t cardinality)

Public Attributes
std::string	p_name
std::string	p_type
cardinality_t	p_cardinality
bool	p_is_aggregation
std::string	p_description

Detailed Description

The description of relationship.

Definition at line 116 of file Schema.hpp.

Constructor & Destructor Documentation

◆ relationship_t() [1/2]

dunedaq::conffwk::relationship_t::relationship_t	(	const std::string &	name,
		const std::string &	type,
		bool	can_be_null,
		bool	is_multi_value,
		bool	is_aggregation,
		const std::string &	description )

Create relationship description

Definition at line 164 of file ConfigurationImpl.cpp.

  : p_name(name)
  , p_type(type)
  , p_cardinality((can_be_null && !is_multi_value)   ? zero_or_one
                  : (can_be_null && is_multi_value)  ? zero_or_many
                  : (!can_be_null && is_multi_value) ? one_or_many
                                                     : only_one)
  , p_is_aggregation(is_aggregation)
  , p_description(description)
{
  ;
}

◆ relationship_t() [2/2]

dunedaq::conffwk::relationship_t::relationship_t ( )

inline

Default constructor for Python binding

Definition at line 137 of file Schema.hpp.

137{ ; }

Member Function Documentation

◆ card2str()

const char * dunedaq::conffwk::relationship_t::card2str ( cardinality_t cardinality )

static

Return string corresponding to given cardinality

Definition at line 183 of file ConfigurationImpl.cpp.

{
  switch (cardinality) {
    case zero_or_one:
      return "zero or one";
    case zero_or_many:
      return "zero or many";
    case only_one:
      return "one";
    case one_or_many:
      return "one or many";
    default:
      return "unknown";
  }
}

◆ print()

void dunedaq::conffwk::relationship_t::print	(	std::ostream &	out,
		const std::string &	prefix = "" ) const

Print description of relationship to stream.

Parameters

out	the output stream
prefix	optional shift output using prefix

Definition at line 200 of file ConfigurationImpl.cpp.

{
  out << prefix << "relationship \'" << p_name << "\'\n"
      << prefix << "  class type: \'" << p_type << "\'\n"
      << prefix << "  cardinality: \'" << card2str(p_cardinality) << "\'\n"
      << prefix << "  is aggregation: \'" << bool2str(p_is_aggregation) << "\'\n"
      << prefix << "  description: \'" << p_description << '\'';
}

Member Data Documentation

◆ p_cardinality

cardinality_t dunedaq::conffwk::relationship_t::p_cardinality

the relationship cardinality

Definition at line 121 of file Schema.hpp.

◆ p_description

std::string dunedaq::conffwk::relationship_t::p_description

the description text of relationship

Definition at line 124 of file Schema.hpp.

◆ p_is_aggregation

bool dunedaq::conffwk::relationship_t::p_is_aggregation

if true, the relationship is an aggregation (composite); otherwise the relationship is simple (weak)

Definition at line 122 of file Schema.hpp.

◆ p_name

std::string dunedaq::conffwk::relationship_t::p_name

the relationship name

Definition at line 119 of file Schema.hpp.

◆ p_type

std::string dunedaq::conffwk::relationship_t::p_type

the relationship class type

Definition at line 120 of file Schema.hpp.

The documentation for this struct was generated from the following files:

/github/workspace/dunedaq/sourcecode/conffwk/include/conffwk/Schema.hpp
/github/workspace/dunedaq/sourcecode/conffwk/src/ConfigurationImpl.cpp

Public Member Functions

Static Public Member Functions

Public Attributes