module Chem::AtomCollection

Direct including types

Defined in:

chem/core/atom_collection.cr
chem/register_format.cr

Instance Method Summary

Instance Method Detail

def atoms : AtomView #

[View source]
def bonds : Array(Bond) #

[View source]

[View source]
def coords=(coords : Enumerable(Spatial::Vec3)) : Enumerable(Spatial::Vec3) #

Sets the atom coordinates.


[View source]
abstract def each_atom : Iterator(Atom) #

[View source]
abstract def each_atom(&block : Atom -> ) #

[View source]
def each_fragment(& : AtomView -> ) : Nil #

[View source]
def formal_charge : Int32 #

[View source]
def formal_charges : Array(Int32) #

[View source]
def fragments : Array(AtomView) #

[View source]
def has_hydrogens? : Bool #

[View source]
abstract def n_atoms : Int32 #

[View source]
def to_gen(fractional : Bool = false) : String #

Returns a string representation of the atom collection using the Chem::Gen file format. Arguments are fowarded to Chem::Gen::Writer.open.


[View source]
def to_gen(output : IO | Path | String, fractional : Bool = false) : Nil #

Writes the atom collection to output using the Chem::Gen file format. Arguments are fowarded to Chem::Gen::Writer.open.


[View source]
def to_mol2(output : IO | Path | String) : Nil #

Writes the atom collection to output using the Chem::Mol2 file format. Arguments are fowarded to Chem::Mol2::Writer.open.


[View source]
def to_mol2 : String #

Returns a string representation of the atom collection using the Chem::Mol2 file format. Arguments are fowarded to Chem::Mol2::Writer.open.


[View source]
def to_pdb(bonds : Chem::PDB::Writer::BondOptions = Chem::PDB::Writer::BondOptions.flags(Het, Disulfide), renumber : Bool = true, ter_on_fragment : Bool = false) : String #

Returns a string representation of the atom collection using the Chem::PDB file format. Arguments are fowarded to Chem::PDB::Writer.open.


[View source]
def to_pdb(output : IO | Path | String, bonds : Chem::PDB::Writer::BondOptions = Chem::PDB::Writer::BondOptions.flags(Het, Disulfide), renumber : Bool = true, ter_on_fragment : Bool = false) : Nil #

Writes the atom collection to output using the Chem::PDB file format. Arguments are fowarded to Chem::PDB::Writer.open.


[View source]
def to_xyz(extended : Bool = false, fields : Array(String) = [] of String) : String #

Returns a string representation of the atom collection using the Chem::XYZ file format. Arguments are fowarded to Chem::XYZ::Writer.open.


[View source]
def to_xyz(output : IO | Path | String, extended : Bool = false, fields : Array(String) = [] of String) : Nil #

Writes the atom collection to output using the Chem::XYZ file format. Arguments are fowarded to Chem::XYZ::Writer.open.


[View source]
def write(output : IO | Path | String, format : Chem::Format | String) : Nil #

Writes the atom collection to output using format. Raises ArgumentError if format has required arguments or cannot write Chem::AtomCollection.

The supported file formats are Chem::Gen, Chem::Mol2, Chem::PDB, Chem::XYZ. Use the #to_* methods to customize how the object is written in the corresponding file format if possible.


[View source]
def write(path : Path | String) : Nil #

Writes the atom collection to the specified file. The file format is chosen based on the filename (see Chem::Format#from_filename). Raises ArgumentError if the file format cannot be determined.

The supported file formats are the following:

Use the #to_* methods to customize how the object is written in the corresponding file format if possible.


[View source]