PC_Coordinates_.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_Coordinates_.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_COORDINATES_BASE_HPP
#define OBJECTS_PCSUBSTANCE_PC_COORDINATES_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <vector>
#include <objects/pcsubstance/PC_CoordinateType.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::
 
 
// forward declarations
class CPC_AtomString;
class CPC_Conformer;
class CPC_InfoData;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_PCSubstance
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Coordinates for the Compound of a given type
///
/// CPC_Coordinates_Base --
///
 
class NCBI_PCSUBSTANCE_EXPORT CPC_Coordinates_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPC_Coordinates_Base(void);
    // destructor
    virtual ~CPC_Coordinates_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef vector< int > TType;
    typedef vector< int > TAid;
    typedef list< CRef< CPC_Conformer > > TConformers;
    typedef list< CRef< CPC_AtomString > > TAtomlabels;
    typedef list< CRef< CPC_InfoData > > TData;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_type,
        e_aid,
        e_conformers,
        e_atomlabels,
        e_data
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// Coordinate Type Information (vector)
    /// Check if a value has been assigned to Type data member.
    ///
    /// Data member Type is mandatory;
    /// its type is defined as 'typedef vector< int > TType'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetType(void) const;
 
    /// Check if it is safe to call GetType method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetType(void) const;
 
    /// Reset Type data member.
    void ResetType(void);
 
    /// Get the Type member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TType& GetType(void) const;
 
    /// Assign a value to Type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TType& SetType(void);
 
    /// Conformer Atom IDs (vector)
    ///   (to be kept synchronized with Conformers)
    ///   Note: Atom ID's must be greater than "0"
    /// Check if a value has been assigned to Aid data member.
    ///
    /// Data member Aid is mandatory;
    /// its type is defined as 'typedef vector< int > TAid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAid(void) const;
 
    /// Check if it is safe to call GetAid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAid(void) const;
 
    /// Reset Aid data member.
    void ResetAid(void);
 
    /// Get the Aid member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAid& GetAid(void) const;
 
    /// Assign a value to Aid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAid& SetAid(void);
 
    /// Conformers for this Coordinate Set
    /// Check if a value has been assigned to Conformers data member.
    ///
    /// Data member Conformers is optional;
    /// its type is defined as 'typedef list< CRef< CPC_Conformer > > TConformers'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetConformers(void) const;
 
    /// Check if it is safe to call GetConformers method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetConformers(void) const;
 
    /// Reset Conformers data member.
    void ResetConformers(void);
 
    /// Get the Conformers member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TConformers& GetConformers(void) const;
 
    /// Assign a value to Conformers data member.
    ///
    /// @return
    ///   Reference to the data value.
    TConformers& SetConformers(void);
 
    /// Atom labels for Conformer Set
    /// Check if a value has been assigned to Atomlabels data member.
    ///
    /// Data member Atomlabels is optional;
    /// its type is defined as 'typedef list< CRef< CPC_AtomString > > TAtomlabels'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAtomlabels(void) const;
 
    /// Check if it is safe to call GetAtomlabels method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAtomlabels(void) const;
 
    /// Reset Atomlabels data member.
    void ResetAtomlabels(void);
 
    /// Get the Atomlabels member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAtomlabels& GetAtomlabels(void) const;
 
    /// Assign a value to Atomlabels data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAtomlabels& SetAtomlabels(void);
 
    /// Data Associated with these Coordinates
    /// Check if a value has been assigned to Data data member.
    ///
    /// Data member Data is optional;
    /// its type is defined as 'typedef list< CRef< CPC_InfoData > > TData'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetData(void) const;
 
    /// Check if it is safe to call GetData method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetData(void) const;
 
    /// Reset Data data member.
    void ResetData(void);
 
    /// Get the Data member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TData& GetData(void) const;
 
    /// Assign a value to Data data member.
    ///
    /// @return
    ///   Reference to the data value.
    TData& SetData(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPC_Coordinates_Base(const CPC_Coordinates_Base&);
    CPC_Coordinates_Base& operator=(const CPC_Coordinates_Base&);
 
    // data
    Uint4 m_set_State[1];
    vector< int > m_Type;
    vector< int > m_Aid;
    list< CRef< CPC_Conformer > > m_Conformers;
    list< CRef< CPC_AtomString > > m_Atomlabels;
    list< CRef< CPC_InfoData > > m_Data;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPC_Coordinates_Base::IsSetType(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPC_Coordinates_Base::CanGetType(void) const
{
    return true;
}
 
inline
const CPC_Coordinates_Base::TType& CPC_Coordinates_Base::GetType(void) const
{
    return m_Type;
}
 
inline
CPC_Coordinates_Base::TType& CPC_Coordinates_Base::SetType(void)
{
    m_set_State[0] |= 0x1;
    return m_Type;
}
 
inline
bool CPC_Coordinates_Base::IsSetAid(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPC_Coordinates_Base::CanGetAid(void) const
{
    return true;
}
 
inline
const CPC_Coordinates_Base::TAid& CPC_Coordinates_Base::GetAid(void) const
{
    return m_Aid;
}
 
inline
CPC_Coordinates_Base::TAid& CPC_Coordinates_Base::SetAid(void)
{
    m_set_State[0] |= 0x4;
    return m_Aid;
}
 
inline
bool CPC_Coordinates_Base::IsSetConformers(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CPC_Coordinates_Base::CanGetConformers(void) const
{
    return true;
}
 
inline
const CPC_Coordinates_Base::TConformers& CPC_Coordinates_Base::GetConformers(void) const
{
    return m_Conformers;
}
 
inline
CPC_Coordinates_Base::TConformers& CPC_Coordinates_Base::SetConformers(void)
{
    m_set_State[0] |= 0x10;
    return m_Conformers;
}
 
inline
bool CPC_Coordinates_Base::IsSetAtomlabels(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CPC_Coordinates_Base::CanGetAtomlabels(void) const
{
    return true;
}
 
inline
const CPC_Coordinates_Base::TAtomlabels& CPC_Coordinates_Base::GetAtomlabels(void) const
{
    return m_Atomlabels;
}
 
inline
CPC_Coordinates_Base::TAtomlabels& CPC_Coordinates_Base::SetAtomlabels(void)
{
    m_set_State[0] |= 0x40;
    return m_Atomlabels;
}
 
inline
bool CPC_Coordinates_Base::IsSetData(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CPC_Coordinates_Base::CanGetData(void) const
{
    return true;
}
 
inline
const CPC_Coordinates_Base::TData& CPC_Coordinates_Base::GetData(void) const
{
    return m_Data;
}
 
inline
CPC_Coordinates_Base::TData& CPC_Coordinates_Base::SetData(void)
{
    m_set_State[0] |= 0x100;
    return m_Data;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_PCSUBSTANCE_PC_COORDINATES_BASE_HPP