Gconstraint Class Reference

Base class for describing constraints. More...

Inheritance diagram for Gconstraint:

[legend]Collaboration diagram for Gconstraint:

[legend]List of all members.

Public Member Functions
	__init__ (name, subsystem, category, enabled, continuous=False)
	_eval_ (value)
	evaluate (value)
	name ()
	subsystem ()
	category ()
	enabled ()
	enable ()
	disable ()
	reset ()
	reject (message)

---

Detailed Description

Base class for describing constraints.

Definition at line 28 of file gConstraint.py.

---

Member Function Documentation

__init__ (  name  , subsystem  , category  , enabled  , continuous  = False )

Constructor. Parameters: name  Constraint name subsystem  Subsystem gGroup to which the constraint belongs category  Category gGroup to which the constraint belongs enabled  Flag indicating whether constraint is enabled continuous  Flag indicating whether constraint can fire repeatedly

_eval_ (  value   )

Dummy evaluation method to be overridden through inheritance to implement the application specific constraint evaluation Reimplemented in GconstraintLimitRE, GconstraintLimit, and GconstraintLimitPegRE.

category (   )

Method for discovering this constraint's category

disable (   )

Method used to disable evaluation of this constraint

enable (   )

Method used to enable evaluation of this constraint

enabled (   )

Method for discovering whether this constraint is enabled

evaluate (  value   )

This method is called to evaluate the constraint on 'value Reimplemented from GconstraintBase.

name (   )

Method to retrieve the constraint's name

reject (  message   )

Method optionally used by the constraint evaluation implementation to signal a constraint violation

reset (   )

Method used to reenable evaluation of this constraint in the case of noncontinuous mode after it has been violated

subsystem (   )

Method for discovering this constraint's subsystem

---

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

• gConstraint.py

---