MPCDAnalysis.DataManager.ConfigPartSpecialAction Class Reference

Public Member Functions
def	__init__ (self, action)
def	isDelete (self)
def	isCreateGroup (self)

Detailed Description

Class that represents a special action to be performed in config part
generators, like deleting settings or creating setting groups.

Definition at line 935 of file DataManager.py.

Constructor & Destructor Documentation

__init__()

def MPCDAnalysis.DataManager.ConfigPartSpecialAction.__init__	(		self,
			action
	)

    The constructor.

    @throw TypeError
           Throws if `action` is not a `str`.
    @throw ValueError
           Throws if `action` has an illegal value.

    @param[in] action
               The action to perform on the associated setting. Can be
               `"delete"` to delete the setting (and possibly any
               sub-settings), or `"createGroup"` to create a settings
               group of that name.

Definition at line 952 of file DataManager.py.

Member Function Documentation

isCreateGroup()

def MPCDAnalysis.DataManager.ConfigPartSpecialAction.isCreateGroup

(

self

)

    Returns whether the action is to create the associated setting group.

Definition at line 976 of file DataManager.py.

isDelete()

def MPCDAnalysis.DataManager.ConfigPartSpecialAction.isDelete

(

self

)

    Returns whether the action is to delete the associated setting.

Definition at line 967 of file DataManager.py.

---

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

• DataManager.py