python.processes.configurable.Configurable Class Reference

Class for any process which can be configured. More...

Inheritance diagram for python.processes.configurable.Configurable:

Collaboration diagram for python.processes.configurable.Configurable:

Public Member Functions
def	__init__ (self)
	Constructor. More...
def	add_keyword (self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs)
	Register configurable parameter that is exposed to the user. More...
def	expose (self)
	Add all names to the interface of this object. More...
def	has_keyword (self, keyword)
def	has_parameter (self, parameter)
def	parameters_by_keyword (self, keyword)
	Retrieve all parameters that use a given keyword. More...
def	parameters_by_name (self, name)
	Retrieve all parameters that use a given name. More...

Public Attributes
	parameters
	List of available parameters. More...

Detailed Description

Class for any process which can be configured.

Author

James Robinson james.nosp@m..rob.nosp@m.inson.nosp@m.@cer.nosp@m.n.ch

Definition at line 10 of file configurable.py.

Constructor & Destructor Documentation

__init__()

def python.processes.configurable.Configurable.__init__

(

self

)

Constructor.

Definition at line 16 of file configurable.py.

    def __init__(self):
        """! Constructor."""
        
        self.parameters = []
 

Member Function Documentation

add_keyword()

def python.processes.configurable.Configurable.add_keyword	(		self,
			keyword,
			value = None,
			name = None,
			frozen = None,
			hidden = None,
			description = None,
		**	kwargs
	)

Register configurable parameter that is exposed to the user.

Parameters

keyword	Powheg keyword that gets written to the runcard.
value	Value of the parameter.
name	Configurable parameter name exposed to the user.
hidden	True if this parameter should be hidden from the user.
frozen	True if this parameter cannot be changed.
description	Description for the run card.
parameter	Name used in the run card if different.

Definition at line 21 of file configurable.py.

    def add_keyword(self, keyword, value=None, name=None, frozen=None, hidden=None, description=None, **kwargs):
        """! Register configurable parameter that is exposed to the user.
 
        @param keyword     Powheg keyword that gets written to the runcard.
        @param value       Value of the parameter.
        @param name        Configurable parameter name exposed to the user.
        @param hidden       True if this parameter should be hidden from the user.
        @param frozen       True if this parameter cannot be changed.
        @param description Description for the run card.
        @param parameter   Name used in the run card if different.
        """
        # Retrieve default settings from registry overriding if requested
        defaults = Registry().get_defaults(keyword)
        if value == defaults["value"] and value is not None and (hidden is not True):
            if keyword not in ["ebeam1", "ebeam2"]:
              logger.debug("Unnecessarily setting parameter {} to {} which is its default value!".format(keyword, value))
        value = [value, defaults["value"]][value is None]
        name = [name, defaults["name"]][name is None]
        description = [description, defaults["description"]][description is None]
        hidden = [hidden, defaults["hidden"]][hidden is None]
        frozen = [frozen, defaults["frozen"]][frozen is None]
        if keyword in [p.keyword for p in self.parameters]:
            raise AttributeError("Keyword '{}' has already been defined for this process".format(keyword))
        self.parameters.append(Parameter(keyword, name=name, value=value, frozen=frozen, hidden=hidden, description=description, **kwargs))
 

expose()

def python.processes.configurable.Configurable.expose

(

self

)

Add all names to the interface of this object.

Definition at line 46 of file configurable.py.

    def expose(self):
        """! Add all names to the interface of this object."""
        for parameter in self.parameters:
            setattr(self, parameter.name, parameter.value)
 

has_keyword()

def python.processes.configurable.Configurable.has_keyword	(		self,
			keyword
	)

Definition at line 51 of file configurable.py.

    def has_keyword(self, keyword):
        return (len(list(self.parameters_by_keyword(keyword))) > 0)
 

has_parameter()

def python.processes.configurable.Configurable.has_parameter	(		self,
			parameter
	)

Definition at line 54 of file configurable.py.

    def has_parameter(self, parameter):
        return (len(list(self.parameters_by_name(parameter))) > 0)
 

parameters_by_keyword()

def python.processes.configurable.Configurable.parameters_by_keyword	(		self,
			keyword
	)

Retrieve all parameters that use a given keyword.

Parameters

keyword

Powheg keyword that gets written to the runcard.

Definition at line 57 of file configurable.py.

    def parameters_by_keyword(self, keyword):
        """! Retrieve all parameters that use a given keyword.
 
        @param keyword  Powheg keyword that gets written to the runcard.
        """
        return [p for p in self.parameters if p.keyword == keyword]
 

parameters_by_name()

def python.processes.configurable.Configurable.parameters_by_name	(		self,
			name
	)

Retrieve all parameters that use a given name.

Parameters

name	Configurable parameter name exposed to the user.

Definition at line 64 of file configurable.py.

    def parameters_by_name(self, name):
        """! Retrieve all parameters that use a given name.
 
        @param name        Configurable parameter name exposed to the user.
        """
        return [p for p in self.parameters if p.name == name]

Member Data Documentation

parameters

python.processes.configurable.Configurable.parameters

List of available parameters.

Definition at line 19 of file configurable.py.

---

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

• configurable.py