OEDesignUnitEnumerateSitesOptions

Attention

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

class OEDesignUnitEnumerateSitesOptions

This class stores the optional parameter sets for design unit binding site enumeration for use in the OEEnumerateSites function.

Constructors

OEDesignUnitEnumerateSitesOptions()=default
OEDesignUnitEnumerateSitesOptions(const OEDesignUnitEnumerateSitesOptions &)=default

Default and copy constructor that constructs a OEDesignUnitEnumerateSitesOptions object.

operator=

OEDesignUnitEnumerateSitesOptions &
  operator=(const OEDesignUnitEnumerateSitesOptions &)=default

Assignment operator.

GetAddInteractionHints

bool GetAddInteractionHints() const

Returns the boolean whether or not to add interaction hints.

GetAddStyle

bool GetAddStyle() const

Returns the boolean whether or not to add style.

GetCollapseNonSiteAlts

bool GetCollapseNonSiteAlts() const

Returns the boolean whether or not to collapse non site alternate locations.

GetDuplicateRemoval

bool GetDuplicateRemoval() const

Returns the boolean whether or not to remove duplicate sites.

GetEnumerateCofactorSites

bool GetEnumerateCofactorSites() const

Returns the boolean whether or not to enumerate cofactor sites.

GetRestrictToRefSite

bool GetRestrictToRefSite() const

Returns the boolean whether or not to restrict enumeration to the site of the reference structure.

GetSiteSize

double GetSiteSize() const

Returns the size of the site.

SetAddInteractionHints

void SetAddInteractionHints(bool addInteractions)

Sets the boolean whether or not to add interactions.

SetAddStyle

void SetAddStyle(bool addStyle)

Sets the boolean whether or not to add style.

SetCollapseNonSiteAlts

void SetCollapseNonSiteAlts(bool collapseNonSiteAlts)

Sets the boolean whether or not to collapse non site alternate locations.

SetDuplicateRemoval

void SetDuplicateRemoval(bool duplicateRemoval)

Sets the boolean whether or not to remove duplicate sites.

SetEnumerateCofactorSites

void SetEnumerateCofactorSites(bool enumCofactorSites)

Sets the boolean whether or not to enumerate cofactor sites.

SetRestrictToRefSite

void SetRestrictToRefSite(bool restrictToRefSite)

Sets the boolean whether or not to restrict enumeration to the reference site.

SetSiteSize

void SetSiteSize(double siteSize)

Sets the size of the site.