Apad_.hpp

Go to the documentation of 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 Apad_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/linkout/linkout.dtd">linkout.dtd</a>
/// and additional tune-up parameters:
/// <a href="http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/linkout/linkout.def">linkout.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!

#ifndef linkout__OBJTOOLS_EUTILS_LINKOUT_APAD_BASE_HPP
#define linkout__OBJTOOLS_EUTILS_LINKOUT_APAD_BASE_HPP

// standard includes
#include <serial/serialbase.hpp>

// generated includes
#include <list>
#include <string>

#ifndef BEGIN_linkout_SCOPE
#  define BEGIN_linkout_SCOPE BEGIN_SCOPE(linkout)
#  define END_linkout_SCOPE END_SCOPE(linkout)
#endif
BEGIN_linkout_SCOPE // namespace linkout::


// forward declarations
class CApad;
class CNormalize;
class CPad;
class CStrip;
class CSubs;
class CTolower;
class CToupper;


// generated classes


/** @addtogroup dataspec_linkout
 *
 * @{
 */

/////////////////////////////////////////////////////////////////////////////
///
/// CApad_Base --
///

class NCBI_EUTILS_EXPORT CApad_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CApad_Base(void);
    // destructor
    virtual ~CApad_Base(void);

    // type info
    DECLARE_INTERNAL_TYPE_INFO();

    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class NCBI_EUTILS_EXPORT 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();
    
        enum EAttlist_align {
            eAttlist_align_left  = 1,
            eAttlist_align_right = 2
        };
        
        /// Access to EAttlist_align's attributes (values, names) as defined in spec
        static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_align)(void);
        
        // types
        typedef NCBI_NS_STD::string TWith;
        typedef NCBI_NS_STD::string TWidth;
        typedef EAttlist_align TAlign;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to With data member.
        ///
        /// Data member With is mandatory;
        /// its type is defined as 'typedef NCBI_NS_STD::string TWith'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetWith(void) const;
    
        /// Check if it is safe to call GetWith method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetWith(void) const;
    
        /// Reset With data member.
        void ResetWith(void);
    
        /// Get the With member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TWith& GetWith(void) const;
    
        /// Assign a value to With data member.
        ///
        /// @param value
        ///   Value to assign
        void SetWith(const TWith& value);
    
        /// Assign a value to With data member.
        ///
        /// @return
        ///   Reference to the data value.
        TWith& SetWith(void);
    
        /// Check if a value has been assigned to Width data member.
        ///
        /// Data member Width is mandatory;
        /// its type is defined as 'typedef NCBI_NS_STD::string TWidth'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetWidth(void) const;
    
        /// Check if it is safe to call GetWidth method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetWidth(void) const;
    
        /// Reset Width data member.
        void ResetWidth(void);
    
        /// Get the Width member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TWidth& GetWidth(void) const;
    
        /// Assign a value to Width data member.
        ///
        /// @param value
        ///   Value to assign
        void SetWidth(const TWidth& value);
    
        /// Assign a value to Width data member.
        ///
        /// @return
        ///   Reference to the data value.
        TWidth& SetWidth(void);
    
        /// Check if a value has been assigned to Align data member.
        ///
        /// Data member Align is mandatory with default eAttlist_align_right;
        /// its type is defined as 'typedef EAttlist_align TAlign'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetAlign(void) const;
    
        /// Check if it is safe to call GetAlign method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetAlign(void) const;
    
        /// Reset Align data member.
        void ResetAlign(void);
    
        /// Get the Align member data.
        ///
        /// @return
        ///   Copy of the member data.
        TAlign GetAlign(void) const;
    
        /// Assign a value to Align data member.
        ///
        /// @param value
        ///   Value to assign
        void SetAlign(TAlign value);
    
        /// Assign a value to Align data member.
        ///
        /// @return
        ///   Reference to the data value.
        TAlign& SetAlign(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];
        TWith m_With;
        TWidth m_Width;
        TAlign m_Align;
    };
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_E_Apad --
    ///
    
    class NCBI_EUTILS_EXPORT C_E_Apad : public NCBI_NS_NCBI::CSerialObject
    {
        typedef NCBI_NS_NCBI::CSerialObject Tparent;
    public:
        // constructor
        C_E_Apad(void);
        // destructor
        ~C_E_Apad(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    
        /// Choice variants.
        enum E_Choice {
            e_not_set = 0,  ///< No variant selected
            e__CharData,
            e_Pad,
            e_Apad,
            e_Subs,
            e_Toupper,
            e_Tolower,
            e_Strip,
            e_Normalize
        };
        /// Maximum+1 value of the choice variant enumerator.
        enum E_ChoiceStopper {
            e_MaxChoice = 9 ///< == e_Normalize+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 NCBI_NS_STD::string T_CharData;
        typedef CPad TPad;
        typedef CApad TApad;
        typedef CSubs TSubs;
        typedef CToupper TToupper;
        typedef CTolower TTolower;
        typedef CStrip TStrip;
        typedef CNormalize TNormalize;
    
        // getters
        // setters
    
    
        /// Check if variant _CharData is selected.
        ///
        /// _CharData type is defined as 'typedef NCBI_NS_STD::string T_CharData'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool Is_CharData(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const T_CharData& Get_CharData(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        T_CharData& Set_CharData(void);
    
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Variant data.
        void Set_CharData(const T_CharData& value);
    
    
        /// Check if variant Pad is selected.
        ///
        /// Pad type is defined as 'typedef CPad TPad'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsPad(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TPad& GetPad(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TPad& SetPad(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetPad(TPad& value);
    
    
        /// Check if variant Apad is selected.
        ///
        /// Apad type is defined as 'typedef CApad TApad'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsApad(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TApad& GetApad(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TApad& SetApad(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetApad(TApad& value);
    
    
        /// Check if variant Subs is selected.
        ///
        /// Subs type is defined as 'typedef CSubs TSubs'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsSubs(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TSubs& GetSubs(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TSubs& SetSubs(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetSubs(TSubs& value);
    
    
        /// Check if variant Toupper is selected.
        ///
        /// Toupper type is defined as 'typedef CToupper TToupper'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsToupper(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TToupper& GetToupper(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TToupper& SetToupper(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetToupper(TToupper& value);
    
    
        /// Check if variant Tolower is selected.
        ///
        /// Tolower type is defined as 'typedef CTolower TTolower'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsTolower(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TTolower& GetTolower(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TTolower& SetTolower(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetTolower(TTolower& value);
    
    
        /// Check if variant Strip is selected.
        ///
        /// Strip type is defined as 'typedef CStrip TStrip'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsStrip(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TStrip& GetStrip(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TStrip& SetStrip(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetStrip(TStrip& value);
    
    
        /// Check if variant Normalize is selected.
        ///
        /// Normalize type is defined as 'typedef CNormalize TNormalize'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsNormalize(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TNormalize& GetNormalize(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TNormalize& SetNormalize(void);
        /// Select the variant and set its data.
        ///
        /// @param value
        ///   Reference to the data.
        void SetNormalize(TNormalize& value);
    
    
    private:
        // copy constructor and assignment operator
        C_E_Apad(const C_E_Apad& );
        C_E_Apad& operator=(const C_E_Apad& );
        // 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
        union {
            NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
            NCBI_NS_NCBI::CSerialObject *m_object;
        };
    };
    // types
    typedef C_Attlist TAttlist;
    typedef C_E_Apad C_E;
    typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Apad > > TApad;

    // getters
    // setters

    /// used to mark up strings that require padding to create fixed-length string
    ///     attributes. It skips all preceding alpha characters before padding 
    /// 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 Apad data member.
    ///
    /// Data member Apad is optional;
    /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Apad > > TApad'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetApad(void) const;

    /// Check if it is safe to call GetApad method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetApad(void) const;

    /// Reset Apad data member.
    void ResetApad(void);

    /// Get the Apad member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TApad& GetApad(void) const;

    /// Assign a value to Apad data member.
    ///
    /// @return
    ///   Reference to the data value.
    TApad& SetApad(void);

    /// Reset the whole object
    virtual void Reset(void);


private:
    // Prohibit copy constructor and assignment operator
    CApad_Base(const CApad_Base&);
    CApad_Base& operator=(const CApad_Base&);

    // data
    Uint4 m_set_State[1];
    NCBI_NS_NCBI::CRef< TAttlist > m_Attlist;
    TApad m_Apad;
};

/* @} */





///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CApad_Base::C_Attlist::IsSetWith(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}

inline
bool CApad_Base::C_Attlist::CanGetWith(void) const
{
    return IsSetWith();
}

inline
const CApad_Base::C_Attlist::TWith& CApad_Base::C_Attlist::GetWith(void) const
{
    if (!CanGetWith()) {
        ThrowUnassigned(0);
    }
    return m_With;
}

inline
void CApad_Base::C_Attlist::SetWith(const CApad_Base::C_Attlist::TWith& value)
{
    m_With = value;
    m_set_State[0] |= 0x3;
}

inline
CApad_Base::C_Attlist::TWith& CApad_Base::C_Attlist::SetWith(void)
{
#ifdef _DEBUG
    if (!IsSetWith()) {
        m_With = ms_UnassignedStr;
    }
#endif
    m_set_State[0] |= 0x1;
    return m_With;
}

inline
bool CApad_Base::C_Attlist::IsSetWidth(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}

inline
bool CApad_Base::C_Attlist::CanGetWidth(void) const
{
    return IsSetWidth();
}

inline
const CApad_Base::C_Attlist::TWidth& CApad_Base::C_Attlist::GetWidth(void) const
{
    if (!CanGetWidth()) {
        ThrowUnassigned(1);
    }
    return m_Width;
}

inline
void CApad_Base::C_Attlist::SetWidth(const CApad_Base::C_Attlist::TWidth& value)
{
    m_Width = value;
    m_set_State[0] |= 0xc;
}

inline
CApad_Base::C_Attlist::TWidth& CApad_Base::C_Attlist::SetWidth(void)
{
#ifdef _DEBUG
    if (!IsSetWidth()) {
        m_Width = ms_UnassignedStr;
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Width;
}

inline
bool CApad_Base::C_Attlist::IsSetAlign(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}

inline
bool CApad_Base::C_Attlist::CanGetAlign(void) const
{
    return true;
}

inline
void CApad_Base::C_Attlist::ResetAlign(void)
{
    m_Align = eAttlist_align_right;
    m_set_State[0] &= ~0x30;
}

inline
CApad_Base::C_Attlist::TAlign CApad_Base::C_Attlist::GetAlign(void) const
{
    return m_Align;
}

inline
void CApad_Base::C_Attlist::SetAlign(CApad_Base::C_Attlist::TAlign value)
{
    m_Align = value;
    m_set_State[0] |= 0x30;
}

inline
CApad_Base::C_Attlist::TAlign& CApad_Base::C_Attlist::SetAlign(void)
{
#ifdef _DEBUG
    if (!IsSetAlign()) {
        memset(&m_Align,ms_UnassignedByte,sizeof(m_Align));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Align;
}

inline
CApad_Base::C_E_Apad::E_Choice CApad_Base::C_E_Apad::Which(void) const
{
    return m_choice;
}

inline
void CApad_Base::C_E_Apad::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}

inline
void CApad_Base::C_E_Apad::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 CApad_Base::C_E_Apad::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}

inline
bool CApad_Base::C_E_Apad::Is_CharData(void) const
{
    return m_choice == e__CharData;
}

inline
const CApad_Base::C_E_Apad::T_CharData& CApad_Base::C_E_Apad::Get_CharData(void) const
{
    CheckSelected(e__CharData);
    return *m_string;
}

inline
CApad_Base::C_E_Apad::T_CharData& CApad_Base::C_E_Apad::Set_CharData(void)
{
    Select(e__CharData, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}

inline
bool CApad_Base::C_E_Apad::IsPad(void) const
{
    return m_choice == e_Pad;
}

inline
bool CApad_Base::C_E_Apad::IsApad(void) const
{
    return m_choice == e_Apad;
}

inline
bool CApad_Base::C_E_Apad::IsSubs(void) const
{
    return m_choice == e_Subs;
}

inline
bool CApad_Base::C_E_Apad::IsToupper(void) const
{
    return m_choice == e_Toupper;
}

inline
bool CApad_Base::C_E_Apad::IsTolower(void) const
{
    return m_choice == e_Tolower;
}

inline
bool CApad_Base::C_E_Apad::IsStrip(void) const
{
    return m_choice == e_Strip;
}

inline
bool CApad_Base::C_E_Apad::IsNormalize(void) const
{
    return m_choice == e_Normalize;
}

inline
bool CApad_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}

inline
bool CApad_Base::CanGetAttlist(void) const
{
    return true;
}

inline
const CApad_Base::TAttlist& CApad_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CApad_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}

inline
CApad_Base::TAttlist& CApad_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}

inline
bool CApad_Base::IsSetApad(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}

inline
bool CApad_Base::CanGetApad(void) const
{
    return true;
}

inline
const CApad_Base::TApad& CApad_Base::GetApad(void) const
{
    return m_Apad;
}

inline
CApad_Base::TApad& CApad_Base::SetApad(void)
{
    m_set_State[0] |= 0x4;
    return m_Apad;
}

///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////





END_linkout_SCOPE // namespace linkout::


#endif // linkout__OBJTOOLS_EUTILS_LINKOUT_APAD_BASE_HPP