dunedaq::oks::OksClass Class Reference

The OKS class. More...

#include <class.hpp>

Collaboration diagram for dunedaq::oks::OksClass:

Classes
struct	SortByName
struct	SortStr

Public Types
enum	ChangeType {   ChangeSuperClassesList , ChangeSubClassesList , ChangeDescription , ChangeIsAbstaract ,   ChangeAttributesList , ChangeAttributeType , ChangeAttributeRange , ChangeAttributeFormat ,   ChangeAttributeMultiValueCardinality , ChangeAttributeInitValue , ChangeAttributeDescription , ChangeAttributeIsNoNull ,   ChangeRelationshipsList , ChangeRelationshipClassType , ChangeRelationshipDescription , ChangeRelationshipLowCC ,   ChangeRelationshipHighCC , ChangeRelationshipComposite , ChangeRelationshipExclusive , ChangeRelationshipDependent ,   ChangeMethodsList , ChangeMethodDescription , ChangeMethodImplementation }
	Information about class property changes. More...
typedef std::set< OksClass *, SortByName >	Set
typedef std::map< const char *, OksClass *, SortStr >	Map
typedef std::list< OksClass *, boost::fast_pool_allocator< OksClass * > >	FList
typedef void(*)	NotifyFN(OksClass *)
typedef void(*)	ChangeNotifyFN(OksClass *, ChangeType, const void *)

Public Member Functions
	OksClass (const std::string &name, OksKernel *kernel, bool transient=false)
	Create OKS class.
	OksClass (const std::string &name, const std::string &description, bool is_abstract, OksKernel *kernel, bool transient=false)
	Create OKS class and set its basic properties.
	OksClass (OksKernel *kernel, const std::string &name, const std::string &description, bool is_abstract)
	Create OKS class for internal usage (fast, no complete registration).
bool	operator== (const OksClass &) const
	The equality operator.
bool	operator!= (const OksClass &) const
	The not equal operator.
bool	compare_without_methods (const OksClass &c) const noexcept
OksKernel *	get_kernel () const noexcept
OksFile *	get_file () const noexcept
void	set_file (OksFile *f, bool update_owner=true)
	Move class to different file.
const std::string &	get_name () const noexcept
const std::string &	get_description () const noexcept
void	set_description (const std::string &description)
	Set class description.
bool	get_is_abstract () const noexcept
void	set_is_abstract (bool abstract)
	Set class abstract property.
const FList *	all_super_classes () const noexcept
const std::list< std::string * > *	direct_super_classes () const noexcept
OksClass *	find_super_class (const std::string &) const noexcept
bool	has_direct_super_class (const std::string &) const noexcept
void	add_super_class (const std::string &name)
void	k_add_super_class (const std::string &name)
void	remove_super_class (const std::string &name)
void	swap_super_classes (const std::string &c1, const std::string &c2)
	Swap order of two superclasses.
const FList *	all_sub_classes () const noexcept
const std::list< OksAttribute * > *	all_attributes () const noexcept
const std::list< OksAttribute * > *	direct_attributes () const noexcept
OksAttribute *	find_attribute (const std::string &name) const noexcept
	Find attribute (search in this and base classes).
OksAttribute *	find_direct_attribute (const std::string &name) const noexcept
	Find direct attribute.
void	add (OksAttribute *a)
	Add attribute.
void	k_add (OksAttribute *a)
	Kernel method to add attribute.
void	remove (const OksAttribute *a)
	Remove attribute.
void	swap (const OksAttribute *a1, const OksAttribute *a2)
	Swap order of two attributes.
size_t	number_of_direct_attributes () const noexcept
size_t	number_of_all_attributes () const noexcept
OksClass *	source_class (const OksAttribute *a) const noexcept
	Get class owning given attribute.
const std::list< OksRelationship * > *	all_relationships () const noexcept
const std::list< OksRelationship * > *	direct_relationships () const noexcept
OksRelationship *	find_relationship (const std::string &name) const noexcept
	Find relationship (search in this and base classes).
OksRelationship *	find_direct_relationship (const std::string &name) const noexcept
	Find direct relationship.
void	add (OksRelationship *r)
	Add relationship.
void	k_add (OksRelationship *r)
	Kernel method to add relationship.
void	remove (const OksRelationship *r, bool call_delete=true)
	Remove relationship.
void	swap (const OksRelationship *r1, const OksRelationship *r2)
	Swap order of two relationships.
size_t	number_of_direct_relationships () const noexcept
size_t	number_of_all_relationships () const noexcept
OksClass *	source_class (const OksRelationship *r) const noexcept
	Get class owning given relationship.
const std::list< OksMethod * > *	all_methods () const noexcept
const std::list< OksMethod * > *	direct_methods () const noexcept
OksMethod *	find_method (const std::string &name) const noexcept
	Find method (search in this and base classes).
OksMethod *	find_direct_method (const std::string &name) const noexcept
	Find direct method.
void	add (OksMethod *m)
	Add method.
void	remove (const OksMethod *m)
	Remove method.
void	swap (const OksMethod *m1, const OksMethod *m2)
	Swap order of two methods.
size_t	number_of_direct_methods () const noexcept
size_t	number_of_all_methods () const noexcept
OksClass *	source_class (const OksMethod *m) const noexcept
	Get class owning given method.
size_t	number_of_objects () const noexcept
const OksObject::Map *	objects () const noexcept
std::list< OksObject * > *	create_list_of_all_objects () const noexcept
	Get all objects of the class (including derived).
OksObject *	get_object (const std::string &id) const noexcept
	Get object by ID.
OksObject *	get_object (const std::string *id) const noexcept
OksObject::List *	execute_query (OksQuery *query) const
	Execute query.
OksDataInfo *	data_info (const std::string &s) const noexcept
	Get OKS data information for attribute or relationship.
OksDataInfo *	get_data_info (const std::string &s) const noexcept
	Get OKS data information for attribute or relationship.

Static Public Member Functions
static void	destroy (OksClass *c)
	Destroy OKS class.

Private Member Functions
	~OksClass ()
	OksClass (OksXmlInputStream &, OksKernel *)
	OksClass (const char *name, size_t len)
void	save (OksXmlOutputStream &) const
void	add (OksObject *)
void	remove (OksObject *)
void	registrate_class (bool skip_registered)
void	registrate_class_change (ChangeType, const void *, bool=true)
void	registrate_attribute_change (OksAttribute *)
void	registrate_relationship_change (OksRelationship *)
void	registrate_instances ()
void	add_super_classes (FList *) const
void	create_super_classes ()
void	create_sub_classes ()
void	create_attributes ()
void	create_relationships ()
void	create_methods ()
void	lock_file (const char *)
bool	check_relationships (std::ostringstream &out, bool print_file_name) const noexcept

Static Private Member Functions
template<class T>
static void	destroy_map (T map)
template<class T>
static void	destroy_list (T list)

Private Attributes
std::string	p_name
std::string	p_description
std::list< std::string * > *	p_super_classes
std::list< OksAttribute * > *	p_attributes
std::list< OksRelationship * > *	p_relationships
std::list< OksMethod * > *	p_methods
bool	p_abstract
bool	p_transient
bool	p_to_be_deleted
FList *	p_all_super_classes
FList *	p_all_sub_classes
std::list< OksAttribute * > *	p_all_attributes
std::list< OksRelationship * > *	p_all_relationships
std::list< OksMethod * > *	p_all_methods
std::vector< OksClass * > *	p_inheritance_hierarchy
unsigned int	p_id
OksFile *	p_file
OksKernel *	p_kernel
size_t	p_instance_size
OksDataInfo::Map *	p_data_info
OksObject::Map *	p_objects
OksIndex::Map *	p_indices
std::shared_mutex	p_mutex
std::mutex	p_unique_id_mutex

Static Private Attributes
static NotifyFN	create_notify_fn
static ChangeNotifyFN	change_notify_fn
static NotifyFN	delete_notify_fn
static const char	class_xml_tag [] = "class"
static const char	name_xml_attr [] = "name"
static const char	description_xml_attr [] = "description"
static const char	is_abstract_xml_attr [] = "is-abstract"
static const char	superclass_xml_attr [] = "superclass"

Friends
class	OksObject
class	OksKernel
class	OksAttribute
class	OksRelationship
class	OksMethod
class	OksMethodImplementation
class	OksIndex
class	OksSortedClass
std::ostream &	operator<< (std::ostream &s, const OksClass &c)
	Stream operator.
std::ostream &	operator<< (std::ostream &s, const OksObject &o)

Detailed Description

The OKS class.

An OKS class has name, documentation, attributes (list of OksAttribute objects), relationships (list of OksRelationship objects) and methods (list of OksMethod objects).

A class may participate in inheritance (multiple): in such case the class inherits all attributes, relationships and methods of its base classes.

An OKS class can be abstract (i.e. it does not have any instances). Otherwise the objects of class can be accessed via:

• objects() : get all objects of given class
• create_list_of_all_objects() : get all objects of given and derived classes
• get_object(const std::string&) : get object by unique identity
• execute_query() : get objects satisfying a query See OksObject class to get information how to access properties of object, to create new or to delete existing object.

An OKS class can be made persistent, i.e. stored on OKS schema file.

Definition at line 222 of file class.hpp.

Member Typedef Documentation

ChangeNotifyFN

typedef void(*) dunedaq::oks::OksClass::ChangeNotifyFN(OksClass *, ChangeType, const void *)

Callback function invoked on OKS class modification

Definition at line 877 of file class.hpp.

FList

typedef std::list<OksClass*, boost::fast_pool_allocator<OksClass*> > dunedaq::oks::OksClass::FList

Definition at line 254 of file class.hpp.

Map

typedef std::map<const char*, OksClass*, SortStr> dunedaq::oks::OksClass::Map

Definition at line 252 of file class.hpp.

NotifyFN

typedef void(*) dunedaq::oks::OksClass::NotifyFN(OksClass *)

Callback function invoked on OKS class creation or deletion

Definition at line 873 of file class.hpp.

Set

typedef std::set<OksClass*, SortByName> dunedaq::oks::OksClass::Set

Definition at line 243 of file class.hpp.

Member Enumeration Documentation

ChangeType

enum dunedaq::oks::OksClass::ChangeType

Information about class property changes.

It is used in the ChangeNotifyFN callback, that can be used by user to subscribe on schema changes.

Enumerator
ChangeSuperClassesList
ChangeSubClassesList
ChangeDescription
ChangeIsAbstaract
ChangeAttributesList
ChangeAttributeType
ChangeAttributeRange
ChangeAttributeFormat
ChangeAttributeMultiValueCardinality
ChangeAttributeInitValue
ChangeAttributeDescription
ChangeAttributeIsNoNull
ChangeRelationshipsList
ChangeRelationshipClassType
ChangeRelationshipDescription
ChangeRelationshipLowCC
ChangeRelationshipHighCC
ChangeRelationshipComposite
ChangeRelationshipExclusive
ChangeRelationshipDependent
ChangeMethodsList
ChangeMethodDescription
ChangeMethodImplementation

Definition at line 839 of file class.hpp.

  {
 
    ChangeSuperClassesList,
    ChangeSubClassesList,
    ChangeDescription,
    ChangeIsAbstaract,
 
    ChangeAttributesList,
    ChangeAttributeType,
    ChangeAttributeRange,
    ChangeAttributeFormat,
    ChangeAttributeMultiValueCardinality,
    ChangeAttributeInitValue,
    ChangeAttributeDescription,
    ChangeAttributeIsNoNull,
 
    ChangeRelationshipsList,
    ChangeRelationshipClassType,
    ChangeRelationshipDescription,
    ChangeRelationshipLowCC,
    ChangeRelationshipHighCC,
    ChangeRelationshipComposite,
    ChangeRelationshipExclusive,
    ChangeRelationshipDependent,
 
    ChangeMethodsList,
    ChangeMethodDescription,
    ChangeMethodImplementation
 
  };

Constructor & Destructor Documentation

OksClass() [1/5]

dunedaq::oks::OksClass::OksClass	(	const std::string &	name,
		OksKernel *	kernel,
		bool	transient = false )

Create OKS class.

The parameters are:

Parameters

name	name of new class
kernel	OKS kernel owning this class (if empty, class will not be registered)
transient	if true, the class is transient (is used by OKS tools, do not change default value)

Definition at line 81 of file class.cpp.

  : p_name(nm)
  , p_super_classes(0)
  , p_attributes(0)
  , p_relationships(0)
  , p_methods(0)
  , p_abstract(false)
  , p_transient(t)
  , p_to_be_deleted(false)
  , p_all_super_classes(0)
  , p_all_sub_classes(0)
  , p_all_attributes(0)
  , p_all_relationships(0)
  , p_all_methods(0)
  , p_inheritance_hierarchy(0)
  , p_kernel(k)
  , p_instance_size(0)
  , p_data_info(0)
  , p_objects(0)
  , p_indices(0)
{
  OSK_PROFILING(OksProfiler::ClassConstructor, p_kernel)
 
  if (p_transient == false && p_kernel) {
    oks::validate_not_empty(p_name, "class name");
 
    std::unique_lock lock(p_kernel->p_kernel_mutex);
    p_kernel->k_add(this);
  }
}

OksClass() [2/5]

dunedaq::oks::OksClass::OksClass	(	const std::string &	name,
		const std::string &	description,
		bool	is_abstract,
		OksKernel *	kernel,
		bool	transient = false )

Create OKS class and set its basic properties.

The parameters are:

Parameters

name	name of new class
description	description of new class
is_abstract	if true, new class is abstract (i.e. may not have objects)
kernel	OKS kernel owning this class (if empty, class will not be registered)
transient	if true, the class is transient (is used by OKS tools, do not change default value)

Definition at line 112 of file class.cpp.

  : p_name(nm)
  , p_description(d)
  , p_super_classes(0)
  , p_attributes(0)
  , p_relationships(0)
  , p_methods(0)
  , p_abstract(a)
  , p_transient(t)
  , p_to_be_deleted(false)
  , p_all_super_classes(0)
  , p_all_sub_classes(0)
  , p_all_attributes(0)
  , p_all_relationships(0)
  , p_all_methods(0)
  , p_inheritance_hierarchy(0)
  , p_kernel(k)
  , p_instance_size(0)
  , p_data_info(0)
  , p_objects(0)
  , p_indices(0)
{
  OSK_PROFILING(OksProfiler::ClassConstructor, p_kernel)
 
  if (p_transient == false && p_kernel) {
    oks::validate_not_empty(p_name, "class name");
 
    std::unique_lock lock(p_kernel->p_kernel_mutex);
    p_kernel->k_add(this);
  }
}

OksClass() [3/5]

dunedaq::oks::OksClass::OksClass	(	OksKernel *	kernel,
		const std::string &	name,
		const std::string &	description,
		bool	is_abstract )

Create OKS class for internal usage (fast, no complete registration).

The parameters are:

Parameters

kernel	OKS kernel owning this class
name	name of new class
description	description of new class
is_abstract	if true, new class is abstract (i.e. may not have objects)

Definition at line 144 of file class.cpp.

  : p_name(name)
  , p_description(description)
  , p_super_classes(0)
  , p_attributes(0)
  , p_relationships(0)
  , p_methods(0)
  , p_abstract(is_abstract)
  , p_transient(false)
  , p_to_be_deleted(false)
  , p_all_super_classes(0)
  , p_all_sub_classes(0)
  , p_all_attributes(0)
  , p_all_relationships(0)
  , p_all_methods(0)
  , p_inheritance_hierarchy(0)
  , p_file(kernel->p_active_schema)
  , p_kernel(kernel)
  , p_instance_size(0)
  , p_data_info(0)
  , p_objects(0)
  , p_indices(0)
{
  OSK_PROFILING(OksProfiler::ClassConstructor, p_kernel)
  p_kernel->p_classes[p_name.c_str()] = this;
}

~OksClass()

dunedaq::oks::OksClass::~OksClass ( )

private

Definition at line 220 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassDestructor, p_kernel)
 
  TLOG_DEBUG(2) << "destruct " << (p_transient ? "TRANSIENT" : "NORMAL") << " class \'" << get_name() << '\'';
 
  // ~OksIndex() removes 'SELF' from OksClass and deletes 'indices' when there is no an index in it
  while (p_indices)
    delete (*(p_indices->begin())).second;
 
  destroy_map(p_objects);
  destroy_map(p_data_info);
 
  if (!p_transient && p_kernel) {
    p_kernel->k_remove(this);
 
    if (p_all_super_classes)
      for (const auto& c : *p_all_super_classes) {
        if (p_kernel->is_dangling(c) || c->p_to_be_deleted)
          continue;
 
        c->create_sub_classes();
 
        if (OksClass::change_notify_fn)
          (*OksClass::change_notify_fn)(c, ChangeSubClassesList, (const void*)&p_name);
      }
 
    if (p_all_sub_classes)
      for (const auto& c : *p_all_sub_classes) {
        if (p_kernel->is_dangling(c) || c->p_to_be_deleted)
          continue;
 
        try {
          c->registrate_class_change(ChangeSuperClassesList, (const void*)&p_name, false);
        } catch (oks::exception& ex) {
          std::cerr << "internal OKS error: registrate_class_change() failed during \'" << get_name()
                    << "\' class destruction\ncaused by: " << ex.what() << std::endl;
        }
      }
  }
 
  destroy_list(p_super_classes);
  destroy_list(p_attributes);
  destroy_list(p_relationships);
  destroy_list(p_methods);
 
  if (!p_transient) {
    delete p_all_super_classes;
    delete p_all_sub_classes;
    delete p_all_attributes;
    delete p_all_relationships;
    delete p_all_methods;
    delete p_inheritance_hierarchy;
  }
}

OksClass() [4/5]

dunedaq::oks::OksClass::OksClass ( OksXmlInputStream & s, OksKernel * k )

private

Definition at line 498 of file class.cpp.

  : p_super_classes(0)
  , p_attributes(0)
  , p_relationships(0)
  , p_methods(0)
  , p_abstract(false)
  , p_transient(false)
  , p_to_be_deleted(false)
  , p_all_super_classes(0)
  , p_all_sub_classes(0)
  , p_all_attributes(0)
  , p_all_relationships(0)
  , p_all_methods(0)
  , p_inheritance_hierarchy(0)
  , p_kernel(k)
  , p_instance_size(0)
  , p_data_info(0)
  , p_objects(0)
  , p_indices(0)
{
 
  // read 'relationship' tag header
 
  {
    try {
      const char* tag_start = s.get_tag_start();
 
      if (strcmp(tag_start, class_xml_tag)) {
        if (!strcmp(tag_start, "/oks-schema")) {
          goto end_of_stream; // re-throw of exception takes too much time; go to is better
        }
        s.throw_unexpected_tag(tag_start, class_xml_tag);
      }
    } catch (oks::exception& e) {
      throw oks::FailedRead("oks-class tag", e);
    } catch (std::exception& e) {
      throw oks::FailedRead("oks-class tag", e.what());
    }
  }
 
  // read class attributes
 
  try {
    while (true) {
      OksXmlAttribute attr(s);
 
      // check for close of tag
 
      if (oks::cmp_str1(attr.name(), ">")) {
        break;
      }
 
      // check for known oks-class' attributes
 
      else if (oks::cmp_str4(attr.name(), name_xml_attr))
        p_name.assign(attr.value(), attr.value_len());
      else if (oks::cmp_str11(attr.name(), description_xml_attr))
        p_description.assign(attr.value(), attr.value_len());
      else if (oks::cmp_str11(attr.name(), is_abstract_xml_attr))
        p_abstract = oks::xml::str2bool(attr.value());
      else {
        s.throw_unexpected_tag(attr.name(), "oks-class\' attribute");
      }
    }
  } catch (oks::exception& e) {
    throw oks::FailedRead("oks-class description", e);
  } catch (std::exception& e) {
    throw oks::FailedRead("oks-class description", e.what());
  }
 
  try {
    oks::validate_not_empty(p_name, "class name");
  } catch (std::exception& ex) {
    throw oks::FailedRead("oks class", oks::BadFileData(ex.what(), s.get_line_no(), s.get_line_pos()));
  }
 
  // read class body
 
  while (true) {
 
    try {
 
      const char* tag_start = s.get_tag_start();
 
      // check for closing tag and exit loop
 
      if (oks::cmp_str6(tag_start, "/class")) {
        break;
      }
 
      // create superclass
 
      else if (oks::cmp_str10(tag_start, superclass_xml_attr)) {
        unsigned long scl_pos = s.get_line_no();
        try {
          OksXmlAttribute attr(s);
 
          if (!p_super_classes)
            p_super_classes = new std::list<std::string*>();
          std::string* scl = new std::string(attr.value(), attr.value_len());
          if (has_direct_super_class(*scl)) {
            std::ostringstream text;
            text << "second inclusion of super-class \"" + *scl + "\" at line " << scl_pos;
            delete scl;
            throw std::runtime_error(text.str().c_str());
          }
          p_super_classes->push_back(scl);
 
          OksXmlAttribute attr2(s);
        } catch (oks::exception& e) {
          throw oks::FailedRead(std::string("a superclass-name of class \"") + p_name + '\"', e);
        } catch (std::exception& e) {
          throw oks::FailedRead(std::string("a superclass-name of class \"") + p_name + '\"', e.what());
        }
      }
 
      // create attribute from stream and check attribute status
 
      else if (oks::cmp_str9(tag_start, "attribute")) {
        unsigned long attr_pos = s.get_line_no();
        try {
          if (!p_attributes)
            p_attributes = new std::list<OksAttribute*>();
          OksAttribute* a = new OksAttribute(s, this);
          if (find_direct_attribute(a->get_name()) != nullptr) {
            std::ostringstream text;
            text << "redefinition of attribute with name \"" + a->get_name() + "\" at line " << attr_pos;
            delete a;
            throw std::runtime_error(text.str().c_str());
          }
          p_attributes->push_back(a);
        } catch (oks::exception& e) {
          throw oks::FailedRead(std::string("an attribute of class \"") + p_name + '\"', e);
        } catch (std::exception& e) {
          throw oks::FailedRead(std::string("an attribute of class \"") + p_name + '\"', e.what());
        }
      }
 
      // create relationship from stream and check relationship status
 
      else if (oks::cmp_str12(tag_start, "relationship")) {
        unsigned long rel_pos = s.get_line_no();
        try {
          if (!p_relationships)
            p_relationships = new std::list<OksRelationship*>();
          OksRelationship* r = new OksRelationship(s, this);
          if (find_direct_relationship(r->get_name()) != nullptr) {
            std::ostringstream text;
            text << "redefinition of relationship with name \"" + r->get_name() + "\" at line " << rel_pos;
            delete r;
            throw std::runtime_error(text.str().c_str());
          }
          p_relationships->push_back(r);
        } catch (oks::exception& e) {
          throw oks::FailedRead(std::string("a relationship of class \"") + p_name + '\"', e);
        } catch (std::exception& e) {
          throw oks::FailedRead(std::string("a relationship of class \"") + p_name + '\"', e.what());
        }
      }
 
      // create method from stream and check method status
 
      else if (oks::cmp_str6(tag_start, "method")) {
        unsigned long method_pos = s.get_line_no();
        try {
          if (!p_methods)
            p_methods = new std::list<OksMethod*>();
          OksMethod* m = new OksMethod(s, this);
          if (find_direct_method(m->get_name()) != nullptr) {
            std::ostringstream text;
            text << "redefinition of method with name \"" + m->get_name() + "\" at line " << method_pos;
            delete m;
            throw std::runtime_error(text.str().c_str());
          }
          p_methods->push_back(m);
        } catch (oks::exception& e) {
          throw oks::FailedRead(std::string("a method of class \"") + p_name + '\"', e);
        } catch (std::exception& e) {
          throw oks::FailedRead(std::string("a method of class \"") + p_name + '\"', e.what());
        }
      }
 
      // report error if red something differnt from above
      // and set bad status of constructor (suppose 'name' can't be empty)
 
      else {
        s.throw_unexpected_tag(tag_start);
      }
 
    } catch (oks::FailedRead& e) {
      throw; // re-throw attribute, relationship or method exception
    } catch (oks::exception& e) {
      throw oks::FailedRead(std::string("a tag of class \"") + p_name + '\"', e);
    } catch (std::exception& e) {
      throw oks::FailedRead(std::string("a tag of class \"") + p_name + '\"', e.what());
    }
  }
 
  return;
 
end_of_stream:
 
  throw oks::EndOfXmlStream("oks-schema");
}

OksClass() [5/5]

dunedaq::oks::OksClass::OksClass ( const char * name, size_t len )

inlineprivate

Definition at line 1005 of file class.hpp.

  : p_name(name, len)
  , p_super_classes(0)
  , p_attributes(0)
  , p_relationships(0)
  , p_methods(0)
  , p_abstract(false)
  , p_transient(true)
  , p_to_be_deleted(false)
  , p_all_super_classes(0)
  , p_all_sub_classes(0)
  , p_all_attributes(0)
  , p_all_relationships(0)
  , p_all_methods(0)
  , p_inheritance_hierarchy(0)
  , p_kernel(0)
  , p_instance_size(0)
  , p_data_info(0)
  , p_objects(0)
  , p_indices(0)
{
  ;
}

Member Function Documentation

add() [1/4]

void dunedaq::oks::OksClass::add

(

OksAttribute *

a

)

Add attribute.

Add new attribute to class. The class must not have attributes with such name.

Parameters

a	new attribute

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1009 of file class.cpp.

{
  const char* fname = "OksClass::add(OksAttribute *)";
 
  if (!p_attributes) {
    p_attributes = new std::list<OksAttribute*>();
  } else {
    if (find_direct_attribute(attribute->get_name()) != 0) {
      std::ostringstream text;
      text << "cannot add attribute \"" << attribute->get_name() << "\" to class \"" << p_name
           << "\"\n"
              "because the class already has attribute with this name.\n";
      throw oks::SetOperationFailed(fname, text.str());
    }
  }
 
  lock_file("OksClass::add[OksAttribute]");
 
  p_attributes->push_back(attribute);
  attribute->p_class = this;
 
  registrate_class_change(ChangeAttributesList, (const void*)attribute);
}

add() [2/4]

void dunedaq::oks::OksClass::add

(

OksMethod *

m

)

Add method.

Add new method to class. The class must not have methods with such name.

Parameters

m	new method

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1315 of file class.cpp.

{
  const char* fname = "OksClass::add(OksMethod *)";
 
  if (!p_methods) {
    p_methods = new std::list<OksMethod*>();
  } else {
    if (find_direct_method(method->get_name())) {
      std::ostringstream text;
      text << "cannot add method \"" << method->get_name() << "\" to class \"" << p_name
           << "\"\n"
              "because the class already has method with this name.\n";
      throw oks::SetOperationFailed(fname, text.str());
    }
  }
 
  // check that the file can be locked
 
  lock_file("OksClass::add[OksMethod]");
 
  p_methods->push_back(method);
  method->p_class = this;
 
  registrate_class_change(ChangeMethodsList, (const void*)method);
}

add() [3/4]

void dunedaq::oks::OksClass::add ( OksObject * object )

private

Definition at line 1497 of file class.cpp.

{
  std::unique_lock lock(p_mutex); // protect p_objects
 
  if (!p_objects->insert(std::pair<const std::string*, OksObject*>(&object->uid.object_id, object)).second) {
    throw oks::ObjectOperationFailed(*this, object->uid.object_id, "add", "object already exists");
  }
}

add() [4/4]

void dunedaq::oks::OksClass::add

(

OksRelationship *

r

)

Add relationship.

Add new relationship to class. The class must not have relationships with such name.

Parameters

r	new relationship

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1167 of file class.cpp.

{
  const char* fname = "OksClass::add(OksRelationship *)";
 
  if (!p_relationships) {
    p_relationships = new std::list<OksRelationship*>();
  } else {
    if (find_direct_relationship(relationship->get_name())) {
      std::ostringstream text;
      text << "cannot add relationship \"" << relationship->get_name() << "\" to class \"" << p_name
           << "\"\n"
              "because the class already has relationship with this name.\n";
      throw oks::SetOperationFailed(fname, text.str());
    }
  }
 
  lock_file("OksClass::add[OksRelationship]");
 
  p_relationships->push_back(relationship);
  relationship->p_class = this;
 
  registrate_class_change(ChangeRelationshipsList, (const void*)relationship);
}

add_super_class()

void dunedaq::oks::OksClass::add_super_class

(

const std::string &

name

)

Add direct base class with given name.

Parameters

name	name of superclass

Exceptions

oks::exception

is thrown in case of problems

Definition at line 840 of file class.cpp.

{
  if (!p_super_classes) {
    p_super_classes = new std::list<std::string*>();
  } else {
    if (has_direct_super_class(nm)) {
      std::string text(add_super_class_error(nm, p_name));
      text += " because class \"" + p_name + "\" already has such superclass.";
      throw oks::SetOperationFailed("OksClass::add_super_class", text);
    }
  }
 
  if (nm == p_name) {
    std::string text(add_super_class_error(nm, p_name));
    text += " because names of classes are the same.";
    throw oks::SetOperationFailed("OksClass::add_super_class", text);
  }
 
  if (p_kernel) {
    OksClass* nmc = p_kernel->find_class(nm);
    if (nmc) {
      if (nmc->has_direct_super_class(p_name)) {
        std::string text(add_super_class_error(nm, p_name));
        text += " because class \"" + nm + "\" is already direct superclass of \"" + p_name + "\".";
        throw oks::SetOperationFailed("OksClass::add_super_class", text);
      } else if (nmc->find_super_class(p_name)) {
        std::string text(add_super_class_error(nm, p_name));
        text += " because class \"" + nm + "\" is already non-direct superclass of \"" + p_name + "\".";
        throw oks::SetOperationFailed("OksClass::add_super_class", text);
      }
    }
  }
 
  lock_file("OksClass::add_super_class");
 
  p_super_classes->push_back((new std::string(nm)));
 
  registrate_class_change(ChangeSuperClassesList, (const void*)&nm);
}

add_super_classes()

void dunedaq::oks::OksClass::add_super_classes ( FList * clist ) const

private

Definition at line 1535 of file class.cpp.

{
  if (p_super_classes) {
    for (std::list<std::string*>::const_iterator i = p_super_classes->begin(); i != p_super_classes->end(); ++i) {
      if (OksClass* c = p_kernel->find_class(**i)) {
        c->add_super_classes(clist);
        add_if_not_found(*clist, c);
      } else {
        throw oks::CannotFindSuperClass(*this, **i);
      }
    }
  }
}

all_attributes()

const std::list< OksAttribute * > * dunedaq::oks::OksClass::all_attributes ( ) const

inlinenoexcept

Get list of all attributes (including defined in base classes)

Definition at line 470 of file class.hpp.

{ return p_all_attributes; }

all_methods()

const std::list< OksMethod * > * dunedaq::oks::OksClass::all_methods ( ) const

inlinenoexcept

Get list of all methods (including defined in base classes)

Definition at line 667 of file class.hpp.

{ return p_all_methods; }

all_relationships()

const std::list< OksRelationship * > * dunedaq::oks::OksClass::all_relationships ( ) const

inlinenoexcept

Get list of all relationships (including defined in base classes)

Definition at line 568 of file class.hpp.

{ return p_all_relationships; }

all_sub_classes()

const FList * dunedaq::oks::OksClass::all_sub_classes ( ) const

inlinenoexcept

Return list of all derived classes.

Definition at line 463 of file class.hpp.

{ return p_all_sub_classes; }

all_super_classes()

const FList * dunedaq::oks::OksClass::all_super_classes ( ) const

inlinenoexcept

Return list of all base classes of given class.

Definition at line 413 of file class.hpp.

{ return p_all_super_classes; }

check_relationships()

bool dunedaq::oks::OksClass::check_relationships ( std::ostringstream & out, bool print_file_name ) const

privatenoexcept

Definition at line 2098 of file class.cpp.

{
  bool found_problems = false;
 
  if (const std::list<OksRelationship*>* rels = direct_relationships()) {
    for (auto& x : *rels) {
      if (x->get_class_type() == nullptr) {
        if (found_problems == false) {
          found_problems = true;
          out << " * there are problems with class \"" << get_name() << '\"';
          if (print_file_name) {
            out << " from file \"" << get_file()->get_full_file_name() << '\"';
          }
          out << ":\n";
        }
 
        out << "   - class type \"" << x->get_type() << "\" of relationship \"" << x->get_name()
            << "\" is not loaded\n";
      }
    }
  }
 
  return found_problems;
}

compare_without_methods()

bool dunedaq::oks::OksClass::compare_without_methods ( const OksClass & c ) const

noexcept

Compare all properties of classes excluding methods

Definition at line 297 of file class.cpp.

{
  if (this == &c)
    return true;
 
  if ((p_name != c.p_name) || (p_description != c.p_description) || (p_abstract != c.p_abstract))
    return false;
 
  int l1 = (p_attributes == 0) ? 0 : p_attributes->size();
  int l2 = (c.p_attributes == 0) ? 0 : c.p_attributes->size();
 
  if (l1 != l2)
    return false;
 
  if (l1 > 0) {
    std::list<OksAttribute*>::const_iterator i1 = p_attributes->begin();
    std::list<OksAttribute*>::const_iterator i2 = c.p_attributes->begin();
 
    for (; i1 != p_attributes->end(); ++i1, ++i2)
      if (!(*(*i1) == *(*i2)))
        return false;
  }
 
  l1 = (p_relationships == 0) ? 0 : p_relationships->size();
  l2 = (c.p_relationships == 0) ? 0 : c.p_relationships->size();
 
  if (l1 != l2)
    return false;
 
  if (l1 > 0) {
    std::list<OksRelationship*>::const_iterator i1 = p_relationships->begin();
    std::list<OksRelationship*>::const_iterator i2 = c.p_relationships->begin();
 
    for (; i1 != p_relationships->end(); ++i1, ++i2)
      if (!(*(*i1) == *(*i2)))
        return false;
  }
 
  l1 = (p_super_classes == 0) ? 0 : p_super_classes->size();
  l2 = (c.p_super_classes == 0) ? 0 : c.p_super_classes->size();
 
  if (l1 != l2)
    return false;
 
  if (l1 > 0) {
    std::list<std::string*>::const_iterator i1 = p_super_classes->begin();
    std::list<std::string*>::const_iterator i2 = c.p_super_classes->begin();
 
    for (; i1 != p_super_classes->end(); ++i1, ++i2)
      if (!(*(*i1) == *(*i2)))
        return false;
  }
 
  return true;
}

create_attributes()

void dunedaq::oks::OksClass::create_attributes ( )

private

Definition at line 1620 of file class.cpp.

{
  if (p_attributes)
    for (const auto& x : *p_attributes)
      x->set_init_data();
 
  if (!p_all_attributes)
    p_all_attributes = new std::list<OksAttribute*>();
  else
    p_all_attributes->clear();
 
  if (p_all_super_classes) {
    for (FList::iterator i = p_all_super_classes->begin(); i != p_all_super_classes->end(); ++i) {
      OksClass* c(*i);
      if (c->p_attributes) {
        for (std::list<OksAttribute*>::iterator i2 = c->p_attributes->begin(); i2 != c->p_attributes->end(); ++i2) {
          OksAttribute* a(*i2);
          OksAttribute* a1 = find_direct_attribute(a->get_name());
          OksAttribute* a2 = find_attribute(a->get_name());
          if (a1 == 0 && a2 == 0) {
            p_all_attributes->push_back(a);
          } else if (!p_kernel->p_silence) {
            if (a1) {
              TLOG_DEBUG(1) << "in class \'" << get_name() << "\' direct attribute \'" << a1->get_name()
                            << "\' overrides one coming from superclass \'" << a->p_class->get_name() << '\'';
              if (are_types_different(a1, a)) {
                Oks::warning_msg("OksClass::create_attributes()")
                  << "  found attribute \'" << a->get_name() << "\' types conflict in class \'" << get_name() << "\':\n"
                  << "  type of attribute in superclass \'" << a->p_class->get_name() << "\' is \'" << a->get_type()
                  << "\'\n"
                  << "  type of attribute in class \'" << get_name() << "\' is \'" << a1->get_type() << "\'\n";
              }
 
              if (a1->get_is_multi_values() != a->get_is_multi_values()) {
                Oks::warning_msg("OksClass::create_attributes()")
                  << "  found attribute \'" << a->get_name() << "\' types conflict in class \'" << get_name() << "\':\n"
                  << "  attribute in superclass \'" << a->p_class->get_name() << "\' is "
                  << bool2value_type(a->get_is_multi_values()) << "\n"
                  << "  attribute in class \'" << get_name() << "\' is \'" << bool2value_type(a1->get_is_multi_values())
                  << "\'\n";
              }
            } else if (a2) {
              TLOG_DEBUG(1) << "in class \'" << get_name() << "\' attribute \'" << a2->get_name()
                            << "\' from superclass \'" << a2->p_class->get_name()
                            << "\' overrides one coming from superclass \'" << a->p_class->get_name() << '\'';
              if (are_types_different(a2, a)) {
                Oks::warning_msg("OksClass::create_attributes()")
                  << "  found attribute \'" << a->get_name() << "\' types conflict in class \'" << get_name() << "\':\n"
                  << "  type of attribute in superclass \'" << a->p_class->get_name() << "\' is \'" << a->get_type()
                  << "\'\n"
                  << "  type of attribute in superclass \'" << a2->p_class->get_name() << "\' is \'" << a2->get_type()
                  << "\'\n";
              }
 
              if (a2->get_is_multi_values() != a->get_is_multi_values()) {
                Oks::warning_msg("OksClass::create_attributes()")
                  << "  found attribute \'" << a->get_name() << "\' types conflict in class \'" << get_name() << "\':\n"
                  << "  attribute in superclass \'" << a->p_class->get_name() << "\' is "
                  << bool2value_type(a->get_is_multi_values()) << "\n"
                  << "  attribute in superclass \'" << get_name() << "\' is \'"
                  << bool2value_type(a2->get_is_multi_values()) << "\'\n";
              }
            }
          }
        }
      }
    }
  }
 
  if (p_attributes) {
    for (std::list<OksAttribute*>::iterator i = p_attributes->begin(); i != p_attributes->end(); ++i) {
      p_all_attributes->push_back(*i);
    }
  }
}

create_list_of_all_objects()

std::list< OksObject * > * dunedaq::oks::OksClass::create_list_of_all_objects ( ) const

noexcept

Get all objects of the class (including derived).

Return all objects of given and derived classes. The list to be deleted by user.

Returns

pointer to list of all objects, or 0 if there are no objects

Definition at line 1444 of file class.cpp.

{
  std::list<OksObject*>* olist = 0;
 
  // add instances of class
 
  if (p_objects && !p_objects->empty()) {
    olist = new std::list<OksObject*>();
 
    for (OksObject::Map::const_iterator i = p_objects->begin(); i != p_objects->end(); ++i)
      olist->push_back((*i).second);
  }
 
  // build iterator over subclasses
 
  if (p_all_sub_classes) {
    for (FList::const_iterator j = p_all_sub_classes->begin(); j != p_all_sub_classes->end(); ++j) {
      OksClass* sc = *j;
 
      // add instances of subclass
 
      if (sc->p_objects && !sc->p_objects->empty()) {
        if (!olist)
          olist = new std::list<OksObject*>();
 
        for (OksObject::Map::const_iterator i = sc->p_objects->begin(); i != sc->p_objects->end(); ++i)
          olist->push_back((*i).second);
      }
    }
  }
 
  return olist;
}

create_methods()

void dunedaq::oks::OksClass::create_methods ( )

private

Definition at line 1773 of file class.cpp.

{
  if (!p_all_methods)
    p_all_methods = new std::list<OksMethod*>();
  else
    p_all_methods->clear();
 
  if (p_all_super_classes) {
    for (FList::iterator i = p_all_super_classes->begin(); i != p_all_super_classes->end(); ++i) {
      std::list<OksMethod*>::iterator i2;
      if ((*i)->p_methods) {
        for (i2 = (*i)->p_methods->begin(); i2 != (*i)->p_methods->end(); ++i2) {
          if (find_direct_method((*i2)->get_name()) == 0 && find_method((*i2)->get_name()) == 0) {
            p_all_methods->push_back(*i2);
          }
        }
      }
    }
  }
 
  if (p_methods) {
    for (std::list<OksMethod*>::iterator i = p_methods->begin(); i != p_methods->end(); ++i) {
      p_all_methods->push_back(*i);
    }
  }
}

create_relationships()

void dunedaq::oks::OksClass::create_relationships ( )

private

Definition at line 1703 of file class.cpp.

{
  if (!p_all_relationships)
    p_all_relationships = new std::list<OksRelationship*>();
  else
    p_all_relationships->clear();
 
  if (p_all_super_classes) {
    for (FList::iterator i = p_all_super_classes->begin(); i != p_all_super_classes->end(); ++i) {
      OksClass* c(*i);
      if (c->p_relationships) {
        for (std::list<OksRelationship*>::iterator i2 = c->p_relationships->begin(); i2 != c->p_relationships->end();
             ++i2) {
          OksRelationship* r = *i2;
          OksRelationship* r1 = find_direct_relationship(r->get_name());
          OksRelationship* r2 = find_relationship(r->get_name());
 
          if (!r->p_class_type) {
            r->p_class_type = p_kernel->find_class(r->p_rclass);
          }
 
          if (r1 == 0 && r2 == 0) {
            p_all_relationships->push_back(r);
          } else {
            if (r1) {
              TLOG_DEBUG(1) << "in class \'" << get_name() << "\' direct relationship \'" << r1->get_name()
                            << "\' overrides one coming from superclass \'" << r->p_class->get_name() << '\'';
              if (r1->get_high_cardinality_constraint() != r->get_high_cardinality_constraint()) {
                Oks::warning_msg("OksClass::create_relationships()")
                  << "  found relationship \'" << r->get_name() << "\' cardinality conflict in class \'" << get_name()
                  << "\':\n"
                  << "  relationship in superclass \'" << r->p_class->get_name() << "\' allows "
                  << card2string(r->get_high_cardinality_constraint()) << "\n"
                  << "  relationship in class \'" << get_name() << "\' allows "
                  << card2string(r1->get_high_cardinality_constraint()) << std::endl;
              }
            } else if (r2) {
              TLOG_DEBUG(1) << "in class \'" << get_name() << "\' relationship \'" << r2->get_name()
                            << "\' from superclass \'" << r2->p_class->get_name()
                            << "\' overrides one coming from superclass \'" << r->p_class->get_name() << '\'';
              if (r2->get_high_cardinality_constraint() != r->get_high_cardinality_constraint()) {
                Oks::warning_msg("OksClass::create_relationships()")
                  << "  found relationship \'" << r->get_name() << "\' cardinality conflict in class \'" << get_name()
                  << "\':\n"
                  << "  relationship in superclass \'" << r->p_class->get_name() << "\' allows "
                  << card2string(r->get_high_cardinality_constraint()) << "\n"
                  << "  relationship in superclass \'" << r2->p_class->get_name() << "\' allows "
                  << card2string(r2->get_high_cardinality_constraint()) << std::endl;
              }
            }
          }
        }
      }
    }
  }
 
  if (p_relationships) {
    for (std::list<OksRelationship*>::iterator i = p_relationships->begin(); i != p_relationships->end(); ++i) {
      OksRelationship* r = *i;
 
      if (!r->p_class_type) {
        r->p_class_type = p_kernel->find_class(r->p_rclass);
      }
 
      p_all_relationships->push_back(r);
    }
  }
}

create_sub_classes()

void dunedaq::oks::OksClass::create_sub_classes ( )

private

Definition at line 1575 of file class.cpp.

{
  if (!p_all_sub_classes)
    p_all_sub_classes = new FList();
  else
    p_all_sub_classes->clear();
 
  if (!p_kernel->p_classes.empty()) {
    for (Map::iterator i = p_kernel->p_classes.begin(); i != p_kernel->p_classes.end(); ++i) {
      OksClass* c = i->second;
 
      if (const FList* scl = c->p_all_super_classes) {
        for (FList::const_iterator j = scl->begin(); j != scl->end(); ++j) {
          if (*j == this) {
            p_all_sub_classes->push_back(c);
            break;
          }
        }
      }
    }
  }
}

create_super_classes()

void dunedaq::oks::OksClass::create_super_classes ( )

private

Definition at line 1550 of file class.cpp.

{
  if (!p_all_super_classes)
    p_all_super_classes = new FList();
  else
    p_all_super_classes->clear();
 
  add_super_classes(p_all_super_classes);
 
#ifndef ERS_NO_DEBUG
  if (ers::debug_level() >= 5) {
    std::ostringstream text;
    text << "found " << p_all_super_classes->size() << " superclass(es) in class \'" << get_name() << "\':\n";
    if (p_all_super_classes->size()) {
      for (FList::iterator i = p_all_super_classes->begin(); i != p_all_super_classes->end(); ++i) {
        text << " - class \'" << (*i)->get_name() << "\'\n";
      }
    }
 
    TLOG_DEBUG(5) << text.str();
  }
#endif
}

data_info()

OksDataInfo * dunedaq::oks::OksClass::data_info ( const std::string & s ) const

inlinenoexcept

Get OKS data information for attribute or relationship.

Pass name of attribute or relationship defined for given class. If it is not defined, the application will crash (no extra checks by efficiency reasons).

Parameters

s	name of existing OKS attribute or relationship

Returns

OKS data information pointer

Definition at line 813 of file class.hpp.

{ return p_data_info->find(s)->second; }

destroy()

void dunedaq::oks::OksClass::destroy ( OksClass * c )

static

Destroy OKS class.

This the the only way available to user to destroy OKS class since ~OksClass() is private.

The parameter is:

Parameters

c	the pointer to class

Exceptions

oks::exception

is thrown in case of problems

Definition at line 172 of file class.cpp.

{
  // obtain write mutex, if non-transient class is registered in the oks kernel
 
  if (!c->p_transient && c->p_kernel) {
    std::unique_lock lock(c->p_kernel->p_kernel_mutex);
 
    try {
      c->p_file->lock();
      c->p_file->set_updated();
    } catch (oks::exception& ex) {
      throw oks::CannotDestroyClass(*c, ex);
    }
 
    delete c;
  }
 
  // destroy class without get write mutex
 
  else {
    delete c;
  }
}

destroy_list()

template<class T>

void dunedaq::oks::OksClass::destroy_list ( T list )

staticprivate

Definition at line 198 of file class.cpp.

{
  if (list) {
    for (const auto& x : *list)
      delete x;
 
    delete list;
  }
}

destroy_map()

template<class T>

void dunedaq::oks::OksClass::destroy_map ( T map )

staticprivate

Definition at line 210 of file class.cpp.

{
  if (map) {
    for (const auto& x : *map)
      delete x.second;
 
    delete map;
  }
}

direct_attributes()

const std::list< OksAttribute * > * dunedaq::oks::OksClass::direct_attributes ( ) const

inlinenoexcept

Get list of direct attributes

Definition at line 474 of file class.hpp.

{ return p_attributes; }

direct_methods()

const std::list< OksMethod * > * dunedaq::oks::OksClass::direct_methods ( ) const

inlinenoexcept

Get list of direct methods

Definition at line 671 of file class.hpp.

{ return p_methods; }

direct_relationships()

const std::list< OksRelationship * > * dunedaq::oks::OksClass::direct_relationships ( ) const

inlinenoexcept

Get list of direct relationships

Definition at line 572 of file class.hpp.

{ return p_relationships; }

direct_super_classes()

const std::list< std::string * > * dunedaq::oks::OksClass::direct_super_classes ( ) const

inlinenoexcept

Return list of direct base classes of given class.

Definition at line 417 of file class.hpp.

{ return p_super_classes; }

execute_query()

OksObject::List * dunedaq::oks::OksClass::execute_query

(

OksQuery *

query

)

const

Execute query.

Return list of objects satisfying given query. The list to be deleted by user.

Parameters

query

OKS query

Returns

pointer to list of all objects, or 0 if there are no objects

Exceptions

In	case of problems the oks::exception is thrown.

Definition at line 446 of file query.cpp.

{
  const char* fname = "OksClass::execute_query()";
 
  OSK_PROFILING(OksProfiler::Classexecute_query, p_kernel)
 
  OksObject::List* olist = 0;
  OksQueryExpression* sqe = qe->get();
 
  if (sqe->CheckSyntax() == false) {
    Oks::error_msg(fname) << "Can't execute query \"" << *sqe << "\"\n";
    return 0;
  }
 
  if (p_objects && !p_objects->empty()) {
    bool indexedSearch = false;
 
    if (p_indices) {
      if (sqe->type() == OksQuery::comparator_type) {
        OksComparator* cq = (OksComparator*)sqe;
        OksIndex::Map::iterator j = p_indices->find(cq->GetAttribute());
 
        if (j != p_indices->end()) {
          indexedSearch = true;
          olist = (*j).second->find_all(cq->GetValue(), cq->GetFunction());
        }
      } else if ((sqe->type() == OksQuery::and_type) || (sqe->type() == OksQuery::or_type)) {
        std::list<OksQueryExpression*>* qlist = &((OksListBaseQueryExpression*)sqe)->p_expressions;
        OksQueryExpression *q1, *q2;
        OksComparator *cq1 = 0, *cq2 = 0;
 
        if ((qlist->size() == 2) && ((q1 = qlist->front())->type() == OksQuery::comparator_type) &&
            ((q2 = qlist->back())->type() == OksQuery::comparator_type) && ((cq1 = (OksComparator*)q1) != 0) &&
            ((cq2 = (OksComparator*)q2) != 0) && (cq1->GetAttribute() == cq2->GetAttribute())) {
          OksIndex::Map::iterator j = p_indices->find(cq1->GetAttribute());
 
          if (j != p_indices->end()) {
            indexedSearch = true;
 
            olist = (*j).second->find_all(((sqe->type() == OksQuery::and_type) ? true : false),
                                          cq1->GetValue(),
                                          cq1->GetFunction(),
                                          cq2->GetValue(),
                                          cq2->GetFunction());
          }
        }
      }
    }
 
    if (indexedSearch == false) {
      for (OksObject::Map::iterator i = p_objects->begin(); i != p_objects->end(); ++i) {
        OksObject* o = (*i).second;
 
        try {
          if (o->SatisfiesQueryExpression(sqe) == true) {
            if (!olist)
              olist = new OksObject::List();
            olist->push_back(o);
          }
        } catch (oks::exception& ex) {
          throw oks::QueryFailed(*sqe, *this, ex);
        } catch (std::exception& ex) {
          throw oks::QueryFailed(*sqe, *this, ex.what());
        }
      }
    }
  }
 
  if (qe->search_in_subclasses() == true && p_all_sub_classes && !p_all_sub_classes->empty()) {
    for (OksClass::FList::iterator i = p_all_sub_classes->begin(); i != p_all_sub_classes->end(); ++i) {
      OksClass* c = *i;
 
      if (c->p_objects && !c->p_objects->empty()) {
        for (OksObject::Map::iterator i2 = c->p_objects->begin(); i2 != c->p_objects->end(); ++i2) {
          OksObject* o = (*i2).second;
 
          try {
            if (o->SatisfiesQueryExpression(sqe) == true) {
              if (!olist)
                olist = new OksObject::List();
              olist->push_back(o);
            }
          } catch (oks::exception& ex) {
            throw oks::QueryFailed(*sqe, *this, ex);
          } catch (std::exception& ex) {
            throw oks::QueryFailed(*sqe, *this, ex.what());
          }
        }
      }
    }
  }
 
  return olist;
}

find_attribute()

OksAttribute * dunedaq::oks::OksClass::find_attribute ( const std::string & name ) const

noexcept

Find attribute (search in this and base classes).

Get attribute by name.

Parameters

name	attribute name

Returns

found attribute or 0, if this and base classes have no attribute with such name

Definition at line 985 of file class.cpp.

{
  if (p_all_attributes) {
    for (std::list<OksAttribute*>::const_iterator i = p_all_attributes->begin(); i != p_all_attributes->end(); ++i)
      if (_name == (*i)->get_name())
        return *i;
 
    return 0;
  } else
    return find_direct_attribute(_name);
}

find_direct_attribute()

OksAttribute * dunedaq::oks::OksClass::find_direct_attribute ( const std::string & name ) const

noexcept

Find direct attribute.

Get attribute by name.

Parameters

name	attribute name

Returns

found attribute or 0, if this class has no attribute with such name

Definition at line 973 of file class.cpp.

{
  if (p_attributes) {
    for (std::list<OksAttribute*>::const_iterator i = p_attributes->begin(); i != p_attributes->end(); ++i)
      if (_name == (*i)->get_name())
        return *i;
  }
 
  return 0;
}

find_direct_method()

OksMethod * dunedaq::oks::OksClass::find_direct_method ( const std::string & name ) const

noexcept

Find direct method.

Get method by name.

Parameters

name	method name

Returns

found method or 0, if this class has no method with such name

Definition at line 1290 of file class.cpp.

{
  if (p_methods) {
    for (std::list<OksMethod*>::const_iterator i = p_methods->begin(); i != p_methods->end(); ++i)
      if (_name == (*i)->get_name())
        return *i;
  }
 
  return 0;
}

find_direct_relationship()

OksRelationship * dunedaq::oks::OksClass::find_direct_relationship ( const std::string & name ) const

noexcept

Find direct relationship.

Get relationship by name.

Parameters

name	relationship name

Returns

found relationship or 0, if this class has no relationship with such name

Definition at line 1130 of file class.cpp.

{
  if (p_relationships) {
    for (std::list<OksRelationship*>::const_iterator i = p_relationships->begin(); i != p_relationships->end(); ++i)
      if (_name == (*i)->get_name())
        return *i;
  }
 
  return 0;
}

find_method()

OksMethod * dunedaq::oks::OksClass::find_method ( const std::string & name ) const

noexcept

Find method (search in this and base classes).

Get method by name.

Parameters

name	method name

Returns

found method or 0, if this and base classes have no method with such name

Definition at line 1302 of file class.cpp.

{
  if (p_all_methods) {
    for (std::list<OksMethod*>::const_iterator i = p_all_methods->begin(); i != p_all_methods->end(); ++i)
      if (_name == (*i)->get_name())
        return *i;
 
    return 0;
  } else
    return find_direct_method(_name);
}

find_relationship()

OksRelationship * dunedaq::oks::OksClass::find_relationship ( const std::string & name ) const

noexcept

Find relationship (search in this and base classes).

Get relationship by name.

Parameters

name	relationship name

Returns

found relationship or 0, if this and base classes have no relationship with such name

Definition at line 1142 of file class.cpp.

{
  if (p_all_relationships) {
    for (std::list<OksRelationship*>::const_iterator i = p_all_relationships->begin(); i != p_all_relationships->end();
         ++i)
      if (_name == (*i)->get_name())
        return *i;
 
    return 0;
  } else
    return find_direct_relationship(_name);
}

find_super_class()

OksClass * dunedaq::oks::OksClass::find_super_class ( const std::string & nm ) const

noexcept

Search class by name among all base classes of given class.

Definition at line 708 of file class.cpp.

{
  if (p_all_super_classes && !p_all_super_classes->empty()) {
    for (FList::const_iterator i = p_all_super_classes->begin(); i != p_all_super_classes->end(); ++i) {
      if ((*i)->get_name() == nm)
        return *i;
    }
  }
 
  return 0;
}

get_data_info()

OksDataInfo * dunedaq::oks::OksClass::get_data_info ( const std::string & s ) const

inlinenoexcept

Get OKS data information for attribute or relationship.

Pass name of attribute or relationship defined for given class. Safe version of data_info()

Parameters

s	name of existing OKS attribute or relationship

Returns

OKS data information pointer or nullptr if no such attribute or relationship

Definition at line 825 of file class.hpp.

  {
    auto it = p_data_info->find(s);
    return (it != p_data_info->end() ? it->second : nullptr);
  }

get_description()

const std::string & dunedaq::oks::OksClass::get_description ( ) const

inlinenoexcept

Return description of class.

Definition at line 378 of file class.hpp.

{ return p_description; }

get_file()

OksFile * dunedaq::oks::OksClass::get_file ( ) const

inlinenoexcept

Get file of object.

Definition at line 352 of file class.hpp.

{ return p_file; }

get_is_abstract()

bool dunedaq::oks::OksClass::get_is_abstract ( ) const

inlinenoexcept

Return true if class is abstract (i.e. has no objects).

Definition at line 392 of file class.hpp.

{ return p_abstract; }

get_kernel()

OksKernel * dunedaq::oks::OksClass::get_kernel ( ) const

inlinenoexcept

Get OKS kernel which registering given class.

Definition at line 348 of file class.hpp.

{ return p_kernel; }

get_name()

const std::string & dunedaq::oks::OksClass::get_name ( ) const

inlinenoexcept

Return name of class.

Definition at line 374 of file class.hpp.

{ return p_name; }

get_object() [1/2]

OksObject * dunedaq::oks::OksClass::get_object ( const std::string & id ) const

noexcept

Get object by ID.

Return pointer to object of given class by identity.

Returns

pointer to object, or 0 if there is no such object

Definition at line 1479 of file class.cpp.

{
  std::shared_lock lock(p_mutex); // protect p_objects
 
  if (p_objects) {
    OksObject::Map::const_iterator i = p_objects->find(&id);
    if (i != p_objects->end())
      return i->second;
  }
 
  return nullptr;
}

get_object() [2/2]

OksObject * dunedaq::oks::OksClass::get_object ( const std::string * id ) const

inlinenoexcept

See get_object(const std::string&)

Definition at line 787 of file class.hpp.

{ return get_object(*id); }

has_direct_super_class()

bool dunedaq::oks::OksClass::has_direct_super_class ( const std::string & nm ) const

noexcept

Return true, if class has direct base class with given name.

Definition at line 721 of file class.cpp.

{
  if (p_super_classes) {
    for (std::list<std::string*>::const_iterator i = p_super_classes->begin(); i != p_super_classes->end(); ++i)
      if (nm == *(*i))
        return true;
  }
 
  return false;
}

k_add() [1/2]

void dunedaq::oks::OksClass::k_add

(

OksAttribute *

a

)

Kernel method to add attribute.

Parameters

a	new attribute

Definition at line 998 of file class.cpp.

{
  if (!p_attributes) {
    p_attributes = new std::list<OksAttribute*>();
  }
 
  p_attributes->push_back(attribute);
  attribute->p_class = this;
}

k_add() [2/2]

void dunedaq::oks::OksClass::k_add

(

OksRelationship *

r

)

Kernel method to add relationship.

Parameters

r	new relationship

Definition at line 1156 of file class.cpp.

{
  if (!p_relationships) {
    p_relationships = new std::list<OksRelationship*>();
  }
 
  p_relationships->push_back(relationship);
  relationship->p_class = this;
}

k_add_super_class()

void dunedaq::oks::OksClass::k_add_super_class

(

const std::string &

name

)

Kernel method to add direct base class with given name.

Definition at line 830 of file class.cpp.

{
  if (!p_super_classes) {
    p_super_classes = new std::list<std::string*>();
  }
 
  p_super_classes->push_back((new std::string(nm)));
}

lock_file()

void dunedaq::oks::OksClass::lock_file ( const char * fname )

private

Definition at line 733 of file class.cpp.

{
  if (p_kernel) {
    try {
      p_file->lock();
    } catch (oks::exception& ex) {
      throw oks::SetOperationFailed(fname, ex);
    }
  }
}

number_of_all_attributes()

size_t dunedaq::oks::OksClass::number_of_all_attributes ( ) const

inlinenoexcept

Get number of all attributes (including attributes from this and base classes)

Definition at line 976 of file class.hpp.

{
  return (p_all_attributes ? p_all_attributes->size() : 0);
}

number_of_all_methods()

size_t dunedaq::oks::OksClass::number_of_all_methods ( ) const

inlinenoexcept

Get number of all methods (including methods from this and base classes)

Definition at line 1000 of file class.hpp.

{
  return (p_all_methods ? p_all_methods->size() : 0);
}

number_of_all_relationships()

size_t dunedaq::oks::OksClass::number_of_all_relationships ( ) const

inlinenoexcept

Get number of all relationships (including relationships from this and base classes)

Definition at line 988 of file class.hpp.

{
  return (p_all_relationships ? p_all_relationships->size() : 0);
}

number_of_direct_attributes()

size_t dunedaq::oks::OksClass::number_of_direct_attributes ( ) const

inlinenoexcept

Get number of direct attributes

Definition at line 970 of file class.hpp.

{
  return (p_attributes ? p_attributes->size() : 0);
}

number_of_direct_methods()

size_t dunedaq::oks::OksClass::number_of_direct_methods ( ) const

inlinenoexcept

Get number of direct methods

Definition at line 994 of file class.hpp.

{
  return (p_methods ? p_methods->size() : 0);
}

number_of_direct_relationships()

size_t dunedaq::oks::OksClass::number_of_direct_relationships ( ) const

inlinenoexcept

Get number of direct relationships

Definition at line 982 of file class.hpp.

{
  return (p_relationships ? p_relationships->size() : 0);
}

number_of_objects()

size_t dunedaq::oks::OksClass::number_of_objects ( ) const

noexcept

Get number of objects of given class

Definition at line 1433 of file class.cpp.

{
  return (!p_objects ? 0 : p_objects->size());
}

objects()

const OksObject::Map * dunedaq::oks::OksClass::objects ( ) const

inlinenoexcept

Get objects of given class (the pointer can be 0)

Definition at line 762 of file class.hpp.

{ return p_objects; }

operator!=()

bool dunedaq::oks::OksClass::operator!=

(

const OksClass &

c

)

const

The not equal operator.

The operator returns false, if two classes have equal attributes, relationships and methods.

Definition at line 354 of file class.cpp.

{
  if (this == &c)
    return false;
 
  if (compare_without_methods(c) == false)
    return true;
 
  int l1 = (p_methods == 0) ? 0 : p_methods->size();
  int l2 = (c.p_methods == 0) ? 0 : c.p_methods->size();
 
  if (l1 != l2)
    return true;
 
  if (l1 > 0) {
    std::list<OksMethod*>::const_iterator i1 = p_methods->begin();
    std::list<OksMethod*>::const_iterator i2 = c.p_methods->begin();
 
    for (; i1 != p_methods->end(); ++i1, ++i2)
      if (!(*(*i1) == *(*i2)))
        return true;
  }
 
  return false;
}

operator==()

bool dunedaq::oks::OksClass::operator== ( const OksClass & c ) const

inline

The equality operator.

The operator returns true, if two classes have equal names.

Definition at line 964 of file class.hpp.

{
  return ((this == &c || p_name == c.p_name) ? true : false);
}

registrate_attribute_change()

void dunedaq::oks::OksClass::registrate_attribute_change ( OksAttribute * a )

private

Definition at line 1804 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassRegistrateAttributeChange, p_kernel)
 
  FList::iterator i;
  if (p_all_sub_classes)
    i = p_all_sub_classes->begin();
 
  OksClass* c(this);
 
  do {
    if (c->p_objects && !c->p_objects->empty()) {
      for (OksObject::Map::const_iterator i2 = c->p_objects->begin(); i2 != c->p_objects->end(); ++i2) {
        OksObject* o(i2->second);
        OksData newData;
        OksData* oldData = &o->data[((*(c->p_data_info))[a->p_name])->offset];
 
        try {
          oldData->cvt(&newData, a);
          oldData->Clear();
          memcpy(static_cast<void*>(oldData), static_cast<void*>(&newData), sizeof(OksData));
          newData.Clear2(); // Do not free !
        } catch (oks::AttributeReadError& ex) {
          std::ostringstream text;
          text << "attribute \'" << a->get_name() << "\' change converting object " << o << ' ';
          throw oks::CannotRegisterClass(*this, text.str(), ex);
        }
      }
    }
  } while (p_all_sub_classes && i != p_all_sub_classes->end() && (c = *(i++)));
}

registrate_class()

void dunedaq::oks::OksClass::registrate_class ( bool skip_registered )

private

Definition at line 1979 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassRegistrateClass, p_kernel)
 
  {
    if (!p_data_info)
      p_data_info = new OksDataInfo::Map();
    if (!p_objects) {
      p_objects = new OksObject::Map((p_abstract == false) ? 1024 : 1);
    }
  }
 
  if (!p_data_info->empty() && skip_registered) {
    TLOG_DEBUG(4) << "skip already registered " << get_name();
    return;
  }
 
  try {
    create_super_classes();
    create_attributes();
    create_relationships();
    create_methods();
 
    registrate_instances();
  } catch (oks::exception& ex) {
    throw oks::CannotRegisterClass(*this, "", ex);
  }
}

registrate_class_change()

void dunedaq::oks::OksClass::registrate_class_change ( ChangeType changeType, const void * parameter, bool update_file = true )

private

Definition at line 2009 of file class.cpp.

{
  if (!p_kernel)
    return;
 
  OSK_PROFILING(OksProfiler::ClassRegistrateClassChange, p_kernel)
 
  try {
    if (update_file)
      p_file->set_updated();
 
    FList superclasses;
 
    if (changeType == ChangeSuperClassesList && !p_all_super_classes->empty())
      for (FList::iterator i2 = p_all_super_classes->begin(); i2 != p_all_super_classes->end(); ++i2) {
        superclasses.push_back(*i2);
      }
 
    FList::iterator i;
    if (p_all_sub_classes)
      i = p_all_sub_classes->begin();
 
    OksClass* c = this;
 
    do {
      switch (changeType) {
        case ChangeSuperClassesList:
          c->create_super_classes();
          c->create_attributes();
          c->create_relationships();
          c->create_methods();
          break;
 
        case ChangeAttributesList:
          c->create_attributes();
          break;
 
        case ChangeRelationshipsList:
          c->create_relationships();
          break;
 
        case ChangeMethodsList:
          c->create_methods();
          break;
 
        default:
          continue;
      }
 
      if (changeType != ChangeMethodsList)
        c->registrate_instances();
    } while (p_all_sub_classes && i != p_all_sub_classes->end() && (c = *(i++)));
 
    if (changeType == ChangeSuperClassesList) {
      if (!p_all_super_classes->empty())
        for (FList::iterator i2 = p_all_super_classes->begin(); i2 != p_all_super_classes->end(); ++i2)
          if (find(superclasses.begin(), superclasses.end(), *i2) == superclasses.end()) {
            superclasses.push_back(*i2);
          }
 
      for (FList::const_iterator i2 = superclasses.begin(); i2 != superclasses.end(); ++i2) {
        c = *i2;
 
        if (p_kernel->is_dangling(c) || c->p_to_be_deleted)
          continue;
 
        c->create_sub_classes();
 
        if (OksClass::change_notify_fn)
          (*OksClass::change_notify_fn)(c, ChangeSubClassesList, 0);
      }
      superclasses.clear();
    }
 
    if (OksClass::change_notify_fn) {
      if (p_all_sub_classes)
        i = p_all_sub_classes->begin();
      c = this;
 
      do
        (*OksClass::change_notify_fn)(c, changeType, parameter);
      while (p_all_sub_classes && i != p_all_sub_classes->end() && (c = *(i++)));
    }
  } catch (oks::exception& ex) {
    throw oks::CannotRegisterClass(*this, "change ", ex);
  }
}

registrate_instances()

void dunedaq::oks::OksClass::registrate_instances ( )

private

Definition at line 1867 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassRegistrateInstances, p_kernel)
 
  OksDataInfo::Map* dInfo = new OksDataInfo::Map();
 
  size_t dInfoLength = 0;
  bool thereAreChanges = false;
 
  if (!p_all_attributes->empty()) {
    for (std::list<OksAttribute*>::iterator i = p_all_attributes->begin(); i != p_all_attributes->end(); ++i) {
      OksAttribute* a = *i;
      if (!thereAreChanges) {
        OksDataInfo::Map::const_iterator x = p_data_info->find(a->get_name());
        if (x == p_data_info->end() || x->second->attribute == nullptr || x->second->offset != dInfoLength ||
            !(*(x->second->attribute) == *a)) {
          thereAreChanges = true;
        }
      }
 
      (*dInfo)[a->get_name()] = new OksDataInfo(dInfoLength++, a);
    }
  }
 
  if (!p_all_relationships->empty()) {
    for (std::list<OksRelationship*>::iterator i = p_all_relationships->begin(); i != p_all_relationships->end(); ++i) {
      OksRelationship* r = *i;
      if (!thereAreChanges) {
        OksDataInfo::Map::const_iterator x = p_data_info->find(r->get_name());
        if (x == p_data_info->end() || x->second->relationship == nullptr || x->second->offset != dInfoLength ||
            !(*(x->second->relationship) == *r)) {
          thereAreChanges = true;
        }
      }
 
      (*dInfo)[r->get_name()] = new OksDataInfo(dInfoLength++, r);
    }
  }
 
  if (thereAreChanges == true) {
    if (p_objects && !p_objects->empty()) {
      for (OksObject::Map::const_iterator i = p_objects->begin(); i != p_objects->end(); ++i) {
        OksObject* o = (*i).second;
        OksData* data = new OksData[dInfoLength];
        size_t count = 0;
 
        if (!p_all_attributes->empty()) {
          for (std::list<OksAttribute*>::iterator i2 = p_all_attributes->begin(); i2 != p_all_attributes->end(); ++i2) {
            OksAttribute* a = *i2;
 
            OksDataInfo::Map::const_iterator x = p_data_info->find(a->get_name());
 
            if (x != p_data_info->end() && x->second->attribute) {
              OksData* oldData(&o->data[x->second->offset]);
 
              if (*(x->second->attribute) == *a) {
                memcpy(static_cast<void*>(&data[count++]), static_cast<void*>(oldData), sizeof(OksData));
                oldData->type = OksData::unknown_type;
              } else {
                try {
                  oldData->cvt(&data[count++], a);
                } catch (oks::AttributeReadError& ex) {
                  throw oks::AttributeConversionFailed(*a, o, ex);
                }
              }
            }
          }
        }
 
        if (!p_all_relationships->empty()) {
          for (std::list<OksRelationship*>::iterator i2 = p_all_relationships->begin();
               i2 != p_all_relationships->end();
               ++i2) {
            OksRelationship* r = *i2;
 
            OksDataInfo::Map::const_iterator x = p_data_info->find(r->get_name());
 
            if (x != p_data_info->end() && x->second->relationship) {
              OksData* oldData = &o->data[x->second->offset];
 
              if (*(x->second->relationship) == *r) {
                memcpy(static_cast<void*>(&data[count++]), static_cast<void*>(oldData), sizeof(OksData));
                oldData->type = OksData::unknown_type;
              } else
                oldData->ConvertTo(&data[count++], r);
            }
          }
        }
 
        int n = p_instance_size;
        while (n--)
          o->data[n].Clear();
        delete o->data;
 
        o->data = data;
      }
    }
  }
 
  if (!p_data_info->empty()) {
    for (OksDataInfo::Map::iterator i = p_data_info->begin(); i != p_data_info->end(); ++i) {
      delete i->second;
    }
  }
 
  delete p_data_info;
 
  p_data_info = dInfo;
  p_instance_size = dInfoLength;
}

registrate_relationship_change()

void dunedaq::oks::OksClass::registrate_relationship_change ( OksRelationship * r )

private

Definition at line 1840 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassRegistrateRelationshipChange, p_kernel)
 
  FList::iterator i;
  if (p_all_sub_classes)
    i = p_all_sub_classes->begin();
 
  OksClass* c(this);
 
  do {
    if (c->p_objects && !c->p_objects->empty()) {
      for (OksObject::Map::const_iterator i2 = c->p_objects->begin(); i2 != c->p_objects->end(); ++i2) {
        OksObject* o(i2->second);
        OksData newData;
        OksData* oldData = &o->data[((*(c->p_data_info))[r->p_name])->offset];
 
        oldData->ConvertTo(&newData, r);
        oldData->Clear();
        memcpy(static_cast<void*>(oldData), static_cast<void*>(&newData), sizeof(OksData));
        newData.Clear2(); // Do not free !
      }
    }
  } while (p_all_sub_classes && i != p_all_sub_classes->end() && (c = *(i++)));
}

remove() [1/4]

void dunedaq::oks::OksClass::remove

(

const OksAttribute *

a

)

Remove attribute.

Remove attribute from class. The attribute mush be direct attribute of the class.

Parameters

a	attribute to be removed

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1082 of file class.cpp.

{
  const char* fname = "OksClass::remove(OksAttribute *)";
 
  if (!p_attributes) {
    std::ostringstream text;
    text << "cannot remove attribute \"" << attribute->get_name() << "\" from class \"" << p_name
         << "\"\n"
            "because the class has no attributes.\n";
    throw oks::SetOperationFailed(fname, text.str());
  }
 
  for (std::list<OksAttribute*>::iterator i = p_attributes->begin(); i != p_attributes->end(); ++i) {
    if (attribute == *i) {
      lock_file("OksClass::remove[OksAttribute]");
 
      p_attributes->erase(i);
      delete const_cast<OksAttribute*>(attribute);
 
      if (p_attributes->empty()) {
        delete p_attributes;
        p_attributes = 0;
      }
 
      registrate_class_change(ChangeAttributesList, 0);
 
      return;
    }
  }
 
  std::ostringstream text;
  text << "cannot remove attribute \"" << attribute->get_name() << "\" from class \"" << p_name
       << "\"\n"
          "because the class has no such attribute with this name.\n";
  throw oks::SetOperationFailed(fname, text.str());
}

remove() [2/4]

void dunedaq::oks::OksClass::remove

(

const OksMethod *

m

)

Remove method.

Remove method from class. The method mush be direct method of the class.

Parameters

m	method to be removed

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1342 of file class.cpp.

{
  const char* fname = "OksClass::remove(OksMethod *)";
 
  if (!p_methods) {
    std::ostringstream text;
    text << "cannot remove method \"" << method->get_name() << "\" from class \"" << p_name
         << "\"\n"
            "because the class has no methods.\n";
    throw oks::SetOperationFailed(fname, text.str());
  }
 
  for (std::list<OksMethod*>::iterator i = p_methods->begin(); i != p_methods->end(); ++i) {
    if (method == *i) {
      lock_file("OksClass::remove[OksMethod]");
 
      p_methods->erase(i);
      delete const_cast<OksMethod*>(method);
 
      if (p_methods->empty()) {
        delete p_methods;
        p_methods = 0;
      }
 
      registrate_class_change(ChangeMethodsList, 0);
 
      return;
    }
  }
 
  std::ostringstream text;
  text << "cannot remove method \"" << method->get_name() << "\" from class \"" << p_name
       << "\"\n"
          "because the class has no such method with this name.\n";
  throw oks::SetOperationFailed(fname, text.str());
}

remove() [3/4]

void dunedaq::oks::OksClass::remove	(	const OksRelationship *	r,
		bool	call_delete = true )

Remove relationship.

Remove relationship from class. The relationship must be direct method of the class.

Parameters

r	relationship to be removed
call_delete	if true, delete removed relationship

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1192 of file class.cpp.

{
  const char* fname = "OksClass::remove(OksRelationship *)";
 
  if (!p_relationships) {
    std::ostringstream text;
    text << "cannot remove relationship \"" << relationship->get_name() << "\" from class \"" << p_name
         << "\"\n"
            "because the class has no relationships.\n";
    throw oks::SetOperationFailed(fname, text.str());
  }
 
  for (std::list<OksRelationship*>::iterator i = p_relationships->begin(); i != p_relationships->end(); ++i) {
    if (relationship == *i) {
      lock_file("OksClass::remove[OksRelationship]");
 
      p_relationships->erase(i);
      if (call_delete) {
        delete const_cast<OksRelationship*>(relationship);
      }
 
      if (p_relationships->empty()) {
        delete p_relationships;
        p_relationships = 0;
      }
 
      registrate_class_change(ChangeRelationshipsList, 0);
 
      return;
    }
  }
 
  std::ostringstream text;
  text << "cannot remove relationship \"" << relationship->get_name() << "\" from class \"" << p_name
       << "\"\n"
          "because the class has no such relationship with this name.\n";
  throw oks::SetOperationFailed(fname, text.str());
}

remove() [4/4]

void dunedaq::oks::OksClass::remove ( OksObject * object )

private

Definition at line 1507 of file class.cpp.

{
  std::unique_lock lock(p_mutex); // protect p_objects
 
  if (!p_objects) {
    throw oks::ObjectOperationFailed(*this, object->uid.object_id, "remove", "OKS Kernel is not inited");
  }
 
  OksObject::Map::iterator i = p_objects->find(&object->uid.object_id);
 
  if (i != p_objects->end())
    p_objects->erase(i);
  else {
    throw oks::ObjectOperationFailed(*this, object->uid.object_id, "remove", "object does not exist");
  }
}

remove_super_class()

void dunedaq::oks::OksClass::remove_super_class

(

const std::string &

name

)

Remove direct base class with given name.

Parameters

name	name of superclass

Exceptions

oks::exception

is thrown in case of problems

Definition at line 887 of file class.cpp.

{
  if (!p_super_classes) {
    std::string text(remove_super_class_error(nm, p_name));
    text += " because class \"" + p_name + "\" has no superclasses at all.";
    throw oks::SetOperationFailed("OksClass::remove_super_class", text);
  }
 
  for (std::list<std::string*>::iterator i = p_super_classes->begin(); i != p_super_classes->end(); ++i) {
    std::string* si(*i);
    if (nm == *si) {
      lock_file("OksClass::remove_super_class");
 
      p_super_classes->erase(i);
      delete si;
 
      if (p_super_classes->empty()) {
        delete p_super_classes;
        p_super_classes = 0;
      }
 
      registrate_class_change(ChangeSuperClassesList, (const void*)&nm);
 
      return;
    }
  }
 
  std::string text(remove_super_class_error(nm, p_name));
  text += " because class \"" + p_name + "\" has no superclass with this name.";
  throw oks::SetOperationFailed("OksClass::remove_super_class", text);
}

save()

void dunedaq::oks::OksClass::save ( OksXmlOutputStream & s ) const

private

Definition at line 445 of file class.cpp.

{
  try {
    s.put_raw(' ');
    s.put_start_tag(class_xml_tag, sizeof(class_xml_tag) - 1);
    s.put_attribute(name_xml_attr, sizeof(name_xml_attr) - 1, p_name.c_str());
 
    // store non-empty description only
    if (!p_description.empty())
      s.put_attribute(description_xml_attr, sizeof(description_xml_attr) - 1, p_description.c_str());
 
    // store abstract attribute only when the class is abstract
    if (p_abstract)
      s.put_attribute(is_abstract_xml_attr, sizeof(is_abstract_xml_attr) - 1, oks::xml::bool2str(p_abstract));
 
    s.put_raw('>');
    s.put_raw('\n');
 
    if (p_super_classes)
      for (const auto& i : *p_super_classes) {
        s.put_raw(' ');
        s.put_raw(' ');
        s.put_start_tag(superclass_xml_attr, sizeof(superclass_xml_attr) - 1);
        s.put_attribute(name_xml_attr, sizeof(name_xml_attr) - 1, i->c_str());
        s.put_end_tag();
      }
 
    if (p_attributes)
      for (const auto& i : *p_attributes)
        i->save(s);
 
    if (p_relationships)
      for (const auto& i : *p_relationships)
        i->save(s);
 
    if (p_methods)
      for (const auto& i : *p_methods)
        i->save(s);
 
    s.put_raw(' ');
    s.put_last_tag(class_xml_tag, sizeof(class_xml_tag) - 1);
    s.put_raw('\n');
  }
 
  catch (oks::exception& e) {
    throw oks::FailedSave("oks-class", p_name, e);
  }
 
  catch (std::exception& e) {
    throw oks::FailedSave("oks-class", p_name, e.what());
  }
}

set_description()

void dunedaq::oks::OksClass::set_description

(

const std::string &

description

)

Set class description.

Parameters

description

new description of attribute (max 2000 bytes, see #s_max_description_length variable)

Exceptions

oks::exception

is thrown in case of problems

Definition at line 745 of file class.cpp.

{
  if (p_description != s) {
    lock_file("OksClass::set_description");
 
    p_description = s;
 
    if (p_kernel) {
      p_file->set_updated();
      if (OksClass::change_notify_fn) {
        (*OksClass::change_notify_fn)(this, ChangeDescription, 0);
      }
    }
  }
}

set_file()

void dunedaq::oks::OksClass::set_file	(	OksFile *	f,
		bool	update_owner = true )

Move class to different file.

Move class to an existing file. Both, present file where object is stored and new destination file have to be writable by user.

The parameters are:

Parameters

file	destination file
update_owner	mark original file as updated

Exceptions

oks::exception

is thrown in case of problems

Definition at line 277 of file class.cpp.

{
  if (p_file != f) {
    try {
      if (update_owner) {
        p_file->lock();
        p_file->set_updated();
      }
 
      f->lock();
      f->set_updated();
 
      p_file = f;
    } catch (oks::exception& ex) {
      throw oks::CanNotSetFile(this, 0, *f, ex);
    }
  }
}

set_is_abstract()

void dunedaq::oks::OksClass::set_is_abstract

(

bool

abstract

)

Set class abstract property.

If the class is abstract, it may not have objects. However the derived classes may have, if they are not abstract themselves.

Parameters

abstract

pass true to make class abstract

Exceptions

oks::exception

is thrown in case of problems

Definition at line 762 of file class.cpp.

{
  if (p_abstract != b) {
    lock_file("OksClass::set_is_abstract");
 
    p_abstract = b;
 
    if (p_kernel) {
      p_file->set_updated();
      if (OksClass::change_notify_fn) {
        (*OksClass::change_notify_fn)(this, ChangeIsAbstaract, 0);
      }
    }
  }
}

source_class() [1/3]

OksClass * dunedaq::oks::OksClass::source_class ( const OksAttribute * a ) const

noexcept

Get class owning given attribute.

Return class where attribute is defined.

Parameters

a	the attribute

Returns

pointer to class where attribute is defined or 0, if the attribute does not belong to a class

Definition at line 1120 of file class.cpp.

{
  return a->p_class;
}

source_class() [2/3]

OksClass * dunedaq::oks::OksClass::source_class ( const OksMethod * m ) const

noexcept

Get class owning given method.

Return class where method is defined.

Parameters

m	the method

Returns

pointer to class where method is defined or 0, if the method does not belong to a class

Definition at line 1423 of file class.cpp.

{
  return m->p_class;
}

source_class() [3/3]

OksClass * dunedaq::oks::OksClass::source_class ( const OksRelationship * r ) const

noexcept

Get class owning given relationship.

Return class where relationship is defined.

Parameters

r	the relationship

Returns

pointer to class where relationship is defined or 0, if the relationship does not belong to a class

Definition at line 1280 of file class.cpp.

{
  return r->p_class;
}

swap() [1/3]

void dunedaq::oks::OksClass::swap	(	const OksAttribute *	a1,
		const OksAttribute *	a2 )

Swap order of two attributes.

Swap position of two attributes. The attributes must be direct attributes of given class.

Parameters

a1	first attribute
a2	second attribute

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1034 of file class.cpp.

{
  const char* fname = "OksClass::swap(const OksAttribute *, const OksAttribute *)";
 
  // if attributes are equal, return success
 
  if (a1 == a2)
    return;
 
  // check that an attributes is not (null)
 
  check_and_report_empty_parameter(fname, (a1 == 0), (a2 == 0));
 
  // find requested attributes in the directed attributes list
 
  std::list<OksAttribute*>::iterator i1 = p_attributes->end();
  std::list<OksAttribute*>::iterator i2 = p_attributes->end();
 
  for (std::list<OksAttribute*>::iterator i = p_attributes->begin(); i != p_attributes->end(); ++i) {
    if ((*i) == a1)
      i1 = i;
    else if ((*i) == a2)
      i2 = i;
  }
 
  // check that the attributes were found
 
  check_and_report_found_items(fname,
                               "attribute",
                               a1->get_name(),
                               a2->get_name(),
                               p_name,
                               (i1 == p_attributes->end()),
                               (i2 == p_attributes->end()));
 
  // check that the file can be locked
 
  lock_file("OksClass::swap[OksAttribute]");
 
  // replace the attributes and make notification
 
  *i1 = const_cast<OksAttribute*>(a2);
  *i2 = const_cast<OksAttribute*>(a1);
 
  registrate_class_change(ChangeAttributesList, 0);
}

swap() [2/3]

void dunedaq::oks::OksClass::swap	(	const OksMethod *	m1,
		const OksMethod *	m2 )

Swap order of two methods.

Swap position of two methods. The methods must be direct methods of given class.

Parameters

m1	first method
m2	second method

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1380 of file class.cpp.

{
  const char* fname = "OksClass::swap(const OksMethod *, const OksMethod *)";
 
  // if methods are equal, return success
 
  if (m1 == m2)
    return;
 
  // check that an methods is not (null)
 
  check_and_report_empty_parameter(fname, (m1 == 0), (m2 == 0));
 
  // find requested methods in the directed methods list
 
  std::list<OksMethod*>::iterator i1 = p_methods->end();
  std::list<OksMethod*>::iterator i2 = p_methods->end();
 
  for (std::list<OksMethod*>::iterator i = p_methods->begin(); i != p_methods->end(); ++i) {
    if ((*i) == m1)
      i1 = i;
    else if ((*i) == m2)
      i2 = i;
  }
 
  // check that the methods were found
 
  check_and_report_found_items(
    fname, "method", m1->get_name(), m2->get_name(), p_name, (i1 == p_methods->end()), (i2 == p_methods->end()));
 
  // check that the file can be locked
 
  lock_file("OksClass::swap[OksMethod]");
 
  // replace the methods and make notification
 
  *i1 = const_cast<OksMethod*>(m2);
  *i2 = const_cast<OksMethod*>(m1);
 
  registrate_class_change(ChangeMethodsList, 0);
}

swap() [3/3]

void dunedaq::oks::OksClass::swap	(	const OksRelationship *	r1,
		const OksRelationship *	r2 )

Swap order of two relationships.

Swap position of two relationships. The relationships must be direct relationships of given class.

Parameters

r1	first relationship
r2	second relationship

Exceptions

oks::exception

is thrown in case of problems

Definition at line 1232 of file class.cpp.

{
  const char* fname = "OksClass::swap(const OksRelationship *, const OksRelationship *)";
 
  // if relationships are equal, return success
 
  if (r1 == r2)
    return;
 
  // check that an relationships is not (null)
 
  check_and_report_empty_parameter(fname, (r1 == 0), (r2 == 0));
 
  // find requested relationships in the directed relationships list
 
  std::list<OksRelationship*>::iterator i1 = p_relationships->end();
  std::list<OksRelationship*>::iterator i2 = p_relationships->end();
 
  for (std::list<OksRelationship*>::iterator i = p_relationships->begin(); i != p_relationships->end(); ++i) {
    if ((*i) == r1)
      i1 = i;
    else if ((*i) == r2)
      i2 = i;
  }
 
  // check that the relationships were found
 
  check_and_report_found_items(fname,
                               "relationship",
                               r1->get_name(),
                               r2->get_name(),
                               p_name,
                               (i1 == p_relationships->end()),
                               (i2 == p_relationships->end()));
 
  // check that the file can be locked
 
  lock_file("OksClass::swap[OksRelationship]");
 
  // replace the relationships and make notification
 
  *i1 = const_cast<OksRelationship*>(r2);
  *i2 = const_cast<OksRelationship*>(r1);
 
  registrate_class_change(ChangeRelationshipsList, 0);
}

swap_super_classes()

void dunedaq::oks::OksClass::swap_super_classes	(	const std::string &	c1,
		const std::string &	c2 )

Swap order of two superclasses.

Swap position of two superclasses. The superclasses must be direct superclasses of given class.

Parameters

c1	name of first superclass
c2	name of second superclass

Exceptions

oks::exception

is thrown in case of problems

Definition at line 920 of file class.cpp.

{
  const char* fname = "OksClass::swap_super_classes()";
 
  // if classs are equal, return success
 
  if (c1 == c2)
    return;
 
  // check that an class name is not empty
 
  check_and_report_empty_parameter(fname, c1.empty(), c2.empty());
 
  // find requested classes in the directed classs list
 
  std::list<std::string*>::iterator i1 = p_super_classes->end();
  std::list<std::string*>::iterator i2 = p_super_classes->end();
 
  for (std::list<std::string*>::iterator i = p_super_classes->begin(); i != p_super_classes->end(); ++i) {
    if (*(*i) == c1)
      i1 = i;
    else if (*(*i) == c2)
      i2 = i;
  }
 
  // check that the classes were found
 
  check_and_report_found_items("OksClass::swap_super_classes",
                               "superclass",
                               c1,
                               c2,
                               p_name,
                               (i1 == p_super_classes->end()),
                               (i2 == p_super_classes->end()));
 
  // replace the classs and make notification
 
  lock_file("OksClass::swap_super_classes");
 
  std::string* s1 = *i1;
  std::string* s2 = *i2;
 
  *i1 = s2;
  *i2 = s1;
 
  registrate_class_change(ChangeSuperClassesList, 0);
}

Friends And Related Symbol Documentation

OksAttribute

friend class OksAttribute

friend

Definition at line 226 of file class.hpp.

OksIndex

friend class OksIndex

friend

Definition at line 230 of file class.hpp.

OksKernel

friend class OksKernel

friend

Definition at line 225 of file class.hpp.

OksMethod

friend class OksMethod

friend

Definition at line 228 of file class.hpp.

OksMethodImplementation

friend class OksMethodImplementation

friend

Definition at line 229 of file class.hpp.

OksObject

friend class OksObject

friend

Definition at line 224 of file class.hpp.

OksRelationship

friend class OksRelationship

friend

Definition at line 227 of file class.hpp.

OksSortedClass

friend class OksSortedClass

friend

Definition at line 231 of file class.hpp.

operator<< [1/2]

std::ostream & operator<< ( std::ostream & s, const OksClass & c )

friend

Stream operator.

Send to stream complete description of OKS class:

• print class name
• print details of attributes, relationships and methods
• print details of objects

Definition at line 380 of file class.cpp.

{
  OSK_PROFILING(OksProfiler::ClassOperatorOut, c.p_kernel)
 
  s << "Class name: \"" << c.p_name
    << "\"\n"
       " has description: \""
    << c.p_description << "\"\n"
    << (c.p_abstract == true ? " is abstract\n" : " is not abstract\n");
 
  if (c.p_super_classes) {
    s << "The class has superclasses:\n";
    for (std::list<std::string*>::const_iterator i = c.p_super_classes->begin(); i != c.p_super_classes->end(); ++i) {
      s << " - " << *(*i) << std::endl;
    }
  } else
    s << "The class has no superclasses\n";
 
  if (c.p_attributes) {
    s << "The attributes are:\n";
    for (std::list<OksAttribute*>::const_iterator i = c.p_attributes->begin(); i != c.p_attributes->end(); ++i) {
      s << *(*i);
    }
  } else
    s << "There are no attributes\n";
 
  if (c.p_relationships) {
    s << "The relationships are:\n";
    for (std::list<OksRelationship*>::const_iterator i = c.p_relationships->begin(); i != c.p_relationships->end();
         ++i) {
      s << *(*i);
    }
  } else
    s << "There are no relationships\n";
 
  if (c.p_methods) {
    s << "The methods are:\n";
    for (std::list<OksMethod*>::const_iterator i = c.p_methods->begin(); i != c.p_methods->end(); ++i) {
      s << *(*i);
    }
  } else
    s << "There are no methods\n";
 
  if (c.p_objects) {
    OksObject::SMap sorted;
 
    s << "The objects are:\n";
 
    for (OksObject::Map::iterator i = c.p_objects->begin(); i != c.p_objects->end(); ++i) {
      sorted[i->first] = i->second;
    }
 
    for (OksObject::SMap::iterator i = sorted.begin(); i != sorted.end(); ++i) {
      s << *(i->second);
    }
  } else
    s << "There are no objects\n";
 
  s << "End of Class \"" << c.p_name << "\"\n";
 
  return s;
}

operator<< [2/2]

std::ostream & operator<< ( std::ostream & s, const OksObject & o )

friend

Definition at line 1624 of file object.cpp.

{
  OSK_PROFILING(OksProfiler::ObjectOperatorOut, o.uid.class_id->p_kernel)
 
  const OksClass* c = o.uid.class_id;
 
  s << "Object " << &o << std::endl;
 
  OksData* di = o.data;
 
  // print attributes
 
  {
    const std::list<OksAttribute*>* alist = c->all_attributes();
 
    if (alist && !alist->empty()) {
      s << " Attributes are:\n";
 
      for (std::list<OksAttribute*>::const_iterator i = alist->begin(); i != alist->end(); ++i) {
        if ((*i)->is_integer() && (*i)->get_format() != OksAttribute::Dec) {
          s.setf(((*i)->get_format() == OksAttribute::Hex ? std::ios::hex : std::ios::oct), std::ios::basefield);
          s.setf(std::ios::showbase);
        }
 
        s << "  " << (*i)->get_name() << ": " << *di++ << std::endl;
 
        if ((*i)->is_integer() && (*i)->get_format() != OksAttribute::Dec) {
          s.setf(std::ios::dec, std::ios::basefield);
          s.unsetf(std::ios::showbase);
        }
      }
    } else
      s << " There are no attributes\n";
  }
 
  // print relationships
 
  {
    const std::list<OksRelationship*>* rlist = c->all_relationships();
 
    if (rlist && !rlist->empty()) {
      s << " Relationships are:\n";
 
      for (std::list<OksRelationship*>::const_iterator i = rlist->begin(); i != rlist->end(); ++i)
        s << "  " << (*i)->get_name() << ": " << *di++ << std::endl;
    } else
      s << " There are no relationships\n";
  }
 
  return s;
}

Member Data Documentation

change_notify_fn

OksClass::ChangeNotifyFN dunedaq::oks::OksClass::change_notify_fn

staticprivate

Definition at line 912 of file class.hpp.

class_xml_tag

const char dunedaq::oks::OksClass::class_xml_tag = "class"

staticprivate

Definition at line 952 of file class.hpp.

create_notify_fn

OksClass::NotifyFN dunedaq::oks::OksClass::create_notify_fn

staticprivate

Definition at line 911 of file class.hpp.

delete_notify_fn

OksClass::NotifyFN dunedaq::oks::OksClass::delete_notify_fn

staticprivate

Definition at line 913 of file class.hpp.

description_xml_attr

const char dunedaq::oks::OksClass::description_xml_attr = "description"

staticprivate

Definition at line 954 of file class.hpp.

is_abstract_xml_attr

const char dunedaq::oks::OksClass::is_abstract_xml_attr = "is-abstract"

staticprivate

Definition at line 955 of file class.hpp.

name_xml_attr

const char dunedaq::oks::OksClass::name_xml_attr = "name"

staticprivate

Definition at line 953 of file class.hpp.

p_abstract

bool dunedaq::oks::OksClass::p_abstract

private

Definition at line 886 of file class.hpp.

p_all_attributes

std::list<OksAttribute*>* dunedaq::oks::OksClass::p_all_attributes

private

Definition at line 892 of file class.hpp.

p_all_methods

std::list<OksMethod*>* dunedaq::oks::OksClass::p_all_methods

private

Definition at line 894 of file class.hpp.

p_all_relationships

std::list<OksRelationship*>* dunedaq::oks::OksClass::p_all_relationships

private

Definition at line 893 of file class.hpp.

p_all_sub_classes

FList* dunedaq::oks::OksClass::p_all_sub_classes

private

Definition at line 891 of file class.hpp.

p_all_super_classes

FList* dunedaq::oks::OksClass::p_all_super_classes

private

Definition at line 890 of file class.hpp.

p_attributes

std::list<OksAttribute*>* dunedaq::oks::OksClass::p_attributes

private

Definition at line 883 of file class.hpp.

p_data_info

OksDataInfo::Map* dunedaq::oks::OksClass::p_data_info

private

Definition at line 904 of file class.hpp.

p_description

std::string dunedaq::oks::OksClass::p_description

private

Definition at line 881 of file class.hpp.

p_file

OksFile* dunedaq::oks::OksClass::p_file

private

Definition at line 899 of file class.hpp.

p_id

unsigned int dunedaq::oks::OksClass::p_id

private

Definition at line 897 of file class.hpp.

p_indices

OksIndex::Map* dunedaq::oks::OksClass::p_indices

private

Definition at line 906 of file class.hpp.

p_inheritance_hierarchy

std::vector<OksClass*>* dunedaq::oks::OksClass::p_inheritance_hierarchy

private

Definition at line 896 of file class.hpp.

p_instance_size

size_t dunedaq::oks::OksClass::p_instance_size

private

Definition at line 902 of file class.hpp.

p_kernel

OksKernel* dunedaq::oks::OksClass::p_kernel

private

Definition at line 900 of file class.hpp.

p_methods

std::list<OksMethod*>* dunedaq::oks::OksClass::p_methods

private

Definition at line 885 of file class.hpp.

p_mutex

std::shared_mutex dunedaq::oks::OksClass::p_mutex

mutableprivate

Definition at line 908 of file class.hpp.

p_name

std::string dunedaq::oks::OksClass::p_name

private

Definition at line 880 of file class.hpp.

p_objects

OksObject::Map* dunedaq::oks::OksClass::p_objects

private

Definition at line 905 of file class.hpp.

p_relationships

std::list<OksRelationship*>* dunedaq::oks::OksClass::p_relationships

private

Definition at line 884 of file class.hpp.

p_super_classes

std::list<std::string*>* dunedaq::oks::OksClass::p_super_classes

private

Definition at line 882 of file class.hpp.

p_to_be_deleted

bool dunedaq::oks::OksClass::p_to_be_deleted

private

Definition at line 888 of file class.hpp.

p_transient

bool dunedaq::oks::OksClass::p_transient

private

Definition at line 887 of file class.hpp.

p_unique_id_mutex

std::mutex dunedaq::oks::OksClass::p_unique_id_mutex

mutableprivate

Definition at line 909 of file class.hpp.

superclass_xml_attr

const char dunedaq::oks::OksClass::superclass_xml_attr = "superclass"

staticprivate

Definition at line 956 of file class.hpp.

---

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

• /github/workspace/dunedaq/sourcecode/oks/include/oks/class.hpp
• /github/workspace/dunedaq/sourcecode/oks/src/class.cpp
• /github/workspace/dunedaq/sourcecode/oks/src/query.cpp