OEInteractionHint

class OEInteractionHint : public OESystem::OEBase

The OEInteractionHint class is a container that stores a typed interaction between two fragments (OEInteractionHintFragment) of OEInteractionHintContainer object.

See also

The following built-in interaction hint types are available:

Constructors

OEInteractionHint(const OEInteractionHintContainerImpl *container,
                  const OEInteractionHintFragment *fragBgn,
                  const OEInteractionHintFragment *fragEnd,
                  const OEInteractionHintTypeBase &itype)

Constructs an OEInteractionHint object with the given parameters.

container
The OEInteractionHintContainer object the two fragments belongs to.
fragBgn, fragEnd
The two fragments of the interaction. The first fragment is going to be considered as the ‘begin’ fragment, while the second one will be the considered as the ‘end’ fragment.
type
The type of the interaction that is derived from the OEInteractionHintTypeBase abstract base class.
OEInteractionHint(const OEInteractionHint &rhs)

Copy constructor.

operator=

OEInteractionHint &operator=(const OEInteractionHint &rhs)

Assignment operator.

CreateCopy

OESystem::OEBase *CreateCopy() const

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

The returned copy should be deallocated using C++ delete operator in order to prevent a memory leak.

GetBgnFragment

const OEInteractionHintFragment *GetBgnFragment() const

Returns the ‘begin’ fragment of the interaction. The ‘begin’ fragment is defined when the interaction is constructed.

GetDataType

const void *GetDataType() const

This function is used to perform run-time type identification.

See also

GetEndFragment

const OEInteractionHintFragment *GetEndFragment() const

Returns the ‘end’ fragment of the interaction. The ‘end’ fragment is defined when the interaction is constructed.

GetFragment

const OEInteractionHintFragment *
  GetFragment(const OEInteractionHintComponentTypeBase &) const

Returns the a pointer to one fragment with the given component type. If neither the ‘begin’ nor the ‘end’ fragment has the given type the a NULL pointer will be returned.

Warning

In case of an intra-molecular interaction, the OEInteractionHint::GetFragment can return a NULL pointer, so the return value should always be checked.

See also

The following built-in component types are available:

GetInteractionType

const OEInteractionHintTypeBase &GetInteractionType() const

Returns the interaction type of the OEInteractionHint object.

GetWeight

double GetWeight() const

Returns the ‘weight’ (or score) associated with the OEInteractionHint object.

IsDataType

bool IsDataType(const void *) const

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

See also

IsInter

bool IsInter() const

Returns whether the two fragments of the OEInteractionHint object belongs to the different molecules.

IsIntra

bool IsIntra() const

Returns whether the two fragments of the OEInteractionHint object belongs to the same molecule.

IsValid

bool IsValid() const

Returns whether the OEInteractionHint object represents a valid interaction defined by the type associated with it.

SetWeight

void SetWeight(double)

Sets the ‘weight’ associated with the OEInteractionHint object.

weight
This number has to be in the range of [0.0, 1.0].