Gattr Class Reference

Base class which is instantiated once for each attribute kind. More...

Inheritance diagram for Gattr:

[legend]List of all members.

Public Member Functions
	__init__ (name, id, size, flags, rule=None, constraint=None, egu=None)
	create (node)
	set (node, value, bypass=0)
	get (node, bypass=0)
	getName ()
	size ()
	id ()
	setRule (rule)
	getRule ()
	setConstraint (constraint)
	setEGU (egu)
	getEGU ()
	getConstraint ()
	flags ()
	isReadOnly ()
	isWriteOnly ()
	isReadWrite ()
	isNoDirectAccess ()
	isCommand ()

---

Detailed Description

Base class which is instantiated once for each attribute kind.

Definition at line 26 of file gAttr.py.

---

Member Function Documentation

__init__ (  name  , id  , size  , flags  , rule  = None, constraint  = None, egu  = None )

Gattr constructor. Parameters: name  The name of the attribute. size  Attribute size in bytes. rule  Optional. Attribute rule. constraint  Optional. Attribute constraint. egu  Optional. Attribute EGU

getConstraint (   )

Method that returns the gConstraint.Gconstraint class for this gAttr Returns: A Gconstraint object instance

getEGU (   )

Method that returns the gEGU.GEGU class for this gAttr Returns: A Gegu object instance

getRule (   )

Retrieve the rule associated with the gAttr.

isNoDirectAccess (   )

Returns a boolean value indicating if the attribute is no direct access or not Returns: 1=No Direct Access, 0=Not No Direct Access.

isReadOnly (   )

Returns a boolean value indicating if the attribute is read only or not Returns: 1=Read Only, 0=Not Read Only.

isReadWrite (   )

Returns a boolean value indicating if the attribute is read write or not Returns: 1=Read Write, 0=Not Read Write.

isWriteOnly (   )

Returns a boolean value indicating if the attribute is write only or not Returns: 1=Write Only, 0=Not Write Only.

setConstraint (  constraint   )

Method to attach a constraint to a gAttr after the gAttr has been constructed. This method will go away once constraints are loaded from a configuration file. Parameters: constraint  A Gconstraint object instance

setEGU (  egu   )

Method to attach a EGU to a gAttr after the gAttr has been constructed. Parameters: egu  A Gegu object instance

setRule (  rule   )

Method to attach a rule to a gAttr after the gAttr has been constructed. Parameters: rule  A Grule object instance

size (   )

Method for returning the size of the attribute Returns: Attribute size in bytes

---

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

• gAttr.py

---