dunedaq::conffwk::class_t Struct Reference

#include <Schema.hpp>

Public Member Functions
	class_t (const std::string &name, const std::string &description, const std::string &schema_path, bool is_abstract)
	class_t ()
void	print (std::ostream &out, const std::string &prefix="") const

Public Attributes
std::string	p_name
std::string	p_description
std::string	p_schema_path
bool	p_abstract
const std::vector< std::string >	p_superclasses
const std::vector< std::string >	p_subclasses
const std::vector< attribute_t >	p_attributes
const std::vector< relationship_t >	p_relationships

Detailed Description

The description of class.

Definition at line 152 of file Schema.hpp.

Constructor & Destructor Documentation

class_t() [1/2]

dunedaq::conffwk::class_t::class_t	(	const std::string &	name,
		const std::string &	description,
		const std::string &	schema_path,
		bool	is_abstract )

Create class description

Definition at line 216 of file ConfigurationImpl.cpp.

  : p_name(name)
  , p_description(description)
  , p_schema_path(schema_path)
  , p_abstract(is_abstract)
{
  ;
}

class_t() [2/2]

dunedaq::conffwk::class_t::class_t ( )

inline

Default constructor for Python binding

Definition at line 170 of file Schema.hpp.

{ ; }

Member Function Documentation

print()

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

Print description of class to stream.

Parameters

out	the output stream
prefix	optional shift output using prefix

Definition at line 229 of file ConfigurationImpl.cpp.

{
  out << prefix << "class \'" << p_name << "\'\n"
      << prefix << "  is abstract: \'" << bool2str(p_abstract) << "\'\n"
      << prefix << "  description: \'" << p_description << "\'\n"
      << prefix << "  path: \'" << p_schema_path << "\'\n";
 
  if (p_superclasses.empty()) {
    out << prefix << "  there are no superclasses\n";
  } else {
    out << prefix << "  " << p_superclasses.size() << " superclass(es):\n";
    for (std::vector<std::string>::const_iterator i = p_superclasses.begin(); i != p_superclasses.end(); ++i) {
      out << prefix << "    \'" << *i << "\'\n";
    }
  }
 
  if (p_subclasses.empty()) {
    out << prefix << "  there are no subclasses\n";
  } else {
    out << prefix << "  " << p_subclasses.size() << " subclass(es):\n";
    for (std::vector<std::string>::const_iterator i = p_subclasses.begin(); i != p_subclasses.end(); ++i) {
      out << prefix << "    \'" << *i << "\'\n";
    }
  }
 
  std::string new_prefix(prefix);
  new_prefix += "    ";
 
  if (p_attributes.empty()) {
    out << prefix << "  there are no attributes\n";
  } else {
    out << prefix << "  " << p_attributes.size() << " attribute(s):\n";
    for (std::vector<attribute_t>::const_iterator i = p_attributes.begin(); i != p_attributes.end(); ++i) {
      (*i).print(out, new_prefix.c_str());
      out << std::endl;
    }
  }
 
  if (p_relationships.empty()) {
    out << prefix << "  there are no relationships\n";
  } else {
    out << prefix << "  " << p_relationships.size() << " relationship(s):\n";
    for (std::vector<relationship_t>::const_iterator i = p_relationships.begin(); i != p_relationships.end(); ++i) {
      (*i).print(out, new_prefix.c_str());
      out << std::endl;
    }
  }
}

Member Data Documentation

p_abstract

bool dunedaq::conffwk::class_t::p_abstract

if true, the class is abstract and has no objects

Definition at line 158 of file Schema.hpp.

p_attributes

const std::vector<attribute_t> dunedaq::conffwk::class_t::p_attributes

the all attributes of the class

Definition at line 161 of file Schema.hpp.

p_description

std::string dunedaq::conffwk::class_t::p_description

the description text of class

Definition at line 156 of file Schema.hpp.

p_name

std::string dunedaq::conffwk::class_t::p_name

the class name

Definition at line 155 of file Schema.hpp.

p_relationships

const std::vector<relationship_t> dunedaq::conffwk::class_t::p_relationships

the all relationships of the class

Definition at line 162 of file Schema.hpp.

p_schema_path

std::string dunedaq::conffwk::class_t::p_schema_path

the path to the schema_file

Definition at line 157 of file Schema.hpp.

p_subclasses

const std::vector<std::string> dunedaq::conffwk::class_t::p_subclasses

the names of direct subclasses

Definition at line 160 of file Schema.hpp.

p_superclasses

const std::vector<std::string> dunedaq::conffwk::class_t::p_superclasses

the names of direct superclasses

Definition at line 159 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