libXpertMass Developer Documentation
  • libXpertMass
  • PolChemDefEntity
  • PolChemDefEntity Class

    class MsXpS::libXpertMass::PolChemDefEntity

    The PolChemDefEntity class describes a chemical entity that belongs to a specific PolChemDef polymer chemistry definition. More...

    Header: #include <PolChemDefEntity.hpp>
    Inherited By:

    MsXpS::libXpertMass::CleaveMotif, MsXpS::libXpertMass::CleaveRule, MsXpS::libXpertMass::CleaveSpec, MsXpS::libXpertMass::CrossLinker, MsXpS::libXpertMass::FragRule, MsXpS::libXpertMass::FragSpec, MsXpS::libXpertMass::Ionizable, MsXpS::libXpertMass::Modif, and MsXpS::libXpertMass::Monomer

    Public Functions

    PolChemDefEntity(PolChemDefCstSPtr pol_chem_def_csp, const QString &name = QString("NOT_SET"))
    PolChemDefEntity(const PolChemDefEntity &other)
    virtual ~PolChemDefEntity()
    PolChemDefCstSPtr getPolChemDefCstSPtr() const
    QString name() const
    void setName(const QString &name)
    void setPolChemDefCstSPtr(PolChemDefCstSPtr pol_chem_def_csp)
    virtual bool validate() const
    virtual bool operator!=(const PolChemDefEntity &other) const
    virtual PolChemDefEntity &operator=(const PolChemDefEntity &other)
    virtual bool operator==(const PolChemDefEntity &other) const

    Protected Variables

    QString m_name
    PolChemDefCstSPtr mcsp_polChemDef

    Detailed Description

    Member Function Documentation

    PolChemDefEntity::PolChemDefEntity(PolChemDefCstSPtr pol_chem_def_csp, const QString &name = QString("NOT_SET"))

    Constructs a polymer chemistry definition entity.

    pol_chem_def_csp reference polymer chemistry definition. This pointer cannot be nullptr.

    name name of the entity.

    PolChemDefEntity::PolChemDefEntity(const PolChemDefEntity &other)

    Constructs a PolChemDefEntity instance as a copy of other.

    [virtual noexcept] PolChemDefEntity::~PolChemDefEntity()

    Destructs this PolChemDefEntity instance.

    PolChemDefCstSPtr PolChemDefEntity::getPolChemDefCstSPtr() const

    Returns the polymer chemistry definition.

    QString PolChemDefEntity::name() const

    Returns the name.

    See also setName().

    void PolChemDefEntity::setName(const QString &name)

    Sets the name.

    See also name().

    void PolChemDefEntity::setPolChemDefCstSPtr(PolChemDefCstSPtr pol_chem_def_csp)

    Sets this PolChemDefEntity's pol_chem_def_csp.

    [virtual] bool PolChemDefEntity::validate() const

    Returns true if this PolChemDef instance validates successfully, false otherwise.

    The name cannot be empty and the polymer chemistry definition cannot be nullptr.

    [virtual] bool PolChemDefEntity::operator!=(const PolChemDefEntity &other) const

    Returns true if this PolChemDefEntity instance and other differ, false otherwise.

    [virtual] PolChemDefEntity &PolChemDefEntity::operator=(const PolChemDefEntity &other)

    Assigns other to this PolChemDef instance.

    Returns a reference to this PolChemDef instance

    [virtual] bool PolChemDefEntity::operator==(const PolChemDefEntity &other) const

    Returns true if this PolChemDefEntity instance and other are identical, false otherwise.

    Member Variable Documentation

    QString PolChemDefEntity::m_name

    This variable holds the name of the chemical entity.

    PolChemDefCstSPtr PolChemDefEntity::mcsp_polChemDef

    This variable holds the polymer chemistry definition that is the context of this chemical entity.