Describe one variable. More...

Collaboration diagram for D3PD::AuxDataFillerTool::Var:

Public Member Functions
	Var (const std::string &the_name, const std::string &the_docstring, const std::vector< std::string > &the_labels, const std::vector< std::string > &the_label_classes, const std::string &the_defstring, bool the_has_default)
	Constructor. More...

const void *	access (const SG::AuxElement &p) const
	Try to retrieve an aux data item from p. More...

Public Attributes
std::string	name
	Name of the variable. More...

std::string	docstring
	Docstring for the variable. More...

RootUtils::Type::unique_ptr	defobj
	If present, a default object instance to use if the aux variable is not present. More...

bool	has_default
	If true, this aux variable can be defaulted. More...

RootUtils::Type	type
	Type of the item. More...

const std::type_info *	ti
	Type of the variable, as `type_info`. More...

std::vector< SG::AuxElement::TypelessConstAccessor >	accessors
	Aux data accessor(s) for the item. More...

void *	ptr
	Pointer passed to `ID3PD`. More...

std::string	label
	Name of the aux data item(s). More...

Detailed Description

Describe one variable.

Definition at line 80 of file AuxDataFillerTool.h.

Constructor & Destructor Documentation

◆ Var()

D3PD::AuxDataFillerTool::Var::Var	(	const std::string &	the_name,
		const std::string &	the_docstring,
		const std::vector< std::string > &	the_labels,
		const std::vector< std::string > &	the_label_classes,
		const std::string &	the_defstring,
		bool	the_has_default
	)

Constructor.

Parameters

the_name	Name of the variable.
the_docstring	Docstring for the variable.
the_labels	Name of the aux data item(s).
the_label_classes	Class(es) of the aux data item(s), or blank strings.
the_defstring	String giving the default value.
the_has_default	Can this variable be defaulted?

Definition at line 36 of file AuxDataFillerTool.cxx.

   : name (the_name),
     docstring (the_docstring),
     has_default (the_has_default),
     ptr (0)
 {
   const SG::AuxTypeRegistry& reg = SG::AuxTypeRegistry::instance();
  
   std::string firstName;
   SG::auxid_t firstId = SG::null_auxid;
   ti = 0;
   assert (the_labels.size() == the_label_classes.size());
   for (size_t i = 0; i < the_labels.size(); i++) {
     SG::auxid_t auxid = reg.findAuxID (the_labels[i], the_label_classes[i]);
     if (auxid != SG::null_auxid) {
       accessors.emplace_back (the_labels[i], the_label_classes[i]);
  
       std::string name = the_label_classes[i] + "::" + the_labels[i];
       if (!label.empty())
         label += ",";
       label += name;
  
       // Find the type of the variable.
       if (ti == 0) {
         ti = reg.getType (auxid);
         type.init (reg.getTypeName (auxid));
         firstName = name;
         firstId = auxid;
       }
       else {
         if (ti != reg.getType (auxid)) {
           std::string errstr = "Inconsistent types for aux data: " +
             firstName + " (" + reg.getTypeName (firstId) +") vs " +
             name + " (" + reg.getTypeName (auxid) + ")";
           throw std::runtime_error (errstr);
         }
       }
     }
   }
  
   if (the_has_default && !the_defstring.empty()) {
     defobj = RootUtils::Type::unique_ptr (type.create(), type);
     type.fromString (defobj.get(), the_defstring);
   }
 }

Member Function Documentation

◆ access()

const void * D3PD::AuxDataFillerTool::Var::access ( const SG::AuxElement & p ) const

Try to retrieve an aux data item from p.

Parameters

p	The element to read from.

Returns 0 if no alternatives are available.

Definition at line 94 of file AuxDataFillerTool.cxx.

 {
   for (const auto& a : accessors) {
     if (a.isAvailable(p))
       return a(p);
   }
   return 0;
 }

Member Data Documentation

◆ accessors

std::vector<SG::AuxElement::TypelessConstAccessor> D3PD::AuxDataFillerTool::Var::accessors

Aux data accessor(s) for the item.

Definition at line 128 of file AuxDataFillerTool.h.

◆ defobj

RootUtils::Type::unique_ptr D3PD::AuxDataFillerTool::Var::defobj

If present, a default object instance to use if the aux variable is not present.

Definition at line 116 of file AuxDataFillerTool.h.

◆ docstring

std::string D3PD::AuxDataFillerTool::Var::docstring

Docstring for the variable.

Definition at line 112 of file AuxDataFillerTool.h.

◆ has_default

bool D3PD::AuxDataFillerTool::Var::has_default

If true, this aux variable can be defaulted.

Definition at line 119 of file AuxDataFillerTool.h.

◆ label

std::string D3PD::AuxDataFillerTool::Var::label

Name of the aux data item(s).

Definition at line 134 of file AuxDataFillerTool.h.

◆ name

std::string D3PD::AuxDataFillerTool::Var::name

Name of the variable.

Definition at line 109 of file AuxDataFillerTool.h.

◆ ptr

void* D3PD::AuxDataFillerTool::Var::ptr

Pointer passed to ID3PD.

Definition at line 131 of file AuxDataFillerTool.h.

◆ ti

const std::type_info* D3PD::AuxDataFillerTool::Var::ti

Type of the variable, as type_info.

Definition at line 125 of file AuxDataFillerTool.h.

◆ type

RootUtils::Type D3PD::AuxDataFillerTool::Var::type

Type of the item.

Definition at line 122 of file AuxDataFillerTool.h.

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

Public Member Functions

Public Attributes