Field_constraint_.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 Field_constraint_.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/macro/macro.asn">macro.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/macro/macro.def">macro.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MACRO_FIELD_CONSTRAINT_BASE_HPP
#define OBJECTS_MACRO_FIELD_CONSTRAINT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
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 CField_type;
class CString_constraint;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Macro
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CField_constraint_Base --
///
 
class CField_constraint_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CField_constraint_Base(void);
    // destructor
    virtual ~CField_constraint_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CField_type TField;
    typedef CString_constraint TString_constraint;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_field,
        e_string_constraint
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Field data member.
    ///
    /// Data member Field is mandatory;
    /// its type is defined as 'typedef CField_type TField'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetField(void) const;
 
    /// Check if it is safe to call GetField method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetField(void) const;
 
    /// Reset Field data member.
    void ResetField(void);
 
    /// Get the Field member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TField& GetField(void) const;
 
    /// Assign a value to Field data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetField(TField& value);
 
    /// Assign a value to Field data member.
    ///
    /// @return
    ///   Reference to the data value.
    TField& SetField(void);
 
    /// Check if a value has been assigned to String_constraint data member.
    ///
    /// Data member String_constraint is mandatory;
    /// its type is defined as 'typedef CString_constraint TString_constraint'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetString_constraint(void) const;
 
    /// Check if it is safe to call GetString_constraint method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetString_constraint(void) const;
 
    /// Reset String_constraint data member.
    void ResetString_constraint(void);
 
    /// Get the String_constraint member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TString_constraint& GetString_constraint(void) const;
 
    /// Assign a value to String_constraint data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetString_constraint(TString_constraint& value);
 
    /// Assign a value to String_constraint data member.
    ///
    /// @return
    ///   Reference to the data value.
    TString_constraint& SetString_constraint(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CField_constraint_Base(const CField_constraint_Base&);
    CField_constraint_Base& operator=(const CField_constraint_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TField > m_Field;
    CRef< TString_constraint > m_String_constraint;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CField_constraint_Base::IsSetField(void) const
{
    return m_Field.NotEmpty();
}
 
inline
bool CField_constraint_Base::CanGetField(void) const
{
    return true;
}
 
inline
const CField_constraint_Base::TField& CField_constraint_Base::GetField(void) const
{
    if ( !m_Field ) {
        const_cast<CField_constraint_Base*>(this)->ResetField();
    }
    return (*m_Field);
}
 
inline
CField_constraint_Base::TField& CField_constraint_Base::SetField(void)
{
    if ( !m_Field ) {
        ResetField();
    }
    return (*m_Field);
}
 
inline
bool CField_constraint_Base::IsSetString_constraint(void) const
{
    return m_String_constraint.NotEmpty();
}
 
inline
bool CField_constraint_Base::CanGetString_constraint(void) const
{
    return true;
}
 
inline
const CField_constraint_Base::TString_constraint& CField_constraint_Base::GetString_constraint(void) const
{
    if ( !m_String_constraint ) {
        const_cast<CField_constraint_Base*>(this)->ResetString_constraint();
    }
    return (*m_String_constraint);
}
 
inline
CField_constraint_Base::TString_constraint& CField_constraint_Base::SetString_constraint(void)
{
    if ( !m_String_constraint ) {
        ResetString_constraint();
    }
    return (*m_String_constraint);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MACRO_FIELD_CONSTRAINT_BASE_HPP