Preferences Class Reference

Preferences dictionary. More...

List of all members.

Public Member Functions
def	__init__
	Preferences constructor.
def	__getitem__
	Overridden method to process the item before returning it.
def	__setitem__
	Overridden method to set the last item.
def	isDir
	Is the item a path preference?
def	isNumber
	Is the item a numeric preference?
def	isLastItem
	Is the preference item a last item?
def	expandVars
	Expand the environment variables and macros in path.
def	composePath
	Convert the path value back to its macro form.
def	getLastItem
	Retrieve the last item for the preference.
Static Public Attributes
list	ROOT_DIR_ENVS = ['ONLINE_ROOT']
tuple	DIR_LIST
tuple	CHOICE_LIST
tuple	LOGGING_LIST = ("lognbl", "loglevel", "loghost", "logport")
tuple	SYSTEM_LIST
tuple	LAST_ITEMS
tuple	TREAT_AS_INT
tuple	EXCLUDED_DICTS = ("hwConfig")

---

Detailed Description

Preferences dictionary.

Preferences needs a special dictionary class since the data it stores may have macros and environment variables in it.

In order to read the values unprocessed use the self.__prefs.get(item) method. If you need to resolve all the macros and environment variables then access it like any other dictionary (self.__prefs[item])

Definition at line 370 of file rcPreferencesManager.py.

---

Member Function Documentation

def __getitem__ (    self,   item )

Overridden method to process the item before returning it. Parameters: item  Preference item Definition at line 404 of file rcPreferencesManager.py.

def __init__ (    self  )

Preferences constructor. Definition at line 397 of file rcPreferencesManager.py.

def __setitem__ (    self,   item,   value )

Overridden method to set the last item. Parameters: item  Preference item value  Preference value Definition at line 417 of file rcPreferencesManager.py.

def composePath (    self,   path )

Convert the path value back to its macro form. Parameters: path  Path preference value Definition at line 471 of file rcPreferencesManager.py.

def expandVars (    self,   path )

Expand the environment variables and macros in path. Parameters: path  Path preference value Definition at line 448 of file rcPreferencesManager.py.

def getLastItem (    self,   item )

Retrieve the last item for the preference. Parameters: item  Preference item Definition at line 482 of file rcPreferencesManager.py.

def isDir (    self,   item )

Is the item a path preference? Parameters: item  Preference item Definition at line 427 of file rcPreferencesManager.py.

def isLastItem (    self,   item )

Is the preference item a last item? Parameters: item  Preference item Definition at line 441 of file rcPreferencesManager.py.

def isNumber (    self,   item )

Is the item a numeric preference? Parameters: item  Preference item Definition at line 434 of file rcPreferencesManager.py.

---

Member Data Documentation

tuple CHOICE_LIST [static]

Initial value: ("datasave", "dataexport", "snapnbl", "versionnbl", "elognbl") Definition at line 378 of file rcPreferencesManager.py.

tuple DIR_LIST [static]

Initial value: ("reposdir", "appdir", "datadir", "logdir", "reportdir", "snapshotdir", "exportdir", "runiddir") Definition at line 374 of file rcPreferencesManager.py.

tuple EXCLUDED_DICTS = ("hwConfig") [static]

Definition at line 395 of file rcPreferencesManager.py.

tuple LAST_ITEMS [static]

Initial value: ("lastuser", "lastsite", "lastorientation", "lastparticletype", "lastinstrumenttype", "lastphase") Definition at line 388 of file rcPreferencesManager.py.

tuple LOGGING_LIST = ("lognbl", "loglevel", "loghost", "logport") [static]

Definition at line 381 of file rcPreferencesManager.py.

list ROOT_DIR_ENVS = ['ONLINE_ROOT'] [static]

Definition at line 372 of file rcPreferencesManager.py.

tuple SYSTEM_LIST [static]

Initial value: ("pythonpath", "elogurl", "server", "servernbl", "fontfamily", "fontsize", "fontweight", "fontitalic", "style", "preload", "dontreload", "disablereload", "showunloaded", "disableverification") Definition at line 383 of file rcPreferencesManager.py.

tuple TREAT_AS_INT [static]

Initial value: ("datasave", "dataexport", "snapnbl", "versionnbl", "elognbl", "lognbl", "servernbl", "disablereload", "showunloaded", "logport", "disableverification") Definition at line 391 of file rcPreferencesManager.py.

---

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

• rcPreferencesManager.py

---