OEResidueSVGMarkupBase

Attention

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

class OEResidueSVGMarkupBase

OEResidueSVGMarkupBase is an abstract base class. Concrete class derived from this base class defines the markup of the residues in .svg images generated when calling the OERenderActiveSite function. Drawing elements representing residues in .svg image are grouped together in the following format in which the <group id> and <class name> strings can be defined in the derived concrete classes.

<g id='<group id>' class='<class name>'>
..
list of drawing elements
..
</g>

The following classes derive from this class:

CreateCopy

OEResidueSVGMarkupBase *CreateCopy() const =0

Virtual const constructor which allows copying of concrete derived objects using a reference to this base class.

GetClassName

std::string GetClassName(const OEChem::OEResidue &) const =0

Returns the <class name> associated with a specific residue group in the .svg image. This is a virtual method that has to be implemented in the concrete derived classes.

GetGroupId

std::string GetGroupId(const OEChem::OEResidue &) const =0

Returns the <group id> associated with a specific residue group in the .svg image. This is a virtual method that has to be implemented in the concrete derived classes.