OESaltBridgeInteractionHint¶

class OESaltBridgeInteractionHint : public OEInteractionHintTypeBase

The OESaltBridgeInteractionHint class represents a built-in type that identifies interactions stored in an OEInteractionHintContainer object as intermolecular salt-bridge interactions.

See also

OESaltBridgeInteractionHintType namespace for specific salt-bridge interaction types
OEIsSaltBridgeInteractionHint predicate
OEInteractionHint class
OEInteractionHintContainer class

To perceive salt-bridge interactions:

OEPerceiveInteractionHints function
OEPerceiveInteractionOptions class and its methods:
- OEPerceiveInteractionOptions::SetMaxSaltBridgeDistance
- OEPerceiveInteractionOptions::GetExtendedSaltBridgeDistance

The following methods are publicly inherited from OEInteractionHintTypeBase:

`operator=`	`operator==`	`GetName`
`operator!=`	`CreateCopy`	`IsValid`

Constructors¶

OESaltBridgeInteractionHint(unsigned int type)

type: This value has to be from the OESaltBridgeInteractionHintType namespace.

Note

Two OESaltBridgeInteractionHint objects with different types from the OESaltBridgeInteractionHintType namespace are considered to be different.

OESaltBridgeInteractionHint(const OESaltBridgeInteractionHint &rhs)

Copy constructor.

operator=¶

OESaltBridgeInteractionHint &operator=(const OESaltBridgeInteractionHint &rhs)

Assignment operator.

CreateCopy¶

OEInteractionHintTypeBase *CreateCopy() const

Deep copy constructor that returns a copy of the object. The memory for the returned OESaltBridgeInteractionHint 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.

IsValid¶

bool IsValid(const OEInteractionHintFragment *,
             const OEInteractionHintFragment *) const

Evaluates whether the two given fragments would form a valid salt-bridge interaction when added to an OEInteractionHintContainer object.