OECreateMMPIndexStatus

Attention

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

class OECreateMMPIndexStatus

This class represents the OECreateMMPIndexStatus class that encapsulates returned status information from a matched pair indexing analysis.

See also

Constructors

OECreateMMPIndexStatus(bool valid=true)
OECreateMMPIndexStatus()

operator=

OECreateMMPIndexStatus& operator=(const OECreateMMPIndexStatus &rhs);

Assignment operator that copies the data of the ‘rhs’ OECreateMMPIndexStatus object.

operator+

OECreateMMPIndexStatus& operator+=(const OECreateMMPIndexStatus &addstatus);

Summation operator that increments the current instance based on data from the ‘addstatus’ OECreateMMPIndexStatus object.

AddIndexedMol

unsigned int AddIndexedMol()

Increment the internal count of indexed molecule records by one.

AddUnindexedMol

unsigned int AddUnindexedMol()

Increment the internal count of unindexed molecule records by one.

GetNumMatchedPairs

unsigned int GetNumMatchedPairs() const

Return the number of Matched Pairs generated from indexing.

GetNumMols

unsigned int GetNumMols() const

Return the internal count of indexed molecule records.

GetTotalMols

unsigned int GetTotalMols() const

Return the internal count of indexed plus uninindexed molecule, (i.e., total) records.

GetUnindexedMols

unsigned int GetGetUnindexedMols() const

Return the internal count of unindexed molecule records.

SetNumMatchedPairs

void SetNumMatchedPairs(unsigned int mmps)

Sets the internal count for the number of Matched Pairs generated from indexing.

SetNumMols

void SetNumMols(unsigned int indexed)

Sets the internal count of indexed molecule records to the specified value.

SetUnindexedMols

void SetUnindexedMols(unsigned int unindexed)

Sets the internal count of unindexed molecule records to the specified value.

SetValid

void SetValid(bool valid)

Sets the boolean validity of this status class.