PropertyGroupType_.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 PropertyGroupType_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/msbuild/msbuild_dataobj.xsd">msbuild_dataobj.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/msbuild/msbuild_dataobj.def">msbuild_dataobj.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROPERTYGROUPTYPE_BASE_HPP
#define msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROPERTYGROUPTYPE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
 
#ifndef BEGIN_msbuild_SCOPE
#  define BEGIN_msbuild_SCOPE BEGIN_SCOPE(msbuild)
#  define END_msbuild_SCOPE END_SCOPE(msbuild)
#endif
BEGIN_msbuild_SCOPE // namespace msbuild::
 
 
// forward declarations
class CCharacterSet;
class CConfigurationType;
class CKeyword;
class CProjectGuid;
 
 
// generated classes
 
 
/** @addtogroup dataspec_msbuild_dataobj
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///Groups property definitions
///
/// CPropertyGroupType_Base --
///
 
class CPropertyGroupType_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CPropertyGroupType_Base(void);
    // destructor
    virtual ~CPropertyGroupType_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class C_Attlist : public NCBI_NS_NCBI::CSerialObject
    {
        typedef NCBI_NS_NCBI::CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef NCBI_NS_STD::string TCondition;
        typedef NCBI_NS_STD::string TLabel;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_Condition,
            e_Label
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
    
        // getters
        // setters
    
        ///  NCBI modification end  
        ///Optional expression evaluated to determine whether the PropertyGroup should be used
        /// Check if a value has been assigned to Condition data member.
        ///
        /// Data member Condition is optional;
        /// its type is defined as 'typedef NCBI_NS_STD::string TCondition'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetCondition(void) const;
    
        /// Check if it is safe to call GetCondition method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetCondition(void) const;
    
        /// Reset Condition data member.
        void ResetCondition(void);
    
        /// Get the Condition member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TCondition& GetCondition(void) const;
    
        /// Assign a value to Condition data member.
        ///
        /// @param value
        ///   Value to assign
        void SetCondition(const TCondition& value);
        void SetCondition(TCondition&& value);
    
        /// Assign a value to Condition data member.
        ///
        /// @return
        ///   Reference to the data value.
        TCondition& SetCondition(void);
    
        ///Optional expression. Used to identify or order system and user elements
        /// Check if a value has been assigned to Label data member.
        ///
        /// Data member Label is optional;
        /// its type is defined as 'typedef NCBI_NS_STD::string TLabel'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetLabel(void) const;
    
        /// Check if it is safe to call GetLabel method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetLabel(void) const;
    
        /// Reset Label data member.
        void ResetLabel(void);
    
        /// Get the Label member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TLabel& GetLabel(void) const;
    
        /// Assign a value to Label data member.
        ///
        /// @param value
        ///   Value to assign
        void SetLabel(const TLabel& value);
        void SetLabel(TLabel&& value);
    
        /// Assign a value to Label data member.
        ///
        /// @return
        ///   Reference to the data value.
        TLabel& SetLabel(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Attlist(const C_Attlist&);
        C_Attlist& operator=(const C_Attlist&);
    
        // data
        Uint4 m_set_State[1];
        NCBI_NS_STD::string m_Condition;
        NCBI_NS_STD::string m_Label;
    };
    /////////////////////////////////////////////////////////////////////////////
    ///Groups property definitions
    ///
    /// C_E_PropertyGroupType --
    ///
    
    class C_E_PropertyGroupType : public NCBI_NS_NCBI::CSerialObject
    {
        typedef NCBI_NS_NCBI::CSerialObject Tparent;
    public:
        // constructor
        C_E_PropertyGroupType(void);
        // destructor
        ~C_E_PropertyGroupType(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    
        /// Choice variants.
        enum E_Choice {
            e_not_set = 0,        ///< No variant selected
            e_CharacterSet,
            e_ConfigurationType,
            e_Keyword,
            e_ProjectGuid,
            e_AnyContent          ///<  NCBI modification begin          <xs:sequence minOccurs="0" maxOccurs="unbounded">             <xs:element ref="msb:Property"/>         </xs:sequence>
        };
        /// Maximum+1 value of the choice variant enumerator.
        enum E_ChoiceStopper {
            e_MaxChoice = 6 ///< == e_AnyContent+1
        };
    
        /// Reset the whole object
        void Reset(void);
    
        /// Reset the selection (set it to e_not_set).
        void ResetSelection(void);
    
        /// Which variant is currently selected.
        ///
        /// @return
        ///   Choice state enumerator.
        E_Choice Which(void) const;
    
        /// Verify selection, throw exception if it differs from the expected.
        ///
        /// @param index
        ///   Expected selection.
        void CheckSelected(E_Choice index) const;
    
        /// Throw 'InvalidSelection' exception.
        ///
        /// @param index
        ///   Expected selection.
        NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
    
        /// Retrieve selection name (for diagnostic purposes).
        ///
        /// @param index
        ///   One of possible selection states.
        /// @return
        ///   Name string.
        static NCBI_NS_STD::string SelectionName(E_Choice index);
    
        /// Select the requested variant if needed.
        ///
        /// @param index
        ///   New selection state.
        /// @param reset
        ///   Flag that defines the resetting of the variant data. The data will
        ///   be reset if either the current selection differs from the new one,
        ///   or the flag is set to eDoResetVariant.
        void Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset = NCBI_NS_NCBI::eDoResetVariant);
        /// Select the requested variant if needed,
        /// allocating CObject variants from memory pool.
        void Select(E_Choice index,
                    NCBI_NS_NCBI::EResetVariant reset,
                    NCBI_NS_NCBI::CObjectMemoryPool* pool);
    
        // types
        typedef CCharacterSet TCharacterSet;
        typedef CConfigurationType TConfigurationType;
        typedef CKeyword TKeyword;
        typedef CProjectGuid TProjectGuid;
        typedef NCBI_NS_NCBI::CAnyContentObject TAnyContent;
    
        // getters
        // setters
    
    
        /// Check if variant CharacterSet is selected.
        ///
        /// CharacterSet type is defined as 'typedef CCharacterSet TCharacterSet'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsCharacterSet(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TCharacterSet& GetCharacterSet(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TCharacterSet& SetCharacterSet(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetCharacterSet(TCharacterSet& value);
    
    
        /// Check if variant ConfigurationType is selected.
        ///
        /// ConfigurationType type is defined as 'typedef CConfigurationType TConfigurationType'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsConfigurationType(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TConfigurationType& GetConfigurationType(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TConfigurationType& SetConfigurationType(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetConfigurationType(TConfigurationType& value);
    
    
        /// Check if variant Keyword is selected.
        ///
        /// Keyword type is defined as 'typedef CKeyword TKeyword'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsKeyword(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TKeyword& GetKeyword(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TKeyword& SetKeyword(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetKeyword(TKeyword& value);
    
    
        /// Check if variant ProjectGuid is selected.
        ///
        /// ProjectGuid type is defined as 'typedef CProjectGuid TProjectGuid'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsProjectGuid(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TProjectGuid& GetProjectGuid(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TProjectGuid& SetProjectGuid(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetProjectGuid(TProjectGuid& value);
    
    
        /// Check if variant AnyContent is selected.
        ///
        /// AnyContent type is defined as 'typedef NCBI_NS_NCBI::CAnyContentObject TAnyContent'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsAnyContent(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TAnyContent& GetAnyContent(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TAnyContent& SetAnyContent(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetAnyContent(TAnyContent& value);
    
    
    private:
        // copy constructor and assignment operator
        C_E_PropertyGroupType(const C_E_PropertyGroupType& );
        C_E_PropertyGroupType& operator=(const C_E_PropertyGroupType& );
        // choice state
        E_Choice m_choice;
        // helper methods
        void DoSelect(E_Choice index, NCBI_NS_NCBI::CObjectMemoryPool* pool = 0);
    
        static const char* const sm_SelectionNames[];
        // data
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef C_E_PropertyGroupType C_E;
    typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_PropertyGroupType > > TPropertyGroupType;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_PropertyGroupType
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Attlist data member.
    ///
    /// Data member Attlist is mandatory;
    /// its type is defined as 'typedef C_Attlist TAttlist'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttlist(void) const;
 
    /// Check if it is safe to call GetAttlist method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttlist(void) const;
 
    /// Reset Attlist data member.
    void ResetAttlist(void);
 
    /// Get the Attlist member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttlist& GetAttlist(void) const;
 
    /// Assign a value to Attlist data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttlist(TAttlist& value);
 
    /// Assign a value to Attlist data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttlist& SetAttlist(void);
 
    /// Check if a value has been assigned to PropertyGroupType data member.
    ///
    /// Data member PropertyGroupType is optional;
    /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_PropertyGroupType > > TPropertyGroupType'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPropertyGroupType(void) const;
 
    /// Check if it is safe to call GetPropertyGroupType method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPropertyGroupType(void) const;
 
    /// Reset PropertyGroupType data member.
    void ResetPropertyGroupType(void);
 
    /// Get the PropertyGroupType member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPropertyGroupType& GetPropertyGroupType(void) const;
 
    /// Assign a value to PropertyGroupType data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPropertyGroupType& SetPropertyGroupType(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPropertyGroupType_Base(const CPropertyGroupType_Base&);
    CPropertyGroupType_Base& operator=(const CPropertyGroupType_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_NCBI::CRef< TAttlist > m_Attlist;
    NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_PropertyGroupType > > m_PropertyGroupType;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPropertyGroupType_Base::C_Attlist::IsSetCondition(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPropertyGroupType_Base::C_Attlist::CanGetCondition(void) const
{
    return IsSetCondition();
}
 
inline
const CPropertyGroupType_Base::C_Attlist::TCondition& CPropertyGroupType_Base::C_Attlist::GetCondition(void) const
{
    if (!CanGetCondition()) {
        ThrowUnassigned(0);
    }
    return m_Condition;
}
 
inline
void CPropertyGroupType_Base::C_Attlist::SetCondition(const CPropertyGroupType_Base::C_Attlist::TCondition& value)
{
    m_Condition = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPropertyGroupType_Base::C_Attlist::SetCondition(CPropertyGroupType_Base::C_Attlist::TCondition&& value)
{
    m_Condition = std::forward<CPropertyGroupType_Base::C_Attlist::TCondition>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPropertyGroupType_Base::C_Attlist::TCondition& CPropertyGroupType_Base::C_Attlist::SetCondition(void)
{
#ifdef _DEBUG
    if (!IsSetCondition()) {
        m_Condition = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Condition;
}
 
inline
bool CPropertyGroupType_Base::C_Attlist::IsSetLabel(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPropertyGroupType_Base::C_Attlist::CanGetLabel(void) const
{
    return IsSetLabel();
}
 
inline
const CPropertyGroupType_Base::C_Attlist::TLabel& CPropertyGroupType_Base::C_Attlist::GetLabel(void) const
{
    if (!CanGetLabel()) {
        ThrowUnassigned(1);
    }
    return m_Label;
}
 
inline
void CPropertyGroupType_Base::C_Attlist::SetLabel(const CPropertyGroupType_Base::C_Attlist::TLabel& value)
{
    m_Label = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPropertyGroupType_Base::C_Attlist::SetLabel(CPropertyGroupType_Base::C_Attlist::TLabel&& value)
{
    m_Label = std::forward<CPropertyGroupType_Base::C_Attlist::TLabel>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPropertyGroupType_Base::C_Attlist::TLabel& CPropertyGroupType_Base::C_Attlist::SetLabel(void)
{
#ifdef _DEBUG
    if (!IsSetLabel()) {
        m_Label = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Label;
}
 
inline
CPropertyGroupType_Base::C_E_PropertyGroupType::E_Choice CPropertyGroupType_Base::C_E_PropertyGroupType::Which(void) const
{
    return m_choice;
}
 
inline
void CPropertyGroupType_Base::C_E_PropertyGroupType::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CPropertyGroupType_Base::C_E_PropertyGroupType::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CPropertyGroupType_Base::C_E_PropertyGroupType::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CPropertyGroupType_Base::C_E_PropertyGroupType::IsCharacterSet(void) const
{
    return m_choice == e_CharacterSet;
}
 
inline
bool CPropertyGroupType_Base::C_E_PropertyGroupType::IsConfigurationType(void) const
{
    return m_choice == e_ConfigurationType;
}
 
inline
bool CPropertyGroupType_Base::C_E_PropertyGroupType::IsKeyword(void) const
{
    return m_choice == e_Keyword;
}
 
inline
bool CPropertyGroupType_Base::C_E_PropertyGroupType::IsProjectGuid(void) const
{
    return m_choice == e_ProjectGuid;
}
 
inline
bool CPropertyGroupType_Base::C_E_PropertyGroupType::IsAnyContent(void) const
{
    return m_choice == e_AnyContent;
}
 
inline
bool CPropertyGroupType_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CPropertyGroupType_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CPropertyGroupType_Base::TAttlist& CPropertyGroupType_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CPropertyGroupType_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CPropertyGroupType_Base::TAttlist& CPropertyGroupType_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CPropertyGroupType_Base::IsSetPropertyGroupType(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPropertyGroupType_Base::CanGetPropertyGroupType(void) const
{
    return true;
}
 
inline
const CPropertyGroupType_Base::TPropertyGroupType& CPropertyGroupType_Base::GetPropertyGroupType(void) const
{
    return m_PropertyGroupType;
}
 
inline
CPropertyGroupType_Base::TPropertyGroupType& CPropertyGroupType_Base::SetPropertyGroupType(void)
{
    m_set_State[0] |= 0x4;
    return m_PropertyGroupType;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_msbuild_SCOPE // namespace msbuild::
 
 
#endif // msbuild__BUILD_SYSTEM_PROJECT_TREE_BUILDER_MSBUILD_PROPERTYGROUPTYPE_BASE_HPP