User_object_.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 User_object_.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/general/general.asn">general.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/general/general.def">general.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GENERAL_USER_OBJECT_BASE_HPP
#define OBJECTS_GENERAL_USER_OBJECT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
#include <vector>
 
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 CObject_id;
class CUser_field;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_General
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///**** User-object **********************************************
///*
///*   a general object for a user defined structured data item
///*    used by Seq-feat and Seq-descr
///
/// CUser_object_Base --
///
 
class NCBI_GENERAL_EXPORT CUser_object_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CUser_object_Base(void);
    // destructor
    virtual ~CUser_object_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TClass;
    typedef CObject_id TType;
    typedef vector< CRef< CUser_field > > TData;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_class,
        e_type,
        e_data
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// endeavor which designed this object
    /// Check if a value has been assigned to Class data member.
    ///
    /// Data member Class is optional;
    /// its type is defined as 'typedef string TClass'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetClass(void) const;
 
    /// Check if it is safe to call GetClass method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetClass(void) const;
 
    /// Reset Class data member.
    void ResetClass(void);
 
    /// Get the Class member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TClass& GetClass(void) const;
 
    /// Assign a value to Class data member.
    ///
    /// @param value
    ///   Value to assign
    void SetClass(const TClass& value);
    void SetClass(TClass&& value);
 
    /// Assign a value to Class data member.
    ///
    /// @return
    ///   Reference to the data value.
    TClass& SetClass(void);
 
    /// type of object within class
    /// Check if a value has been assigned to Type data member.
    ///
    /// Data member Type is mandatory;
    /// its type is defined as 'typedef CObject_id 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.
    ///
    /// @param value
    ///   Reference to value.
    void SetType(TType& value);
 
    /// Assign a value to Type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TType& SetType(void);
 
    /// the object itself
    /// Check if a value has been assigned to Data data member.
    ///
    /// Data member Data is mandatory;
    /// its type is defined as 'typedef vector< CRef< CUser_field > > 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
    CUser_object_Base(const CUser_object_Base&);
    CUser_object_Base& operator=(const CUser_object_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Class;
    CRef< TType > m_Type;
    vector< CRef< CUser_field > > m_Data;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CUser_object_Base::IsSetClass(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CUser_object_Base::CanGetClass(void) const
{
    return IsSetClass();
}
 
inline
const CUser_object_Base::TClass& CUser_object_Base::GetClass(void) const
{
    if (!CanGetClass()) {
        ThrowUnassigned(0);
    }
    return m_Class;
}
 
inline
void CUser_object_Base::SetClass(const CUser_object_Base::TClass& value)
{
    m_Class = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CUser_object_Base::SetClass(CUser_object_Base::TClass&& value)
{
    m_Class = std::forward<CUser_object_Base::TClass>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CUser_object_Base::TClass& CUser_object_Base::SetClass(void)
{
#ifdef _DEBUG
    if (!IsSetClass()) {
        m_Class = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Class;
}
 
inline
bool CUser_object_Base::IsSetType(void) const
{
    return m_Type.NotEmpty();
}
 
inline
bool CUser_object_Base::CanGetType(void) const
{
    return true;
}
 
inline
const CUser_object_Base::TType& CUser_object_Base::GetType(void) const
{
    if ( !m_Type ) {
        const_cast<CUser_object_Base*>(this)->ResetType();
    }
    return (*m_Type);
}
 
inline
CUser_object_Base::TType& CUser_object_Base::SetType(void)
{
    if ( !m_Type ) {
        ResetType();
    }
    return (*m_Type);
}
 
inline
bool CUser_object_Base::IsSetData(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CUser_object_Base::CanGetData(void) const
{
    return true;
}
 
inline
const CUser_object_Base::TData& CUser_object_Base::GetData(void) const
{
    return m_Data;
}
 
inline
CUser_object_Base::TData& CUser_object_Base::SetData(void)
{
    m_set_State[0] |= 0x10;
    return m_Data;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GENERAL_USER_OBJECT_BASE_HPP