SubObjectSelector_.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 SubObjectSelector_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/linkout/linkout.dtd">linkout.dtd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/linkout/linkout.def">linkout.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef linkout__OBJTOOLS_EUTILS_LINKOUT_SUBOBJECTSELECTOR_BASE_HPP
#define linkout__OBJTOOLS_EUTILS_LINKOUT_SUBOBJECTSELECTOR_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
#ifndef BEGIN_linkout_SCOPE
#  define BEGIN_linkout_SCOPE BEGIN_SCOPE(linkout)
#  define END_linkout_SCOPE END_SCOPE(linkout)
#endif
BEGIN_linkout_SCOPE // namespace linkout::
 
 
// forward declarations
class CSubProvider;
 
 
// generated classes
 
 
/** @addtogroup dataspec_linkout
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// End of ObjectList group 
/// End of ObjectSelector group 
/// Libraries must use SubObjectSelector to refer to the sub providers 
///
/// CSubObjectSelector_Base --
///
 
class NCBI_EUTILS_EXPORT CSubObjectSelector_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CSubObjectSelector_Base(void);
    // destructor
    virtual ~CSubObjectSelector_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef NCBI_NS_STD::string TDatabase;
    typedef CSubProvider TSubProvider;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Database,
        e_SubProvider
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Database data member.
    ///
    /// Data member Database is mandatory;
    /// its type is defined as 'typedef NCBI_NS_STD::string TDatabase'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDatabase(void) const;
 
    /// Check if it is safe to call GetDatabase method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDatabase(void) const;
 
    /// Reset Database data member.
    void ResetDatabase(void);
 
    /// Get the Database member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDatabase& GetDatabase(void) const;
 
    /// Assign a value to Database data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDatabase(const TDatabase& value);
    void SetDatabase(TDatabase&& value);
 
    /// Assign a value to Database data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDatabase& SetDatabase(void);
 
    /// Check if a value has been assigned to SubProvider data member.
    ///
    /// Data member SubProvider is mandatory;
    /// its type is defined as 'typedef CSubProvider TSubProvider'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubProvider(void) const;
 
    /// Check if it is safe to call GetSubProvider method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubProvider(void) const;
 
    /// Reset SubProvider data member.
    void ResetSubProvider(void);
 
    /// Get the SubProvider member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSubProvider& GetSubProvider(void) const;
 
    /// Assign a value to SubProvider data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSubProvider(TSubProvider& value);
 
    /// Assign a value to SubProvider data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubProvider& SetSubProvider(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CSubObjectSelector_Base(const CSubObjectSelector_Base&);
    CSubObjectSelector_Base& operator=(const CSubObjectSelector_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_STD::string m_Database;
    NCBI_NS_NCBI::CRef< TSubProvider > m_SubProvider;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CSubObjectSelector_Base::IsSetDatabase(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CSubObjectSelector_Base::CanGetDatabase(void) const
{
    return IsSetDatabase();
}
 
inline
const CSubObjectSelector_Base::TDatabase& CSubObjectSelector_Base::GetDatabase(void) const
{
    if (!CanGetDatabase()) {
        ThrowUnassigned(0);
    }
    return m_Database;
}
 
inline
void CSubObjectSelector_Base::SetDatabase(const CSubObjectSelector_Base::TDatabase& value)
{
    m_Database = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CSubObjectSelector_Base::SetDatabase(CSubObjectSelector_Base::TDatabase&& value)
{
    m_Database = std::forward<CSubObjectSelector_Base::TDatabase>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CSubObjectSelector_Base::TDatabase& CSubObjectSelector_Base::SetDatabase(void)
{
#ifdef _DEBUG
    if (!IsSetDatabase()) {
        m_Database = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Database;
}
 
inline
bool CSubObjectSelector_Base::IsSetSubProvider(void) const
{
    return m_SubProvider.NotEmpty();
}
 
inline
bool CSubObjectSelector_Base::CanGetSubProvider(void) const
{
    return true;
}
 
inline
const CSubObjectSelector_Base::TSubProvider& CSubObjectSelector_Base::GetSubProvider(void) const
{
    if ( !m_SubProvider ) {
        const_cast<CSubObjectSelector_Base*>(this)->ResetSubProvider();
    }
    return (*m_SubProvider);
}
 
inline
CSubObjectSelector_Base::TSubProvider& CSubObjectSelector_Base::SetSubProvider(void)
{
    if ( !m_SubProvider ) {
        ResetSubProvider();
    }
    return (*m_SubProvider);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_linkout_SCOPE // namespace linkout::
 
 
#endif // linkout__OBJTOOLS_EUTILS_LINKOUT_SUBOBJECTSELECTOR_BASE_HPP