dunedaq::conffwk::attribute_t Struct Reference

#include <Schema.hpp>

Public Member Functions
	attribute_t (const std::string &name, type_t type, const std::string &range, int_format_t int_format, bool is_not_null, bool is_multi_value, const std::string &default_value, const std::string &description)
	attribute_t ()
void	print (std::ostream &out, const std::string &prefix="") const

Static Public Member Functions
static const char *	type2str (type_t type)
static const char *	type (type_t type)
static const char *	format2str (int_format_t format)

Public Attributes
std::string	p_name
type_t	p_type
std::string	p_range
int_format_t	p_int_format
bool	p_is_not_null
bool	p_is_multi_value
std::string	p_default_value
std::string	p_description

Detailed Description

The description of attribute.

Definition at line 59 of file Schema.hpp.

Constructor & Destructor Documentation

attribute_t() [1/2]

dunedaq::conffwk::attribute_t::attribute_t	(	const std::string &	name,
		type_t	type,
		const std::string &	range,
		int_format_t	int_format,
		bool	is_not_null,
		bool	is_multi_value,
		const std::string &	default_value,
		const std::string &	description )

Create attribute description

Definition at line 19 of file ConfigurationImpl.cpp.

      :
      p_name             (name),
      p_type             (type),
      p_range            (range),
      p_int_format       (int_format),
      p_is_not_null      (is_not_null),
      p_is_multi_value   (is_multi_value),
      p_default_value    (default_value),
      p_description      (description)
    { ; }

attribute_t() [2/2]

dunedaq::conffwk::attribute_t::attribute_t ( )

inline

Default constructor for Python binding

Definition at line 86 of file Schema.hpp.

{ ; }

Member Function Documentation

format2str()

const char * dunedaq::conffwk::attribute_t::format2str ( int_format_t format )

static

Return string corresponding to given integer value representation format

Parameters

format

the integer value representation format

Definition at line 80 of file ConfigurationImpl.cpp.

    {
      switch(type) {
        case oct_int_format:   return "octal";
        case dec_int_format:   return "decimal";
        case hex_int_format:   return "hexadecimal";
        default:               return "not applicable";
      }
    }

print()

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

Print description of attribute to stream.

Parameters

out	the output stream
prefix	optional shift output using prefix

Definition at line 90 of file ConfigurationImpl.cpp.

    {
      out
        << prefix << "attribute \'" << p_name << "\'\n"
        << prefix << "  type: \'" << type2str(p_type) << "\'\n"
        << prefix << "  range: \'" << p_range << "\'\n";
 
      if(p_int_format != na_int_format) {
        out << prefix << "  integer format: \'" << format2str(p_int_format) << "\'\n";
      }
 
      out
        << prefix << "  is not null: " << bool2str(p_is_not_null) << '\n'
        << prefix << "  is multi-value: " << bool2str(p_is_multi_value) << '\n'
        << prefix << "  default value: \'" << p_default_value << "\'\n"
        << prefix << "  description: \'" << p_description << '\'';
    }

type()

const char * dunedaq::conffwk::attribute_t::type ( type_t type )

static

Return short string (oks data type) corresponding to given data type

Parameters

type	the data type

Definition at line 57 of file ConfigurationImpl.cpp.

    {
      switch(type) {
        case bool_type:   return "bool";
        case s8_type:     return "s8";
        case u8_type:     return "u8";
        case s16_type:    return "s16";
        case u16_type:    return "u16";
        case s32_type:    return "s32";
        case u32_type:    return "u32";
        case s64_type:    return "s64";
        case u64_type:    return "u64";
        case float_type:  return "float";
        case double_type: return "double";
        case date_type:   return "date";
        case time_type:   return "time";
        case string_type: return "string";
        case enum_type:   return "enum";
        case class_type:  return "class";
        default:          return "unknown";
      }
    }

type2str()

const char * dunedaq::conffwk::attribute_t::type2str ( type_t type )

static

Return string corresponding to given data type

Parameters

type	the data type

Definition at line 34 of file ConfigurationImpl.cpp.

    {
      switch(type) {
        case bool_type:   return "boolean";
        case s8_type:     return "8-bits signed integer";
        case u8_type:     return "8-bits unsigned integer";
        case s16_type:    return "16-bits signed integer";
        case u16_type:    return "16-bits unsigned integer";
        case s32_type:    return "32-bits signed integer";
        case u32_type:    return "32-bits unsigned integer";
        case s64_type:    return "64-bits signed integer";
        case u64_type:    return "64-bits unsigned integer";
        case float_type:  return "float";
        case double_type: return "double";
        case date_type:   return "date";
        case time_type:   return "time";
        case string_type: return "string";
        case enum_type:   return "enumeration";
        case class_type:  return "class reference";
        default:          return "unknown";
      }
    }

Member Data Documentation

p_default_value

std::string dunedaq::conffwk::attribute_t::p_default_value

the default value of attribute

Definition at line 67 of file Schema.hpp.

p_description

std::string dunedaq::conffwk::attribute_t::p_description

the description text of attribute

Definition at line 68 of file Schema.hpp.

p_int_format

int_format_t dunedaq::conffwk::attribute_t::p_int_format

the representation format for integer values

Definition at line 64 of file Schema.hpp.

p_is_multi_value

bool dunedaq::conffwk::attribute_t::p_is_multi_value

if true, the value of attribute is a list of primitive values (e.g. list of strings, list of integer numbers, etc.)

Definition at line 66 of file Schema.hpp.

p_is_not_null

bool dunedaq::conffwk::attribute_t::p_is_not_null

if true, the value of attribute cannot be null

Definition at line 65 of file Schema.hpp.

p_name

std::string dunedaq::conffwk::attribute_t::p_name

the attribute name

Definition at line 61 of file Schema.hpp.

p_range

std::string dunedaq::conffwk::attribute_t::p_range

the attribute range in UML syntax (e.g.: "A,B,C..D,*..F,G..*" => value can be A, B, greater or equal to C and less or equal to D, less or equal to F, greater or equal to G)

Definition at line 63 of file Schema.hpp.

p_type

type_t dunedaq::conffwk::attribute_t::p_type

the attribute type

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