Conditional_.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 Conditional_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.asn">gui_objects.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef GUI_OBJECTS_CONDITIONAL_BASE_HPP
#define GUI_OBJECTS_CONDITIONAL_BASE_HPP
 
// extra headers
#include <gui/gui_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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_SeqGraphical
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CConditional_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CConditional_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CConditional_Base(void);
    // destructor
    virtual ~CConditional_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    enum EAction {
        eAction_enable  = 0,
        eAction_disable = 1
    };
    
    /// Access to EAction's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAction)(void);
    
    // types
    typedef string TName;
    typedef list< string > TValue;
    typedef EAction TAction;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_name,
        e_value,
        e_action
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// conditional control name
    /// Check if a value has been assigned to Name data member.
    ///
    /// Data member Name is mandatory;
    /// its type is defined as 'typedef string TName'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetName(void) const;
 
    /// Check if it is safe to call GetName method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetName(void) const;
 
    /// Reset Name data member.
    void ResetName(void);
 
    /// Get the Name member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TName& GetName(void) const;
 
    /// Assign a value to Name data member.
    ///
    /// @param value
    ///   Value to assign
    void SetName(const TName& value);
    void SetName(TName&& value);
 
    /// Assign a value to Name data member.
    ///
    /// @return
    ///   Reference to the data value.
    TName& SetName(void);
 
    /// conditional control value
    /// Check if a value has been assigned to Value data member.
    ///
    /// Data member Value is mandatory;
    /// its type is defined as 'typedef list< string > TValue'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetValue(void) const;
 
    /// Check if it is safe to call GetValue method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetValue(void) const;
 
    /// Reset Value data member.
    void ResetValue(void);
 
    /// Get the Value member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TValue& GetValue(void) const;
 
    /// Assign a value to Value data member.
    ///
    /// @return
    ///   Reference to the data value.
    TValue& SetValue(void);
 
    /// Check if a value has been assigned to Action data member.
    ///
    /// Data member Action is optional with default eAction_enable;
    /// its type is defined as 'typedef EAction TAction'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAction(void) const;
 
    /// Check if it is safe to call GetAction method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAction(void) const;
 
    /// Reset Action data member.
    void ResetAction(void);
 
    /// Assign default value to Action data member.
    void SetDefaultAction(void);
 
    /// Get the Action member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAction GetAction(void) const;
 
    /// Assign a value to Action data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAction(TAction value);
 
    /// Assign a value to Action data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAction& SetAction(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CConditional_Base(const CConditional_Base&);
    CConditional_Base& operator=(const CConditional_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Name;
    list< string > m_Value;
    EAction m_Action;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CConditional_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CConditional_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CConditional_Base::TName& CConditional_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}
 
inline
void CConditional_Base::SetName(const CConditional_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CConditional_Base::SetName(CConditional_Base::TName&& value)
{
    m_Name = std::forward<CConditional_Base::TName>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CConditional_Base::TName& CConditional_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}
 
inline
bool CConditional_Base::IsSetValue(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CConditional_Base::CanGetValue(void) const
{
    return true;
}
 
inline
const CConditional_Base::TValue& CConditional_Base::GetValue(void) const
{
    return m_Value;
}
 
inline
CConditional_Base::TValue& CConditional_Base::SetValue(void)
{
    m_set_State[0] |= 0x4;
    return m_Value;
}
 
inline
bool CConditional_Base::IsSetAction(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CConditional_Base::CanGetAction(void) const
{
    return true;
}
 
inline
void CConditional_Base::ResetAction(void)
{
    m_Action = eAction_enable;
    m_set_State[0] &= ~0x30;
}
 
inline
void CConditional_Base::SetDefaultAction(void)
{
    ResetAction();
}
 
inline
CConditional_Base::TAction CConditional_Base::GetAction(void) const
{
    return m_Action;
}
 
inline
void CConditional_Base::SetAction(CConditional_Base::TAction value)
{
    m_Action = value;
    m_set_State[0] |= 0x30;
}
 
inline
CConditional_Base::TAction& CConditional_Base::SetAction(void)
{
#ifdef _DEBUG
    if (!IsSetAction()) {
        memset(&m_Action,UnassignedByte(),sizeof(m_Action));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Action;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_CONDITIONAL_BASE_HPP