$darkmode
DENOPTIM
denoptim.molecularmodeling.zmatrix.ZMatrixAtom Class Reference

Representation of an atom in the ZMatrix. More...

Collaboration diagram for denoptim.molecularmodeling.zmatrix.ZMatrixAtom:
[legend]

Public Member Functions

 ZMatrixAtom (int id, String symbol, String type, ZMatrixAtom bondRefAtom, ZMatrixAtom angleRefAtom, ZMatrixAtom angle2RefAtom, Double bondLength, Double angleValue, Double angle2Value, Integer chiralFlag)
 Constructor for ZMatrixAtom. More...
 
int getId ()
 Get the id of the atom. More...
 
void setId (int id)
 Set the id of the atom. More...
 
String getSymbol ()
 Get the symbol of the atom. More...
 
void setSymbol (String symbol)
 Set the symbol of the atom. More...
 
String getType ()
 Get the type of the atom. More...
 
void setType (String type)
 Set the type of the atom. More...
 
ZMatrixAtom getBondRefAtom ()
 Get the bond reference atom. More...
 
ZMatrixAtom getAngleRefAtom ()
 Get the angle reference atom. More...
 
ZMatrixAtom getAngle2RefAtom ()
 Get the angle2 reference atom. More...
 
Double getBondLength ()
 Get the bond length. More...
 
Double getAngleValue ()
 Get the angle value. More...
 
Double getAngle2Value ()
 Get the angle2 value. More...
 
void setBondLength (Double bondLength)
 Set the bond length. More...
 
void setAngleValue (Double angleValue)
 Set the angle value. More...
 
void setAngle2Value (Double angle2Value)
 Set the angle2 value. More...
 
void setChiralFlag (Integer chiralFlag)
 Set the chiral flag. More...
 
Integer getChiralFlag ()
 Get the chiral flag. More...
 
boolean usesProperTorsion ()
 Check if the atom uses proper torsion. More...
 
boolean equals (Object o)
 Get the string representation of the atom. More...
 
int hashCode ()
 
String toString ()
 

Package Functions

void setBondRefAtom (ZMatrixAtom bondRefAtom)
 Package-private setter for bond reference atom (used for cloning). More...
 
void setAngleRefAtom (ZMatrixAtom angleRefAtom)
 Package-private setter for angle reference atom (used for cloning). More...
 
void setAngle2RefAtom (ZMatrixAtom angle2RefAtom)
 Package-private setter for angle2 reference atom (used for cloning). More...
 

Private Attributes

int id
 
String symbol
 
String type
 
ZMatrixAtom bondRefAtom
 
ZMatrixAtom angleRefAtom
 
ZMatrixAtom angle2RefAtom
 
Double bondLength
 
Double angleValue
 
Double angle2Value
 
Integer chiralFlag
 

Detailed Description

Representation of an atom in the ZMatrix.

Definition at line 8 of file ZMatrixAtom.java.

Constructor & Destructor Documentation

◆ ZMatrixAtom()

denoptim.molecularmodeling.zmatrix.ZMatrixAtom.ZMatrixAtom ( int  id,
String  symbol,
String  type,
ZMatrixAtom  bondRefAtom,
ZMatrixAtom  angleRefAtom,
ZMatrixAtom  angle2RefAtom,
Double  bondLength,
Double  angleValue,
Double  angle2Value,
Integer  chiralFlag 
)

Constructor for ZMatrixAtom.

Parameters
idThe id of the atom
symbolThe symbol of the atom
typeThe type of the atom
bondRefAtomThe bond reference atom
angleRefAtomThe angle reference atom
angle2RefAtomThe angle2 reference atom
bondLengthThe bond length
angleValueThe angle value
angle2ValueThe angle2 value
chiralFlagThe chiral flag

Definition at line 36 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2RefAtom, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2Value, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleRefAtom, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleValue, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondLength, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondRefAtom, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.chiralFlag, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.id, denoptim.molecularmodeling.zmatrix.ZMatrixAtom.symbol, and denoptim.molecularmodeling.zmatrix.ZMatrixAtom.type.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrixAtom.equals().

Here is the caller graph for this function:

Member Function Documentation

◆ equals()

◆ getAngle2RefAtom()

ZMatrixAtom denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getAngle2RefAtom ( )

Get the angle2 reference atom.

Returns
The angle2 reference atom or null if not set

Definition at line 147 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2RefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), and denoptim.molecularmodeling.zmatrix.ZMatrix.getAngle2RefAtom().

Here is the caller graph for this function:

◆ getAngle2Value()

Double denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getAngle2Value ( )

Get the angle2 value.

Returns
The angle2 value or null if not set

Definition at line 180 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2Value.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.getAngle2Value(), and denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT().

Here is the caller graph for this function:

◆ getAngleRefAtom()

ZMatrixAtom denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getAngleRefAtom ( )

Get the angle reference atom.

Returns
The angle reference atom or null if not set

Definition at line 136 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleRefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), and denoptim.molecularmodeling.zmatrix.ZMatrix.getAngleRefAtom().

Here is the caller graph for this function:

◆ getAngleValue()

Double denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getAngleValue ( )

Get the angle value.

Returns
The angle value or null if not set

Definition at line 169 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleValue.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.getAngleValue(), and denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT().

Here is the caller graph for this function:

◆ getBondLength()

Double denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getBondLength ( )

Get the bond length.

Returns
The bond length or null if not set

Definition at line 158 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondLength.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.getBondLength(), and denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT().

Here is the caller graph for this function:

◆ getBondRefAtom()

ZMatrixAtom denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getBondRefAtom ( )

Get the bond reference atom.

Returns
The bond reference atom or null if not set

Definition at line 125 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondRefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), denoptim.molecularmodeling.zmatrix.ZMatrix.getBondRefAtom(), and denoptim.molecularmodeling.zmatrix.ZMatrix.getBondsToDel().

Here is the caller graph for this function:

◆ getChiralFlag()

Integer denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getChiralFlag ( )

Get the chiral flag.

Returns
The chiral flag or null if not set

Definition at line 235 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.chiralFlag.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.getChiralFlag(), and denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT().

Here is the caller graph for this function:

◆ getId()

◆ getSymbol()

String denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getSymbol ( )

Get the symbol of the atom.

Returns
The symbol of the atom

Definition at line 81 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.symbol.

Referenced by denoptim.integration.rcoserver.RCOSocketServerClient.getZMatrixAsJsonArray(), denoptim.integration.tinker.ConformationalSearchPSSROT.setTinkerTypes(), denoptim.molecularmodeling.zmatrix.ZMatrixTest.testClone(), and denoptim.integration.tinker.TinkerUtils.writeTinkerINT().

Here is the caller graph for this function:

◆ getType()

String denoptim.molecularmodeling.zmatrix.ZMatrixAtom.getType ( )

Get the type of the atom.

Returns
The type of the atom

Definition at line 103 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.type.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrixTest.testClone(), and denoptim.integration.tinker.TinkerUtils.writeTinkerINT().

Here is the caller graph for this function:

◆ hashCode()

◆ setAngle2RefAtom()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setAngle2RefAtom ( ZMatrixAtom  angle2RefAtom)
package

Package-private setter for angle2 reference atom (used for cloning).

Definition at line 276 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2RefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setAngle2Value()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setAngle2Value ( Double  angle2Value)

Set the angle2 value.

Parameters
angle2ValueThe angle2 value to set

Definition at line 213 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angle2Value.

Referenced by denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT(), denoptim.integration.rcoserver.RCOSocketServerClient.runConformationalOptimization(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setAngleRefAtom()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setAngleRefAtom ( ZMatrixAtom  angleRefAtom)
package

Package-private setter for angle reference atom (used for cloning).

Definition at line 266 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleRefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setAngleValue()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setAngleValue ( Double  angleValue)

Set the angle value.

Parameters
angleValueThe angle value to set

Definition at line 202 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.angleValue.

Referenced by denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT(), denoptim.integration.rcoserver.RCOSocketServerClient.runConformationalOptimization(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setBondLength()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setBondLength ( Double  bondLength)

Set the bond length.

Parameters
bondLengthThe bond length to set

Definition at line 191 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondLength.

Referenced by denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT(), denoptim.integration.rcoserver.RCOSocketServerClient.runConformationalOptimization(), denoptim.molecularmodeling.RingClosureTool.saturateRingClosingAttractor(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setBondRefAtom()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setBondRefAtom ( ZMatrixAtom  bondRefAtom)
package

Package-private setter for bond reference atom (used for cloning).

Definition at line 256 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.bondRefAtom.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrix.clone(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setChiralFlag()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setChiralFlag ( Integer  chiralFlag)

Set the chiral flag.

Parameters
chiralFlagThe chiral flag to set

Definition at line 224 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.chiralFlag.

Referenced by denoptim.integration.tinker.ConformationalSearchPSSROT.performPSSROT(), denoptim.integration.rcoserver.RCOSocketServerClient.runConformationalOptimization(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setId()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setId ( int  id)

Set the id of the atom.

Parameters
idThe id of the atom to set

Definition at line 70 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.id.

Referenced by denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testZMatrixAtomHashCode().

Here is the caller graph for this function:

◆ setSymbol()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setSymbol ( String  symbol)

Set the symbol of the atom.

Parameters
symbolThe symbol of the atom to set

Definition at line 92 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.symbol.

Referenced by denoptim.molecularmodeling.RingClosureTool.saturateRingClosingAttractor(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ setType()

void denoptim.molecularmodeling.zmatrix.ZMatrixAtom.setType ( String  type)

Set the type of the atom.

Parameters
typeThe type of the atom to set

Definition at line 114 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.type.

Referenced by denoptim.integration.tinker.ConformationalSearchPSSROT.setTinkerTypes(), and denoptim.molecularmodeling.zmatrix.ZMatrixAtomTest.testEquals().

Here is the caller graph for this function:

◆ toString()

◆ usesProperTorsion()

boolean denoptim.molecularmodeling.zmatrix.ZMatrixAtom.usesProperTorsion ( )

Check if the atom uses proper torsion.

Returns
True if the atom uses proper torsion, false otherwise

Definition at line 246 of file ZMatrixAtom.java.

References denoptim.molecularmodeling.zmatrix.ZMatrixAtom.chiralFlag.

Member Data Documentation

◆ angle2RefAtom

◆ angle2Value

◆ angleRefAtom

◆ angleValue

◆ bondLength

◆ bondRefAtom

◆ chiralFlag

◆ id

◆ symbol

◆ type


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