Data Model version 2.0.6
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: Violation


    Violation of linked-to constraint, calculated over structures defined in ViolationList.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link violationList to class ViolationList
Main key: constraint
Mandatory Attributes: calcValue, fractionViolated, violation, constraint
Known Subclasses: None
Children: None
Constructor: newObj = Violation( violationList,calcValue=value, fractionViolated=value, violation=value, constraint=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
calcValue Float 1..1 The value calculated for the quantity being constrained.  
calcValueError Float 0..1 Error (standard deviation) in the calculated value  
fractionViolated FloatRatio 1..1 Fraction of structures in which the constraint was violated  
violation NonNegativeFloat 1..1 Value of the violation - the amount by which the calcValue exceeds the limit given in the Constraint. The violation is always given as positive. The unit is given by the ConstraintList containing the violated Constraint  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
constraint AbstractConstraint 1..1 Constraint being violated  
method ccp.api.general.Method.Method 0..1 Method used for calculating violation  
parent ViolationList 1..1 link to parent object - synonym for violationList  
violationList ViolationList 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
calcValue
getCalcValue Float -
setCalcValue - Float
calcValueError
getCalcValueError Float -
setCalcValueError - Float
fractionViolated
getFractionViolated FloatRatio -
setFractionViolated - FloatRatio
violation
getViolation NonNegativeFloat -
setViolation - NonNegativeFloat

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
constraint
getConstraint AbstractConstraint -
setConstraint - AbstractConstraint
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
parent
getParent ViolationList -
violationList
getViolationList ViolationList -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Violation memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:51_00002

isImplicit:

False

Tag

Value
repositoryId $Id: Violation.xml,v 1.47 2011-01-13 14:40:35 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:53 2013    from data model package  ccp.api.nmr.NmrConstraint.Violation   revision 1.47  
  Work done by the CCPN team.
www.ccpn.ac.uk