beamb_options.beamb_options Class Reference

Public Member Functions
	__init__ (self, configfile=BEAMB_OPTIONS_FILE)
	initialize (self)
	get_options (self, nod)
	get_options_for_object (self, inobj)
	has_options (self, nod)

Protected Attributes
	_configfile = configfile
dict	_siteoptions = {}

Detailed Description

 Keeps tracks of all site options

Constructor & Destructor Documentation

__init__()

beamb_options.beamb_options.__init__	(		self,
			configfile = BEAMB_OPTIONS_FILE )

 Constructor. Will trigger an exception if configuration file can't be parsed.
:param configfile: The xml configuration file

Member Function Documentation

get_options()

beamb_options.beamb_options.get_options	(		self,
			nod )

 Returns options for specified nod. If nod not found, then default will be returned.
:param nod: The nod
:return: The options for specified nod or default options

get_options_for_object()

beamb_options.beamb_options.get_options_for_object	(		self,
			inobj )

 Returns options for specified object. Will atempt to extract nod from object. See \ref get_options.
:param inobj: A rave object
:return: the options

has_options()

beamb_options.beamb_options.has_options	(		self,
			nod )

 Returns if the nod exists in the options

initialize()

beamb_options.beamb_options.initialize

(

self

)

 Initializes the site options.

---

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

• /github/workspace/pybeamb/beamb_options.py