PC_StereoTrigonalBiPyramid_.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 PC_StereoTrigonalBiPyramid_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcsubstance/pcsubstance.asn">pcsubstance.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcsubstance/pcsubstance.def">pcsubstance.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_PCSUBSTANCE_PC_STEREOTRIGONALBIPYRAMID_BASE_HPP
#define OBJECTS_PCSUBSTANCE_PC_STEREOTRIGONALBIPYRAMID_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_NCBI_PCSubstance
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Trigonal BiPyramid (TBPY-4 and TBPY-5) StereoCenters
///   [Using IUPAC Stereogenic Center recommendations and terminology]
///   [Note: "-1" can be used for the Atom Identifier to represent a lone-pair or implicit hydrogen]
///
/// CPC_StereoTrigonalBiPyramid_Base --
///
 
class NCBI_PCSUBSTANCE_EXPORT CPC_StereoTrigonalBiPyramid_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPC_StereoTrigonalBiPyramid_Base(void);
    // destructor
    virtual ~CPC_StereoTrigonalBiPyramid_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TCenter;
    typedef int TAbove;
    typedef int TBelow;
    typedef int TTop;
    typedef int TBottom;
    typedef int TRight;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_center,
        e_above,
        e_below,
        e_top,
        e_bottom,
        e_right
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// Atom ID of Atom Center
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Center data member.
    ///
    /// Data member Center is mandatory;
    /// its type is defined as 'typedef int TCenter'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCenter(void) const;
 
    /// Check if it is safe to call GetCenter method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCenter(void) const;
 
    /// Reset Center data member.
    void ResetCenter(void);
 
    /// Get the Center member data.
    ///
    /// @return
    ///   Copy of the member data.
    TCenter GetCenter(void) const;
 
    /// Assign a value to Center data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCenter(TCenter value);
 
    /// Assign a value to Center data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCenter& SetCenter(void);
 
    /// Atom ID of Atom Above the Plane
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Above data member.
    ///
    /// Data member Above is mandatory;
    /// its type is defined as 'typedef int TAbove'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAbove(void) const;
 
    /// Check if it is safe to call GetAbove method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAbove(void) const;
 
    /// Reset Above data member.
    void ResetAbove(void);
 
    /// Get the Above member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAbove GetAbove(void) const;
 
    /// Assign a value to Above data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAbove(TAbove value);
 
    /// Assign a value to Above data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAbove& SetAbove(void);
 
    /// Atom ID of Atom Below the Plane
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Below data member.
    ///
    /// Data member Below is mandatory;
    /// its type is defined as 'typedef int TBelow'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBelow(void) const;
 
    /// Check if it is safe to call GetBelow method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBelow(void) const;
 
    /// Reset Below data member.
    void ResetBelow(void);
 
    /// Get the Below member data.
    ///
    /// @return
    ///   Copy of the member data.
    TBelow GetBelow(void) const;
 
    /// Assign a value to Below data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBelow(TBelow value);
 
    /// Assign a value to Below data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBelow& SetBelow(void);
 
    /// Atom ID of Atom In-Plane and at the Top
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Top data member.
    ///
    /// Data member Top is mandatory;
    /// its type is defined as 'typedef int TTop'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTop(void) const;
 
    /// Check if it is safe to call GetTop method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTop(void) const;
 
    /// Reset Top data member.
    void ResetTop(void);
 
    /// Get the Top member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTop GetTop(void) const;
 
    /// Assign a value to Top data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTop(TTop value);
 
    /// Assign a value to Top data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTop& SetTop(void);
 
    /// Atom ID of Atom In-Plane and at the Bottom
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Bottom data member.
    ///
    /// Data member Bottom is mandatory;
    /// its type is defined as 'typedef int TBottom'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBottom(void) const;
 
    /// Check if it is safe to call GetBottom method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBottom(void) const;
 
    /// Reset Bottom data member.
    void ResetBottom(void);
 
    /// Get the Bottom member data.
    ///
    /// @return
    ///   Copy of the member data.
    TBottom GetBottom(void) const;
 
    /// Assign a value to Bottom data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBottom(TBottom value);
 
    /// Assign a value to Bottom data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBottom& SetBottom(void);
 
    /// Atom ID of Atom In-Plane and to the Right
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Right data member.
    ///
    /// Data member Right is mandatory;
    /// its type is defined as 'typedef int TRight'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRight(void) const;
 
    /// Check if it is safe to call GetRight method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRight(void) const;
 
    /// Reset Right data member.
    void ResetRight(void);
 
    /// Get the Right member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRight GetRight(void) const;
 
    /// Assign a value to Right data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRight(TRight value);
 
    /// Assign a value to Right data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRight& SetRight(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPC_StereoTrigonalBiPyramid_Base(const CPC_StereoTrigonalBiPyramid_Base&);
    CPC_StereoTrigonalBiPyramid_Base& operator=(const CPC_StereoTrigonalBiPyramid_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Center;
    int m_Above;
    int m_Below;
    int m_Top;
    int m_Bottom;
    int m_Right;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetCenter(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetCenter(void) const
{
    return IsSetCenter();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetCenter(void)
{
    m_Center = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TCenter CPC_StereoTrigonalBiPyramid_Base::GetCenter(void) const
{
    if (!CanGetCenter()) {
        ThrowUnassigned(0);
    }
    return m_Center;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetCenter(CPC_StereoTrigonalBiPyramid_Base::TCenter value)
{
    m_Center = value;
    m_set_State[0] |= 0x3;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TCenter& CPC_StereoTrigonalBiPyramid_Base::SetCenter(void)
{
#ifdef _DEBUG
    if (!IsSetCenter()) {
        memset(&m_Center,UnassignedByte(),sizeof(m_Center));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Center;
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetAbove(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetAbove(void) const
{
    return IsSetAbove();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetAbove(void)
{
    m_Above = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TAbove CPC_StereoTrigonalBiPyramid_Base::GetAbove(void) const
{
    if (!CanGetAbove()) {
        ThrowUnassigned(1);
    }
    return m_Above;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetAbove(CPC_StereoTrigonalBiPyramid_Base::TAbove value)
{
    m_Above = value;
    m_set_State[0] |= 0xc;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TAbove& CPC_StereoTrigonalBiPyramid_Base::SetAbove(void)
{
#ifdef _DEBUG
    if (!IsSetAbove()) {
        memset(&m_Above,UnassignedByte(),sizeof(m_Above));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Above;
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetBelow(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetBelow(void) const
{
    return IsSetBelow();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetBelow(void)
{
    m_Below = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TBelow CPC_StereoTrigonalBiPyramid_Base::GetBelow(void) const
{
    if (!CanGetBelow()) {
        ThrowUnassigned(2);
    }
    return m_Below;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetBelow(CPC_StereoTrigonalBiPyramid_Base::TBelow value)
{
    m_Below = value;
    m_set_State[0] |= 0x30;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TBelow& CPC_StereoTrigonalBiPyramid_Base::SetBelow(void)
{
#ifdef _DEBUG
    if (!IsSetBelow()) {
        memset(&m_Below,UnassignedByte(),sizeof(m_Below));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Below;
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetTop(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetTop(void) const
{
    return IsSetTop();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetTop(void)
{
    m_Top = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TTop CPC_StereoTrigonalBiPyramid_Base::GetTop(void) const
{
    if (!CanGetTop()) {
        ThrowUnassigned(3);
    }
    return m_Top;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetTop(CPC_StereoTrigonalBiPyramid_Base::TTop value)
{
    m_Top = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TTop& CPC_StereoTrigonalBiPyramid_Base::SetTop(void)
{
#ifdef _DEBUG
    if (!IsSetTop()) {
        memset(&m_Top,UnassignedByte(),sizeof(m_Top));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Top;
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetBottom(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetBottom(void) const
{
    return IsSetBottom();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetBottom(void)
{
    m_Bottom = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TBottom CPC_StereoTrigonalBiPyramid_Base::GetBottom(void) const
{
    if (!CanGetBottom()) {
        ThrowUnassigned(4);
    }
    return m_Bottom;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetBottom(CPC_StereoTrigonalBiPyramid_Base::TBottom value)
{
    m_Bottom = value;
    m_set_State[0] |= 0x300;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TBottom& CPC_StereoTrigonalBiPyramid_Base::SetBottom(void)
{
#ifdef _DEBUG
    if (!IsSetBottom()) {
        memset(&m_Bottom,UnassignedByte(),sizeof(m_Bottom));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Bottom;
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::IsSetRight(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CPC_StereoTrigonalBiPyramid_Base::CanGetRight(void) const
{
    return IsSetRight();
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::ResetRight(void)
{
    m_Right = 0;
    m_set_State[0] &= ~0xc00;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TRight CPC_StereoTrigonalBiPyramid_Base::GetRight(void) const
{
    if (!CanGetRight()) {
        ThrowUnassigned(5);
    }
    return m_Right;
}
 
inline
void CPC_StereoTrigonalBiPyramid_Base::SetRight(CPC_StereoTrigonalBiPyramid_Base::TRight value)
{
    m_Right = value;
    m_set_State[0] |= 0xc00;
}
 
inline
CPC_StereoTrigonalBiPyramid_Base::TRight& CPC_StereoTrigonalBiPyramid_Base::SetRight(void)
{
#ifdef _DEBUG
    if (!IsSetRight()) {
        memset(&m_Right,UnassignedByte(),sizeof(m_Right));
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Right;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_PCSUBSTANCE_PC_STEREOTRIGONALBIPYRAMID_BASE_HPP