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

Class: NamingSystem


    ChemComp naming system. Serves as container for ChemComp and Atom/AtomSet systematic names. May be defined relative to a reference, in which case only names that differ from those in the reference are given explicitly
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link chemComp to class ChemComp
Main key: name
Mandatory Attributes: name
Known Subclasses: None
Children:
link atomSysNames to class AtomSysName
link chemCompSysNames to class ChemCompSysName
link chemTorsionSysNames to class ChemTorsionSysName
Constructor: newObj = NamingSystem( chemComp,name=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
name Word 1..1 naming system within which systematic names are defined  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
atomReference NamingSystem 0..1 Reference naming system for atom names. Any atom names not found under the namingSystem itself should be sought in the reference NamingSystem  
atomSetReference NamingSystem 0..1 Reference naming system for atom set names. Any atom names not found under the namingSystem itself should be sought in the reference NamingSystem  
atomSetVariantSystems NamingSystem 0..* variant naming systems that use the present one for atom name reference  
atomSysNames AtomSysName 0..* (Child link). child link to class AtomSysName  
atomVariantSystems NamingSystem 0..* variant naming systems that use the present one for atom name reference  
chemComp ChemComp 1..1 (Parent link). parent link  
chemCompSysNames ChemCompSysName 0..* (Child link). child link to class ChemCompSysName  
chemTorsionSysNames ChemTorsionSysName 0..* (Child link). child link to class ChemTorsionSysName  
mainChemCompSysName ChemCompSysName 0..1 Derived. ChemCompSysName valid for ChemCompVars where nothing esle is set, and hence valid for the entire ChemComp.  
parent ChemComp 1..1 link to parent object - synonym for chemComp  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
name
getName Word -
setName - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
atomReference
getAtomReference NamingSystem -
setAtomReference - NamingSystem
atomSetReference
getAtomSetReference NamingSystem -
setAtomSetReference - NamingSystem
atomSetVariantSystems
getAtomSetVariantSystems NamingSystem Set -
setAtomSetVariantSystems - NamingSystem Set
sortedAtomSetVariantSystems NamingSystem List -
addAtomSetVariantSystem - NamingSystem
removeAtomSetVariantSystem - NamingSystem
findFirstAtomSetVariantSystem NamingSystem keyword=value pairs
findAllAtomSetVariantSystems NamingSystem Set keyword=value pairs
atomSysNames
getAtomSysNames AtomSysName Set -
sortedAtomSysNames AtomSysName List -
findFirstAtomSysName AtomSysName keyword=value pairs
findAllAtomSysNames AtomSysName Set keyword=value pairs
atomVariantSystems
getAtomVariantSystems NamingSystem Set -
setAtomVariantSystems - NamingSystem Set
sortedAtomVariantSystems NamingSystem List -
addAtomVariantSystem - NamingSystem
removeAtomVariantSystem - NamingSystem
findFirstAtomVariantSystem NamingSystem keyword=value pairs
findAllAtomVariantSystems NamingSystem Set keyword=value pairs
chemComp
getChemComp ChemComp -
chemCompSysNames
getChemCompSysNames ChemCompSysName Set -
sortedChemCompSysNames ChemCompSysName List -
findFirstChemCompSysName ChemCompSysName keyword=value pairs
findAllChemCompSysNames ChemCompSysName Set keyword=value pairs
chemTorsionSysNames
getChemTorsionSysNames ChemTorsionSysName Set -
sortedChemTorsionSysNames ChemTorsionSysName List -
findFirstChemTorsionSysName ChemTorsionSysName keyword=value pairs
findAllChemTorsionSysNames ChemTorsionSysName Set keyword=value pairs
mainChemCompSysName
getMainChemCompSysName ChemCompSysName - non-std.
parent
getParent ChemComp -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey NamingSystem 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
newAtomSysName AtomSysName atomName, sysName, ...
newChemCompSysName ChemCompSysName sysName, ...
newChemTorsionSysName ChemTorsionSysName chemTorsion, ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2007-05-03-17:42:17_00001

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:11 2014    from data model package  ccp.api.molecule.ChemComp.NamingSystem   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk