TMgr_TrackAttrValueReply_.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 TMgr_TrackAttrValueReply_.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/trackmgr/trackmgr.asn">trackmgr.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/trackmgr/trackmgr.def">trackmgr.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP
#define OBJECTS_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP
 
// extra headers
#include <objects/trackmgr/trackmgr_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#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::
 
 
// forward declarations
class CTMgr_AttrReply;
class CTMgr_AttrValueReply;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_TrackManager
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CTMgr_TrackAttrValueReply_Base --
///
 
class NCBI_TRACKMGR_EXPORT CTMgr_TrackAttrValueReply_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTMgr_TrackAttrValueReply_Base(void);
    // destructor
    virtual ~CTMgr_TrackAttrValueReply_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef list< string > TTrack_type_list;
    typedef CTMgr_AttrReply TAttr_list;
    typedef list< CRef< CTMgr_AttrValueReply > > TValue_list;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_track_type_list,
        e_attr_list,
        e_value_list
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// list of track types
    /// Check if a value has been assigned to Track_type_list data member.
    ///
    /// Data member Track_type_list is optional;
    /// its type is defined as 'typedef list< string > TTrack_type_list'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTrack_type_list(void) const;
 
    /// Check if it is safe to call GetTrack_type_list method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTrack_type_list(void) const;
 
    /// Reset Track_type_list data member.
    void ResetTrack_type_list(void);
 
    /// Get the Track_type_list member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTrack_type_list& GetTrack_type_list(void) const;
 
    /// Assign a value to Track_type_list data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTrack_type_list& SetTrack_type_list(void);
 
    /// Check if a value has been assigned to Attr_list data member.
    ///
    /// Data member Attr_list is optional;
    /// its type is defined as 'typedef CTMgr_AttrReply TAttr_list'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttr_list(void) const;
 
    /// Check if it is safe to call GetAttr_list method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttr_list(void) const;
 
    /// Reset Attr_list data member.
    void ResetAttr_list(void);
 
    /// Get the Attr_list member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttr_list& GetAttr_list(void) const;
 
    /// Assign a value to Attr_list data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttr_list(TAttr_list& value);
 
    /// Assign a value to Attr_list data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttr_list& SetAttr_list(void);
 
    /// Check if a value has been assigned to Value_list data member.
    ///
    /// Data member Value_list is optional;
    /// its type is defined as 'typedef list< CRef< CTMgr_AttrValueReply > > TValue_list'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetValue_list(void) const;
 
    /// Check if it is safe to call GetValue_list method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetValue_list(void) const;
 
    /// Reset Value_list data member.
    void ResetValue_list(void);
 
    /// Get the Value_list member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TValue_list& GetValue_list(void) const;
 
    /// Assign a value to Value_list data member.
    ///
    /// @return
    ///   Reference to the data value.
    TValue_list& SetValue_list(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CTMgr_TrackAttrValueReply_Base(const CTMgr_TrackAttrValueReply_Base&);
    CTMgr_TrackAttrValueReply_Base& operator=(const CTMgr_TrackAttrValueReply_Base&);
 
    // data
    Uint4 m_set_State[1];
    list< string > m_Track_type_list;
    CRef< TAttr_list > m_Attr_list;
    list< CRef< CTMgr_AttrValueReply > > m_Value_list;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CTMgr_TrackAttrValueReply_Base::IsSetTrack_type_list(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CTMgr_TrackAttrValueReply_Base::CanGetTrack_type_list(void) const
{
    return true;
}
 
inline
const CTMgr_TrackAttrValueReply_Base::TTrack_type_list& CTMgr_TrackAttrValueReply_Base::GetTrack_type_list(void) const
{
    return m_Track_type_list;
}
 
inline
CTMgr_TrackAttrValueReply_Base::TTrack_type_list& CTMgr_TrackAttrValueReply_Base::SetTrack_type_list(void)
{
    m_set_State[0] |= 0x1;
    return m_Track_type_list;
}
 
inline
bool CTMgr_TrackAttrValueReply_Base::IsSetAttr_list(void) const
{
    return m_Attr_list.NotEmpty();
}
 
inline
bool CTMgr_TrackAttrValueReply_Base::CanGetAttr_list(void) const
{
    return IsSetAttr_list();
}
 
inline
const CTMgr_TrackAttrValueReply_Base::TAttr_list& CTMgr_TrackAttrValueReply_Base::GetAttr_list(void) const
{
    if (!CanGetAttr_list()) {
        ThrowUnassigned(1);
    }
    return (*m_Attr_list);
}
 
inline
bool CTMgr_TrackAttrValueReply_Base::IsSetValue_list(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CTMgr_TrackAttrValueReply_Base::CanGetValue_list(void) const
{
    return true;
}
 
inline
const CTMgr_TrackAttrValueReply_Base::TValue_list& CTMgr_TrackAttrValueReply_Base::GetValue_list(void) const
{
    return m_Value_list;
}
 
inline
CTMgr_TrackAttrValueReply_Base::TValue_list& CTMgr_TrackAttrValueReply_Base::SetValue_list(void)
{
    m_set_State[0] |= 0x10;
    return m_Value_list;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_TRACKMGR_TMGR_TRACKATTRVALUEREPLY_BASE_HPP