KERNEL_PY.kernel.datamodeler.DataModeler Class Reference

This class is a placeholder for modeling data. More...

Public Member Functions
def	__init__ (self, typemap=None, rangemap=None, defaultmap=None, voidmap=None)
def	addAttribute (self, name, a_type=None, a_range=None, default=None, void=None)
	A None argument means that no entry is created in the associated maps. More...
def	__setattr__ (self, name, val)
def	__getattribute__ (self, name)
def	log (self)

Private Member Functions
def	__isNotValidType (self, name, val)
def	__isNotValidRange (self, name, val)
def	__isVoidAllowed (self, name)

Private Attributes
	_typemap
	_rangemap
	_defaultmap
	_voidmap

Detailed Description

This class is a placeholder for modeling data.

An object based on this class (particular instance or specialized derived class) can defined attributes with the following properties:

• a type : the class or the type of the attribute. Setting an attribute to a value whose type is not the specified type raises an exception.
• a range : a list of the possible values for the attribute. Setting an attribute to a value not in the range raises an exception
• a default: the default value of an attribute when an instance is created
• a void flag: the attribute can be authorized to be None or not using this flag. Setting an attribute to a None value while the flag is not set to True raises an exception. By default, a None value is not allowed.

These properties are dictionnaries mapping the attribute name to its associated value for the property.
A typical usage is to derived this class in a specialized form where the attributes names and there properties are defined in the constructor. See use cases at the end of this file.

This class is a placeholder for modeling data. An object based on this class
(particular instance or specialized derived class) can defined attributes with
the following properties:

- a type : the class or the type of the attribute. Setting an attribute to
  a value whose type is not the specified type raises an exception.
- a range : a list of the possible values for the attribute. Setting an
  attribute to a value not in the range raises an exception
- a default: the default value of an attribute when an instance is created
- a void flag: the attribute can be authorized to be None or not using this
  flag. Setting an attribute to a None value while the flag is not set to
  True raises an exception. By default, a None value is not allowed.

These properties are dictionnaries mapping the attribute name to its
associated value for the property.

A typical usage is to derived this class in a specialized form where the
attributes names and there properties are defined in the constructor. See
use cases at the end of this file.

Constructor & Destructor Documentation

__init__()

def KERNEL_PY.kernel.datamodeler.DataModeler.__init__	(		self,
			typemap = None,
			rangemap = None,
			defaultmap = None,
			voidmap = None
	)

Member Function Documentation

__getattribute__()

def KERNEL_PY.kernel.datamodeler.DataModeler.__getattribute__	(		self,
			name
	)

References datamodeler.DataModeler._typemap, KERNEL_PY.kernel.datamodeler.DataModeler._typemap, and uiexception.DevelException().

__isNotValidRange()

def KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidRange (   self,   name,   val  )

private

References datamodeler.DataModeler._rangemap, and KERNEL_PY.kernel.datamodeler.DataModeler._rangemap.

Referenced by datamodeler.DataModeler.__setattr__(), and KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__().

__isNotValidType()

def KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidType (   self,   name,   val  )

private

References datamodeler.DataModeler._typemap, and KERNEL_PY.kernel.datamodeler.DataModeler._typemap.

Referenced by datamodeler.DataModeler.__setattr__(), and KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__().

__isVoidAllowed()

def KERNEL_PY.kernel.datamodeler.DataModeler.__isVoidAllowed (   self,   name  )

private

References datamodeler.DataModeler._voidmap, and KERNEL_PY.kernel.datamodeler.DataModeler._voidmap.

Referenced by datamodeler.DataModeler.__setattr__(), and KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__().

__setattr__()

def KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__	(		self,
			name,
			val
	)

References datamodeler.DataModeler.__isNotValidRange(), KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidRange(), datamodeler.DataModeler.__isNotValidType(), KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidType(), datamodeler.DataModeler.__isVoidAllowed(), KERNEL_PY.kernel.datamodeler.DataModeler.__isVoidAllowed(), datamodeler.DataModeler._rangemap, KERNEL_PY.kernel.datamodeler.DataModeler._rangemap, datamodeler.DataModeler._typemap, KERNEL_PY.kernel.datamodeler.DataModeler._typemap, and uiexception.DevelException().

Referenced by datamodeler.DataModeler.addAttribute(), and KERNEL_PY.kernel.datamodeler.DataModeler.addAttribute().

addAttribute()

def KERNEL_PY.kernel.datamodeler.DataModeler.addAttribute	(		self,
			name,
			a_type = None,
			a_range = None,
			default = None,
			void = None
	)

A None argument means that no entry is created in the associated maps.

A None argument means that no entry is created in the associated maps.

References datamodeler.DataModeler.__setattr__(), KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__(), datamodeler.DataModeler._rangemap, KERNEL_PY.kernel.datamodeler.DataModeler._rangemap, datamodeler.DataModeler._typemap, KERNEL_PY.kernel.datamodeler.DataModeler._typemap, datamodeler.DataModeler._voidmap, and KERNEL_PY.kernel.datamodeler.DataModeler._voidmap.

Referenced by KERNEL_PY.kernel.testdata.TestData.__init__().

log()

def KERNEL_PY.kernel.datamodeler.DataModeler.log

(

self

)

References datamodeler.DataModeler._typemap, and KERNEL_PY.kernel.datamodeler.DataModeler._typemap.

Field Documentation

_defaultmap

KERNEL_PY.kernel.datamodeler.DataModeler._defaultmap

private

_rangemap

KERNEL_PY.kernel.datamodeler.DataModeler._rangemap

private

Referenced by datamodeler.DataModeler.__isNotValidRange(), KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidRange(), datamodeler.DataModeler.__setattr__(), KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__(), datamodeler.DataModeler.addAttribute(), and KERNEL_PY.kernel.datamodeler.DataModeler.addAttribute().

_typemap

KERNEL_PY.kernel.datamodeler.DataModeler._typemap

private

Referenced by datamodeler.DataModeler.__getattribute__(), KERNEL_PY.kernel.datamodeler.DataModeler.__getattribute__(), datamodeler.DataModeler.__isNotValidType(), KERNEL_PY.kernel.datamodeler.DataModeler.__isNotValidType(), datamodeler.DataModeler.__setattr__(), KERNEL_PY.kernel.datamodeler.DataModeler.__setattr__(), datamodeler.DataModeler.addAttribute(), KERNEL_PY.kernel.datamodeler.DataModeler.addAttribute(), datamodeler.DataModeler.log(), and KERNEL_PY.kernel.datamodeler.DataModeler.log().

_voidmap

KERNEL_PY.kernel.datamodeler.DataModeler._voidmap

private

Referenced by datamodeler.DataModeler.__isVoidAllowed(), KERNEL_PY.kernel.datamodeler.DataModeler.__isVoidAllowed(), datamodeler.DataModeler.addAttribute(), and KERNEL_PY.kernel.datamodeler.DataModeler.addAttribute().