Chemical Data Processing Library C++ API - Version 1.2.0
Public Member Functions | List of all members
CDPL::Chem::StringDataBlockEntry Class Reference

Represents a data item in the structure or reaction data block of a MDL SD- or RD-File data record (see [CTFILE]). More...

#include <StringDataBlock.hpp>

Public Member Functions

 StringDataBlockEntry ()
 Constructs a StringDataBlockEntry object with an empty data header and content. More...
 
 StringDataBlockEntry (const std::string &header, const std::string &data)
 Constructs a StringDataBlockEntry object with the specified data header and content. More...
 
const std::string & getHeader () const
 Returns the data header. More...
 
void setHeader (const std::string &header)
 Sets the data header. More...
 
const std::string & getData () const
 Returns the stored data content. More...
 
void setData (const std::string &data)
 Sets the data content. More...
 
bool operator== (const StringDataBlockEntry &entry) const
 Equality comparison operator. More...
 
bool operator!= (const StringDataBlockEntry &entry) const
 Inequality comparison operator. More...
 
bool operator< (const StringDataBlockEntry &entry) const
 
bool operator> (const StringDataBlockEntry &entry) const
 
bool operator<= (const StringDataBlockEntry &entry) const
 
bool operator>= (const StringDataBlockEntry &entry) const
 

Detailed Description

Represents a data item in the structure or reaction data block of a MDL SD- or RD-File data record (see [CTFILE]).

Constructor & Destructor Documentation

◆ StringDataBlockEntry() [1/2]

CDPL::Chem::StringDataBlockEntry::StringDataBlockEntry ( )
inline

Constructs a StringDataBlockEntry object with an empty data header and content.

◆ StringDataBlockEntry() [2/2]

CDPL::Chem::StringDataBlockEntry::StringDataBlockEntry ( const std::string &  header,
const std::string &  data 
)
inline

Constructs a StringDataBlockEntry object with the specified data header and content.

Parameters
headerThe data header.
dataThe data content.

Member Function Documentation

◆ getHeader()

const std::string& CDPL::Chem::StringDataBlockEntry::getHeader ( ) const

Returns the data header.

Returns
The data header.

◆ setHeader()

void CDPL::Chem::StringDataBlockEntry::setHeader ( const std::string &  header)

Sets the data header.

Parameters
headerThe new data header.

◆ getData()

const std::string& CDPL::Chem::StringDataBlockEntry::getData ( ) const

Returns the stored data content.

Returns
The stored data content.

◆ setData()

void CDPL::Chem::StringDataBlockEntry::setData ( const std::string &  data)

Sets the data content.

Parameters
dataThe new data content.

◆ operator==()

bool CDPL::Chem::StringDataBlockEntry::operator== ( const StringDataBlockEntry entry) const

Equality comparison operator.

Parameters
entryThe other StringDataBlockEntry object to be compared with.
Returns
true if the data entry headers and values compare equal, and false otherwise.

◆ operator!=()

bool CDPL::Chem::StringDataBlockEntry::operator!= ( const StringDataBlockEntry entry) const

Inequality comparison operator.

The result is equivalent to !(*this == entry).

Parameters
entryThe other StringDataBlockEntry object to be compared with.
Returns
true if the data headers and/or values compare non-equal, and false otherwise.
See also
operator==()

◆ operator<()

bool CDPL::Chem::StringDataBlockEntry::operator< ( const StringDataBlockEntry entry) const

◆ operator>()

bool CDPL::Chem::StringDataBlockEntry::operator> ( const StringDataBlockEntry entry) const

◆ operator<=()

bool CDPL::Chem::StringDataBlockEntry::operator<= ( const StringDataBlockEntry entry) const

◆ operator>=()

bool CDPL::Chem::StringDataBlockEntry::operator>= ( const StringDataBlockEntry entry) const

The documentation for this class was generated from the following file: