Color_prop_.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 Color_prop_.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/mmdb3/mmdb3.asn">mmdb3.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mmdb3/mmdb3.def">mmdb3.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MMDB3_COLOR_PROP_BASE_HPP
#define OBJECTS_MMDB3_COLOR_PROP_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_MMDB_Features
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CColor_prop_Base --
///
 
class NCBI_MMDB3_EXPORT CColor_prop_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CColor_prop_Base(void);
    // destructor
    virtual ~CColor_prop_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TR;
    typedef int TG;
    typedef int TB;
    typedef string TName;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_r,
        e_g,
        e_b,
        e_name
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to R data member.
    ///
    /// Data member R is optional;
    /// its type is defined as 'typedef int TR'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetR(void) const;
 
    /// Check if it is safe to call GetR method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetR(void) const;
 
    /// Reset R data member.
    void ResetR(void);
 
    /// Get the R member data.
    ///
    /// @return
    ///   Copy of the member data.
    TR GetR(void) const;
 
    /// Assign a value to R data member.
    ///
    /// @param value
    ///   Value to assign
    void SetR(TR value);
 
    /// Assign a value to R data member.
    ///
    /// @return
    ///   Reference to the data value.
    TR& SetR(void);
 
    /// Check if a value has been assigned to G data member.
    ///
    /// Data member G is optional;
    /// its type is defined as 'typedef int TG'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetG(void) const;
 
    /// Check if it is safe to call GetG method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetG(void) const;
 
    /// Reset G data member.
    void ResetG(void);
 
    /// Get the G member data.
    ///
    /// @return
    ///   Copy of the member data.
    TG GetG(void) const;
 
    /// Assign a value to G data member.
    ///
    /// @param value
    ///   Value to assign
    void SetG(TG value);
 
    /// Assign a value to G data member.
    ///
    /// @return
    ///   Reference to the data value.
    TG& SetG(void);
 
    /// Check if a value has been assigned to B data member.
    ///
    /// Data member B is optional;
    /// its type is defined as 'typedef int TB'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetB(void) const;
 
    /// Check if it is safe to call GetB method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetB(void) const;
 
    /// Reset B data member.
    void ResetB(void);
 
    /// Get the B member data.
    ///
    /// @return
    ///   Copy of the member data.
    TB GetB(void) const;
 
    /// Assign a value to B data member.
    ///
    /// @param value
    ///   Value to assign
    void SetB(TB value);
 
    /// Assign a value to B data member.
    ///
    /// @return
    ///   Reference to the data value.
    TB& SetB(void);
 
    /// Check if a value has been assigned to Name data member.
    ///
    /// Data member Name is optional;
    /// 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);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CColor_prop_Base(const CColor_prop_Base&);
    CColor_prop_Base& operator=(const CColor_prop_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_R;
    int m_G;
    int m_B;
    string m_Name;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CColor_prop_Base::IsSetR(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CColor_prop_Base::CanGetR(void) const
{
    return IsSetR();
}
 
inline
void CColor_prop_Base::ResetR(void)
{
    m_R = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CColor_prop_Base::TR CColor_prop_Base::GetR(void) const
{
    if (!CanGetR()) {
        ThrowUnassigned(0);
    }
    return m_R;
}
 
inline
void CColor_prop_Base::SetR(CColor_prop_Base::TR value)
{
    m_R = value;
    m_set_State[0] |= 0x3;
}
 
inline
CColor_prop_Base::TR& CColor_prop_Base::SetR(void)
{
#ifdef _DEBUG
    if (!IsSetR()) {
        memset(&m_R,UnassignedByte(),sizeof(m_R));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_R;
}
 
inline
bool CColor_prop_Base::IsSetG(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CColor_prop_Base::CanGetG(void) const
{
    return IsSetG();
}
 
inline
void CColor_prop_Base::ResetG(void)
{
    m_G = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CColor_prop_Base::TG CColor_prop_Base::GetG(void) const
{
    if (!CanGetG()) {
        ThrowUnassigned(1);
    }
    return m_G;
}
 
inline
void CColor_prop_Base::SetG(CColor_prop_Base::TG value)
{
    m_G = value;
    m_set_State[0] |= 0xc;
}
 
inline
CColor_prop_Base::TG& CColor_prop_Base::SetG(void)
{
#ifdef _DEBUG
    if (!IsSetG()) {
        memset(&m_G,UnassignedByte(),sizeof(m_G));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_G;
}
 
inline
bool CColor_prop_Base::IsSetB(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CColor_prop_Base::CanGetB(void) const
{
    return IsSetB();
}
 
inline
void CColor_prop_Base::ResetB(void)
{
    m_B = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CColor_prop_Base::TB CColor_prop_Base::GetB(void) const
{
    if (!CanGetB()) {
        ThrowUnassigned(2);
    }
    return m_B;
}
 
inline
void CColor_prop_Base::SetB(CColor_prop_Base::TB value)
{
    m_B = value;
    m_set_State[0] |= 0x30;
}
 
inline
CColor_prop_Base::TB& CColor_prop_Base::SetB(void)
{
#ifdef _DEBUG
    if (!IsSetB()) {
        memset(&m_B,UnassignedByte(),sizeof(m_B));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_B;
}
 
inline
bool CColor_prop_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CColor_prop_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CColor_prop_Base::TName& CColor_prop_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(3);
    }
    return m_Name;
}
 
inline
void CColor_prop_Base::SetName(const CColor_prop_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CColor_prop_Base::SetName(CColor_prop_Base::TName&& value)
{
    m_Name = std::forward<CColor_prop_Base::TName>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CColor_prop_Base::TName& CColor_prop_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Name;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MMDB3_COLOR_PROP_BASE_HPP