Affected_channel_.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/* $Id$
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 */
 
/// @file Affected_channel_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.xsd">pepXML.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.def">pepXML.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef ALGO_MS_FORMATS_PEPXML_AFFECTED_CHANNEL_BASE_HPP
#define ALGO_MS_FORMATS_PEPXML_AFFECTED_CHANNEL_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
BEGIN_NCBI_SCOPE
 
#ifndef BEGIN_objects_SCOPE
#  define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
#  define END_objects_SCOPE END_SCOPE(objects)
#endif
BEGIN_objects_SCOPE // namespace ncbi::objects::
 
 
// generated classes
 
 
/** @addtogroup dataspec_pepXML
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// ============================================ 
/// This section is mapped from module "pepXML"
///================================================= 
///channel recipient 
///
/// CAffected_channel_Base --
///
 
class NCBI_PEPXML_EXPORT CAffected_channel_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CAffected_channel_Base(void);
    // destructor
    virtual ~CAffected_channel_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class NCBI_PEPXML_EXPORT C_Attlist : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef int TChannel;
        typedef double TCorrection;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_channel,
            e_correction
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Channel data member.
        ///
        /// Data member Channel is mandatory;
        /// its type is defined as 'typedef int TChannel'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetChannel(void) const;
    
        /// Check if it is safe to call GetChannel method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetChannel(void) const;
    
        /// Reset Channel data member.
        void ResetChannel(void);
    
        /// Get the Channel member data.
        ///
        /// @return
        ///   Copy of the member data.
        TChannel GetChannel(void) const;
    
        /// Assign a value to Channel data member.
        ///
        /// @param value
        ///   Value to assign
        void SetChannel(TChannel value);
    
        /// Assign a value to Channel data member.
        ///
        /// @return
        ///   Reference to the data value.
        TChannel& SetChannel(void);
    
        /// Check if a value has been assigned to Correction data member.
        ///
        /// Data member Correction is mandatory;
        /// its type is defined as 'typedef double TCorrection'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetCorrection(void) const;
    
        /// Check if it is safe to call GetCorrection method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetCorrection(void) const;
    
        /// Reset Correction data member.
        void ResetCorrection(void);
    
        /// Get the Correction member data.
        ///
        /// @return
        ///   Copy of the member data.
        TCorrection GetCorrection(void) const;
    
        /// Assign a value to Correction data member.
        ///
        /// @param value
        ///   Value to assign
        void SetCorrection(TCorrection value);
    
        /// Assign a value to Correction data member.
        ///
        /// @return
        ///   Reference to the data value.
        TCorrection& SetCorrection(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Attlist(const C_Attlist&);
        C_Attlist& operator=(const C_Attlist&);
    
        // data
        Uint4 m_set_State[1];
        int m_Channel;
        double m_Correction;
    };
    // types
    typedef C_Attlist TAttlist;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_affected_channel
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Attlist data member.
    ///
    /// Data member Attlist is mandatory;
    /// its type is defined as 'typedef C_Attlist TAttlist'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttlist(void) const;
 
    /// Check if it is safe to call GetAttlist method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttlist(void) const;
 
    /// Reset Attlist data member.
    void ResetAttlist(void);
 
    /// Get the Attlist member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttlist& GetAttlist(void) const;
 
    /// Assign a value to Attlist data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttlist(TAttlist& value);
 
    /// Assign a value to Attlist data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttlist& SetAttlist(void);
 
    /// Check if a value has been assigned to Affected_channel data member.
    ///
    /// Data member Affected_channel is mandatory
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAffected_channel(void) const;
 
    /// Check if value of Affected_channel member is getatable.
    ///
    /// @return
    ///   - false; the data member of type 'NULL' has no value.
    bool CanGetAffected_channel(void) const;
 
    /// Reset Affected_channel data member.
    void ResetAffected_channel(void);
 
    /// Set NULL data member (assign 'NULL' value to Affected_channel data member).
    void SetAffected_channel(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CAffected_channel_Base(const CAffected_channel_Base&);
    CAffected_channel_Base& operator=(const CAffected_channel_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CAffected_channel_Base::C_Attlist::IsSetChannel(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CAffected_channel_Base::C_Attlist::CanGetChannel(void) const
{
    return IsSetChannel();
}
 
inline
void CAffected_channel_Base::C_Attlist::ResetChannel(void)
{
    m_Channel = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CAffected_channel_Base::C_Attlist::TChannel CAffected_channel_Base::C_Attlist::GetChannel(void) const
{
    if (!CanGetChannel()) {
        ThrowUnassigned(0);
    }
    return m_Channel;
}
 
inline
void CAffected_channel_Base::C_Attlist::SetChannel(CAffected_channel_Base::C_Attlist::TChannel value)
{
    m_Channel = value;
    m_set_State[0] |= 0x3;
}
 
inline
CAffected_channel_Base::C_Attlist::TChannel& CAffected_channel_Base::C_Attlist::SetChannel(void)
{
#ifdef _DEBUG
    if (!IsSetChannel()) {
        memset(&m_Channel,UnassignedByte(),sizeof(m_Channel));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Channel;
}
 
inline
bool CAffected_channel_Base::C_Attlist::IsSetCorrection(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAffected_channel_Base::C_Attlist::CanGetCorrection(void) const
{
    return IsSetCorrection();
}
 
inline
void CAffected_channel_Base::C_Attlist::ResetCorrection(void)
{
    m_Correction = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CAffected_channel_Base::C_Attlist::TCorrection CAffected_channel_Base::C_Attlist::GetCorrection(void) const
{
    if (!CanGetCorrection()) {
        ThrowUnassigned(1);
    }
    return m_Correction;
}
 
inline
void CAffected_channel_Base::C_Attlist::SetCorrection(CAffected_channel_Base::C_Attlist::TCorrection value)
{
    m_Correction = value;
    m_set_State[0] |= 0xc;
}
 
inline
CAffected_channel_Base::C_Attlist::TCorrection& CAffected_channel_Base::C_Attlist::SetCorrection(void)
{
#ifdef _DEBUG
    if (!IsSetCorrection()) {
        memset(&m_Correction,UnassignedByte(),sizeof(m_Correction));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Correction;
}
 
inline
bool CAffected_channel_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CAffected_channel_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CAffected_channel_Base::TAttlist& CAffected_channel_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CAffected_channel_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CAffected_channel_Base::TAttlist& CAffected_channel_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    SetAffected_channel();
    return (*m_Attlist);
}
 
inline
bool CAffected_channel_Base::IsSetAffected_channel(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAffected_channel_Base::CanGetAffected_channel(void) const
{
    return false;
}
 
inline
void CAffected_channel_Base::ResetAffected_channel(void)
{
    m_set_State[0] &= ~0xc;
}
 
inline
void CAffected_channel_Base::SetAffected_channel(void)
{
    m_set_State[0] |= 0xc;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_MS_FORMATS_PEPXML_AFFECTED_CHANNEL_BASE_HPP