OEDesignUnit

Attention

PRELIMINARY-IMAGE This is a preliminary API until 2020.Apr and may be improved based on user feedback. It is currently available in C++ and Python.

class OEDesignUnit : public OESystem::OEBase

This is a container class derived from OEBase that holds all molecules needed to construct a model-ready biomolecular system.

Constructors

OEDesignUnit()

Default constructor.

OEDesignUnit(const OEDesignUnit &rhs)

Copy constructor.

operator=

OEDesignUnit &operator=(const OEDesignUnit &rhs)

Assignment operator.

operator bool

operator bool() const

Returns whether the OEDesignUnit object is valid.

Clear

void Clear()

Resets the OEDesignUnit object to its initial state. This method deletes all internally stored molecules, and clears any OEBase data from the object.

CreateCopy

OEBio::OEDesignUnit *CreateCopy() const

Deep copy constructor that returns a copy of the object. The memory for the returned OEDesignUnit object is dynamically allocated and owned by the caller.

GetComponent

const OEChem::OEMolBase &GetComponent(unsigned componentID) const

Returns a const reference to the molecule on the OEDesignUnit that is associated with the input componentID.

GetComponentID

unsigned GetComponentID(const std::string &componentTag) const

Returns the internal unsigned integer representation of the componentTag string from the OEDesignUnit object.

GetComponentTag

std::string GetComponentTag(unsigned componentID) const

Returns the string tag representation of the componentID unsigned integer from the OEDesignUnit object.

GetComponents

bool GetComponents(OEChem::OEMolBase &mol, unsigned componentMask,
                   bool bondCovalent=true) const

The function creates a single output mol from the components given in the componentMask bit mask. The bit mask can be constructed using unsigned integers stored in the OEDesignUnitComponents namespace. The function returns a boolean value to alert if the operation was successful.

GetComponentsWithin

bool GetComponentsWithin(OEChem::OEMolBase &mol,
                         unsigned componentMask=OEDesignUnitComponents::Solvent,
                         unsigned withinMask=OEDesignUnitComponents::Protein,
                         double dist=5.0, bool bondCovalent=true) const

The function creates a single output mol from the components given in the componentMask bit mask that fall within a dist distance of components given in the withinMask bit mask. All bit masks can be constructed using unsigned integers stored in the OEDesignUnitComponents namespace. If the boolean bondCovalent flag is set, all components that should be covalently bonded will have bonded added in the output mol. The function returns a boolean value to alert if the operation was successful.

GetDataType

const void *GetDataType() const

This pure virtual function is used to perform run-time type identification. The value returned by the method should be equivalent to the value returned by OEGetDataType using the OEDesignUnit derived class type as the template argument.

GetIDs

const std::vector<unsigned> GetIDs() const

Returns a vector of the component IDs stored on the OEDesignUnit object.

GetLigand

const OEChem::OEMolBase &GetLigand() const

Returns a const reference to the ligand molecule on the OEDesignUnit object.

GetNucleicAcid

const OEChem::OEMolBase &GetNucleicAcid() const

Returns a const reference to the nucleic acid molecule on the OEDesignUnit object.

GetPackingResidues

const OEChem::OEMolBase &GetPackingResidues() const

Returns a const reference to the packing residue molecule on the OEDesignUnit object.

GetProtein

const OEChem::OEMolBase &GetProtein() const

Returns a const reference to the protein molecule on the OEDesignUnit object.

GetSiteResidues

const std::vector<std::string> GetSiteResidues() const

Returns a vector of the site residue strings stored on the OEDesignUnit object.

GetSolvent

const OEChem::OEMolBase &GetSolvent() const

Returns a const reference to the solvent molecule on the OEDesignUnit object.

GetStructureQuality

const OEBio::OEStructureQuality &GetStructureQuality() const

Returns the OEStructureQuality class stored on the OEDesignUnit object.

See also

GetTaggedComponents

OESystem::OEIterBase<std::pair<std::string, const OEChem::OEMolBase &> > *
  GetTaggedComponents(unsigned componentMask) const

Returns an OEIter of all molecules and corresponding molecular tags stored on the OEDesignUnit object. A bit mask of desired components can be constructed from constants in the OEDesignUnitComponents namespace and be passed in via the componentMask argument.

GetTags

const std::vector<std::string> GetTags() const

Returns a vector of the tags of the molecules stored on the OEDesignUnit object.

GetTarget

const OEChem::OEMolBase &GetTarget() const

Returns a const reference to target molecule on the OEDesignUnit object.

GetTargetComponentID

unsigned GetTargetComponentID() const

Returns the component ID from the OEDesignUnitComponents namespace of the target molecule on the OEDesignUnit object.

GetTargetComponentTag

std::string GetTargetComponentTag() const

Returns the string tag of the title of the OEDesignUnit object.

GetTitle

std::string GetTitle() const

Returns the title of the OEDesignUnit object.

HasAltLoc

bool HasAltLoc() const

Checks that the alternate locations flag on the OEDesignUnit object has been set.

HasComponent

bool HasComponent(unsigned componentID) const

Checks that a molecule given by the componentID from the OEDesignUnitComponents namespace has been set on the OEDesignUnit object.

HasLigand

bool HasLigand() const

Checks that the ligand molecule of the OEDesignUnit object has been set.

HasMetal

bool HasMetal() const

Checks that the metal molecule of the OEDesignUnit object has been set.

HasNucleicAcid

bool HasNucleicAcid() const

Checks that the nucleic acid molecule of the OEDesignUnit object has been set.

HasPackingResidues

bool HasPackingResidues() const

Checks that the packing residue molecule of the OEDesignUnit object has been set.

HasProtein

bool HasProtein() const

Checks that the protein molecule of the OEDesignUnit object has been set.

HasSiteResidues

bool HasSiteResidues() const

Checks that the site residues of the OEDesignUnit object has been set.

HasSolvent

bool HasSolvent() const

Checks that the solvent molecule of the OEDesignUnit object has been set.

HasStructureQuality

bool HasStructureQuality() const

Checks that the internal OEStructureQuality object stored on the OEDesignUnit has been set.

HasTarget

bool HasTarget() const

Checks that the target molecule of the OEDesignUnit object has been set.

HasTitle

bool HasTitle() const

Checks that a title of the OEDesignUnit object has been set.

IsDataType

bool IsDataType(const void *) const

Returns whether the type is the same as the instance this method is called on.

SetTitle

bool SetTitle(const std::string &title)

Sets the title of the OEDesignUnit object.