Id_pat_.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 Id_pat_.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/biblio/biblio.asn">biblio.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/biblio/biblio.def">biblio.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_BIBLIO_ID_PAT_BASE_HPP
#define OBJECTS_BIBLIO_ID_PAT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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_Biblio
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// just to identify a patent
///
/// CId_pat_Base --
///
 
class NCBI_BIBLIO_EXPORT CId_pat_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CId_pat_Base(void);
    // destructor
    virtual ~CId_pat_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Id --
    ///
    
    class NCBI_BIBLIO_EXPORT C_Id : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Id(void);
        // destructor
        ~C_Id(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    
        /// Choice variants.
        enum E_Choice {
            e_not_set = 0,  ///< No variant selected
            e_Number,       ///< Patent Document Number
            e_App_number    ///< Patent Doc Appl Number
        };
        /// Maximum+1 value of the choice variant enumerator.
        enum E_ChoiceStopper {
            e_MaxChoice = 3 ///< == e_App_number+1
        };
    
        /// Reset the whole object
        void Reset(void);
    
        /// Reset the selection (set it to e_not_set).
        void ResetSelection(void);
    
        /// Which variant is currently selected.
        ///
        /// @return
        ///   Choice state enumerator.
        E_Choice Which(void) const;
    
        /// Verify selection, throw exception if it differs from the expected.
        ///
        /// @param index
        ///   Expected selection.
        void CheckSelected(E_Choice index) const;
    
        /// Throw 'InvalidSelection' exception.
        ///
        /// @param index
        ///   Expected selection.
        NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
    
        /// Retrieve selection name (for diagnostic purposes).
        ///
        /// @param index
        ///   One of possible selection states.
        /// @return
        ///   Name string.
        static string SelectionName(E_Choice index);
    
        /// Select the requested variant if needed.
        ///
        /// @param index
        ///   New selection state.
        /// @param reset
        ///   Flag that defines the resetting of the variant data. The data will
        ///   be reset if either the current selection differs from the new one,
        ///   or the flag is set to eDoResetVariant.
        void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
        /// Select the requested variant if needed,
        /// allocating CObject variants from memory pool.
        void Select(E_Choice index,
                    EResetVariant reset,
                    CObjectMemoryPool* pool);
    
        // types
        typedef string TNumber;
        typedef string TApp_number;
    
        // getters
        // setters
    
    
        /// Check if variant Number is selected.
        ///
        /// Number type is defined as 'typedef string TNumber'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsNumber(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TNumber& GetNumber(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TNumber& SetNumber(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetNumber(const TNumber& value);
    
    
        /// Check if variant App_number is selected.
        ///
        /// App_number type is defined as 'typedef string TApp_number'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsApp_number(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TApp_number& GetApp_number(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TApp_number& SetApp_number(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void SetApp_number(const TApp_number& value);
    
    
    private:
        // copy constructor and assignment operator
        C_Id(const C_Id& );
        C_Id& operator=(const C_Id& );
        // choice state
        E_Choice m_choice;
        // helper methods
        void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
    
        static const char* const sm_SelectionNames[];
        // data
        union {
            NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
            void* m_dummy_pointer_for_alignment;
        };
    };
    // types
    typedef string TCountry;
    typedef C_Id TId;
    typedef string TDoc_type;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_country,
        e_id,
        e_doc_type
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Patent Document Country
    /// Check if a value has been assigned to Country data member.
    ///
    /// Data member Country is mandatory;
    /// its type is defined as 'typedef string TCountry'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCountry(void) const;
 
    /// Check if it is safe to call GetCountry method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCountry(void) const;
 
    /// Reset Country data member.
    void ResetCountry(void);
 
    /// Get the Country member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCountry& GetCountry(void) const;
 
    /// Assign a value to Country data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCountry(const TCountry& value);
    void SetCountry(TCountry&& value);
 
    /// Assign a value to Country data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCountry& SetCountry(void);
 
    /// Check if a value has been assigned to Id data member.
    ///
    /// Data member Id is mandatory;
    /// its type is defined as 'typedef C_Id TId'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetId(void) const;
 
    /// Check if it is safe to call GetId method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetId(void) const;
 
    /// Reset Id data member.
    void ResetId(void);
 
    /// Get the Id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TId& GetId(void) const;
 
    /// Assign a value to Id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetId(TId& value);
 
    /// Assign a value to Id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TId& SetId(void);
 
    /// Patent Doc Type
    /// Check if a value has been assigned to Doc_type data member.
    ///
    /// Data member Doc_type is optional;
    /// its type is defined as 'typedef string TDoc_type'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDoc_type(void) const;
 
    /// Check if it is safe to call GetDoc_type method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDoc_type(void) const;
 
    /// Reset Doc_type data member.
    void ResetDoc_type(void);
 
    /// Get the Doc_type member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDoc_type& GetDoc_type(void) const;
 
    /// Assign a value to Doc_type data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDoc_type(const TDoc_type& value);
    void SetDoc_type(TDoc_type&& value);
 
    /// Assign a value to Doc_type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDoc_type& SetDoc_type(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CId_pat_Base(const CId_pat_Base&);
    CId_pat_Base& operator=(const CId_pat_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Country;
    CRef< TId > m_Id;
    string m_Doc_type;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CId_pat_Base::C_Id::E_Choice CId_pat_Base::C_Id::Which(void) const
{
    return m_choice;
}
 
inline
void CId_pat_Base::C_Id::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CId_pat_Base::C_Id::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CId_pat_Base::C_Id::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CId_pat_Base::C_Id::IsNumber(void) const
{
    return m_choice == e_Number;
}
 
inline
const CId_pat_Base::C_Id::TNumber& CId_pat_Base::C_Id::GetNumber(void) const
{
    CheckSelected(e_Number);
    return *m_string;
}
 
inline
CId_pat_Base::C_Id::TNumber& CId_pat_Base::C_Id::SetNumber(void)
{
    Select(e_Number, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CId_pat_Base::C_Id::IsApp_number(void) const
{
    return m_choice == e_App_number;
}
 
inline
const CId_pat_Base::C_Id::TApp_number& CId_pat_Base::C_Id::GetApp_number(void) const
{
    CheckSelected(e_App_number);
    return *m_string;
}
 
inline
CId_pat_Base::C_Id::TApp_number& CId_pat_Base::C_Id::SetApp_number(void)
{
    Select(e_App_number, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CId_pat_Base::IsSetCountry(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CId_pat_Base::CanGetCountry(void) const
{
    return IsSetCountry();
}
 
inline
const CId_pat_Base::TCountry& CId_pat_Base::GetCountry(void) const
{
    if (!CanGetCountry()) {
        ThrowUnassigned(0);
    }
    return m_Country;
}
 
inline
void CId_pat_Base::SetCountry(const CId_pat_Base::TCountry& value)
{
    m_Country = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CId_pat_Base::SetCountry(CId_pat_Base::TCountry&& value)
{
    m_Country = std::forward<CId_pat_Base::TCountry>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CId_pat_Base::TCountry& CId_pat_Base::SetCountry(void)
{
#ifdef _DEBUG
    if (!IsSetCountry()) {
        m_Country = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Country;
}
 
inline
bool CId_pat_Base::IsSetId(void) const
{
    return m_Id.NotEmpty();
}
 
inline
bool CId_pat_Base::CanGetId(void) const
{
    return true;
}
 
inline
const CId_pat_Base::TId& CId_pat_Base::GetId(void) const
{
    if ( !m_Id ) {
        const_cast<CId_pat_Base*>(this)->ResetId();
    }
    return (*m_Id);
}
 
inline
CId_pat_Base::TId& CId_pat_Base::SetId(void)
{
    if ( !m_Id ) {
        ResetId();
    }
    return (*m_Id);
}
 
inline
bool CId_pat_Base::IsSetDoc_type(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CId_pat_Base::CanGetDoc_type(void) const
{
    return IsSetDoc_type();
}
 
inline
const CId_pat_Base::TDoc_type& CId_pat_Base::GetDoc_type(void) const
{
    if (!CanGetDoc_type()) {
        ThrowUnassigned(2);
    }
    return m_Doc_type;
}
 
inline
void CId_pat_Base::SetDoc_type(const CId_pat_Base::TDoc_type& value)
{
    m_Doc_type = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CId_pat_Base::SetDoc_type(CId_pat_Base::TDoc_type&& value)
{
    m_Doc_type = std::forward<CId_pat_Base::TDoc_type>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CId_pat_Base::TDoc_type& CId_pat_Base::SetDoc_type(void)
{
#ifdef _DEBUG
    if (!IsSetDoc_type()) {
        m_Doc_type = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Doc_type;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BIBLIO_ID_PAT_BASE_HPP