Enum grafen::database::ComponentEntry

pub enum ComponentEntry {
    VolumeCuboid(Cuboid),
    VolumeCylinder(Cylinder),
    SurfaceSheet(Sheet),
    SurfaceCylinder(Cylinder),
}

Wrapper for accessing a shared interface from different components constructors.

Variants

VolumeCuboid(Cuboid)VolumeCylinder(Cylinder)SurfaceSheet(Sheet)SurfaceCylinder(Cylinder)

Methods

impl<'a> ComponentEntry

fn get_coords(&'a self) -> &Vec<Coord>

Get a reference to the coordinates of the component.

fn get_coords_mut(&'a mut self) -> &mut Vec<Coord>

Get a mutable reference to the coordinates of the component.

fn get_origin(&self) -> Coord

fn get_residue(&'a self) -> &'a Option<Residue>

Get a reference to the component's optional Residue.

Trait Implementations

impl Clone for ComponentEntry

fn clone(&self) -> ComponentEntry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ComponentEntry

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Describe for ComponentEntry

fn describe(&self) -> String

Return a descriptive String of the object.

fn describe_short(&self) -> String

Return a very short descriptive String of the object. Typically just a name or type.

impl<'a> Component<'a> for ComponentEntry

fn box_size(&self) -> Coord

Return the size of the object's bounding box seen from origo.

fn iter_atoms(&'a self) -> AtomIterItem

Return an Iterator over all atoms in the object as CurrentAtom objects.

fn num_atoms(&self) -> u64

Return the number of atoms in the object.

fn with_pbc(self) -> Self

Return the component with its coordinates adjusted to lie within its box.

impl Translate for ComponentEntry

fn translate(self, coord: Coord) -> Self

fn translate_in_place(&mut self, coord: Coord)

impl From<Cuboid> for ComponentEntry

fn from(object: Cuboid) -> ComponentEntry

Performs the conversion.

impl From<Cylinder> for ComponentEntry

fn from(object: Cylinder) -> ComponentEntry

Performs the conversion.

impl From<Sheet> for ComponentEntry

fn from(object: Sheet) -> ComponentEntry

Performs the conversion.

impl From<Cylinder> for ComponentEntry

fn from(object: Cylinder) -> ComponentEntry

Performs the conversion.