Class NitrogenRule
java.lang.Object
org.openscience.cdk.formula.rules.NitrogenRule
- All Implemented Interfaces:
IRule
This class validate if the rule of nitrogen is kept.
If a compound has an odd number of nitrogen atoms, then the molecular ion (the [M]+) will have an odd mass and the value for m/e will be odd.
If a compound has no nitrogen atom or an even number of nitrogen atoms, then the m/e value of [M]+ will be even.
Name | Default | Description |
charge | 0.0 | The Nitrogen rule of MolecularFormula |
- Author:
- miguelrojasch
- Source code:
- main
- Belongs to CDK module:
- formula
- Created on:
- 2008-06-11
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionObject[]
Gets the parameters attribute of the NitrogenRule object.void
setParameters
(Object[] params) Sets the parameters attribute of the NitrogenRule object.double
validate
(IMolecularFormula formula) Validate the nitrogen rule of this IMolecularFormula.
-
Constructor Details
-
NitrogenRule
public NitrogenRule()Constructor for the NitrogenRule object.
-
-
Method Details
-
setParameters
Sets the parameters attribute of the NitrogenRule object.- Specified by:
setParameters
in interfaceIRule
- Parameters:
params
- The new parameters value- Throws:
CDKException
- Description of the Exception- See Also:
-
getParameters
Gets the parameters attribute of the NitrogenRule object.- Specified by:
getParameters
in interfaceIRule
- Returns:
- The parameters value
- See Also:
-
validate
Validate the nitrogen rule of this IMolecularFormula.- Specified by:
validate
in interfaceIRule
- Parameters:
formula
- Parameter is the IMolecularFormula- Returns:
- A double value meaning 1.0 True, 0.0 False
- Throws:
CDKException
- if an error occurs during the validation. See documentation for individual rules
-