PC_AssayDescription_.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 PC_AssayDescription_.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/pcassay/pcassay.asn">pcassay.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/pcassay/pcassay.def">pcassay.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_PCASSAY_PC_ASSAYDESCRIPTION_BASE_HPP
#define OBJECTS_PCASSAY_PC_ASSAYDESCRIPTION_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
#include <vector>
 
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 CPC_AnnotatedXRef;
class CPC_AssayDRAttr;
class CPC_AssayPanel;
class CPC_AssayTargetInfo;
class CPC_CategorizedComment;
class CPC_ID;
class CPC_ResultType;
class CPC_Source;
class CPub;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_PCAssay
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Assay Description provided by an Organization that describes the assay/protocol performed and defines the 
///   measured end-points and parameters to be stored.  An Assay Description is not a database table.  You can 
///   define as many Result Definitions as needed and they need not be used by all Substances tested.
/// Assay Descriptions can be modified on both description text and Result Definitions after initial submission
/// as desired, and such udpates will be tracked in PubChem
///
/// CPC_AssayDescription_Base --
///
 
class NCBI_PCASSAY_EXPORT CPC_AssayDescription_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPC_AssayDescription_Base(void);
    // destructor
    virtual ~CPC_AssayDescription_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /// Assay Outcome Qualifier
    enum EActivity_outcome_method {
        eActivity_outcome_method_other        = 0,  ///<   All Other Type
        eActivity_outcome_method_screening    = 1,  ///<   Primary Screen Assay
        eActivity_outcome_method_confirmatory = 2,  ///<   Confirmatory Assay
        eActivity_outcome_method_summary      = 3  ///<   Probe Summary Assay
    };
    
    /// Access to EActivity_outcome_method's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EActivity_outcome_method)(void);
    
    enum ESubstance_type {
        eSubstance_type_small_molecule =   1,
        eSubstance_type_nucleotide     =   2,
        eSubstance_type_other          = 255
    };
    
    /// Access to ESubstance_type's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ESubstance_type)(void);
    
    enum EProject_category {
        eProject_category_mlscn                =   1,
        eProject_category_mlpcn                =   2,
        eProject_category_mlscn_ap             =   3,
        eProject_category_mlpcn_ap             =   4,
        eProject_category_journal_article      =   5,  ///< to be deprecated
        eProject_category_assay_vendor         =   6,
        eProject_category_literature_extracted =   7,
        eProject_category_literature_author    =   8,
        eProject_category_literature_publisher =   9,
        eProject_category_rnaigi               =  10,
        eProject_category_other                = 255
    };
    
    /// Access to EProject_category's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EProject_category)(void);
    
    // types
    typedef CPC_ID TAid;
    typedef CPC_Source TAid_source;
    typedef string TName;
    typedef list< string > TDescription;
    typedef list< string > TProtocol;
    typedef list< string > TComment;
    typedef list< CRef< CPC_AnnotatedXRef > > TXref;
    typedef vector< CRef< CPC_ResultType > > TResults;
    typedef list< CRef< CPub > > TPub;
    typedef int TRevision;
    typedef list< CRef< CPC_AssayTargetInfo > > TTarget;
    typedef int TActivity_outcome_method;
    typedef list< CRef< CPC_AssayDRAttr > > TDr;
    typedef int TSubstance_type;
    typedef list< string > TGrant_number;
    typedef int TProject_category;
    typedef bool TIs_panel;
    typedef list< string > TAssay_group;
    typedef CPC_AssayPanel TPanel_info;
    typedef bool TIs_mlp_late_stage;
    typedef list< CRef< CPC_CategorizedComment > > TCategorized_comment;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_aid,
        e_aid_source,
        e_name,
        e_description,
        e_protocol,
        e_comment,
        e_xref,
        e_results,
        e_pub,
        e_revision,
        e_target,
        e_activity_outcome_method,
        e_dr,
        e_substance_type,
        e_grant_number,
        e_project_category,
        e_is_panel,
        e_assay_group,
        e_panel_info,
        e_is_mlp_late_stage,
        e_categorized_comment
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 22> TmemberIndex;
 
    // getters
    // setters
 
    /// Internal/External Tracking Information
    /// Assay Description ID/Version  [Either valid ID
    ///   or, if "aid-source" is used, a "0" dummy value]
    ///   Note: Version is for internal use (only?)
    ///   Note: A valid ID is greater than "0"
    /// Check if a value has been assigned to Aid data member.
    ///
    /// Data member Aid is mandatory;
    /// its type is defined as 'typedef CPC_ID TAid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAid(void) const;
 
    /// Check if it is safe to call GetAid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAid(void) const;
 
    /// Reset Aid data member.
    void ResetAid(void);
 
    /// Get the Aid member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAid& GetAid(void) const;
 
    /// Assign a value to Aid data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAid(TAid& value);
 
    /// Assign a value to Aid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAid& SetAid(void);
 
    /// External Identifier for this Assay Description
    ///   Note: May be used in-lieu of "aid"
    ///   Note: This is non-optional if "aid" ID is "0"
    /// Check if a value has been assigned to Aid_source data member.
    ///
    /// Data member Aid_source is optional;
    /// its type is defined as 'typedef CPC_Source TAid_source'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAid_source(void) const;
 
    /// Check if it is safe to call GetAid_source method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAid_source(void) const;
 
    /// Reset Aid_source data member.
    void ResetAid_source(void);
 
    /// Get the Aid_source member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAid_source& GetAid_source(void) const;
 
    /// Assign a value to Aid_source data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAid_source(TAid_source& value);
 
    /// Assign a value to Aid_source data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAid_source& SetAid_source(void);
 
    /// Assay Description Information
    /// Short Assay Name (for display purposes)
    /// 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);
 
    /// Description of Assay
    /// Check if a value has been assigned to Description data member.
    ///
    /// Data member Description is optional;
    /// its type is defined as 'typedef list< string > TDescription'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDescription(void) const;
 
    /// Check if it is safe to call GetDescription method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDescription(void) const;
 
    /// Reset Description data member.
    void ResetDescription(void);
 
    /// Get the Description member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDescription& GetDescription(void) const;
 
    /// Assign a value to Description data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDescription& SetDescription(void);
 
    /// Procedure used to generate results
    /// Check if a value has been assigned to Protocol data member.
    ///
    /// Data member Protocol is optional;
    /// its type is defined as 'typedef list< string > TProtocol'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetProtocol(void) const;
 
    /// Check if it is safe to call GetProtocol method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetProtocol(void) const;
 
    /// Reset Protocol data member.
    void ResetProtocol(void);
 
    /// Get the Protocol member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TProtocol& GetProtocol(void) const;
 
    /// Assign a value to Protocol data member.
    ///
    /// @return
    ///   Reference to the data value.
    TProtocol& SetProtocol(void);
 
    /// Comments or additional information
    /// Check if a value has been assigned to Comment data member.
    ///
    /// Data member Comment is optional;
    /// its type is defined as 'typedef list< string > TComment'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetComment(void) const;
 
    /// Check if it is safe to call GetComment method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetComment(void) const;
 
    /// Reset Comment data member.
    void ResetComment(void);
 
    /// Get the Comment member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TComment& GetComment(void) const;
 
    /// Assign a value to Comment data member.
    ///
    /// @return
    ///   Reference to the data value.
    TComment& SetComment(void);
 
    /// Annotated Cross-Reference Information
    /// Check if a value has been assigned to Xref data member.
    ///
    /// Data member Xref is optional;
    /// its type is defined as 'typedef list< CRef< CPC_AnnotatedXRef > > TXref'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetXref(void) const;
 
    /// Check if it is safe to call GetXref method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetXref(void) const;
 
    /// Reset Xref data member.
    void ResetXref(void);
 
    /// Get the Xref member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TXref& GetXref(void) const;
 
    /// Assign a value to Xref data member.
    ///
    /// @return
    ///   Reference to the data value.
    TXref& SetXref(void);
 
    /// Allowed Assay Result Types
    /// Result Definitions (vector)
    /// Check if a value has been assigned to Results data member.
    ///
    /// Data member Results is optional;
    /// its type is defined as 'typedef vector< CRef< CPC_ResultType > > TResults'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetResults(void) const;
 
    /// Check if it is safe to call GetResults method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetResults(void) const;
 
    /// Reset Results data member.
    void ResetResults(void);
 
    /// Get the Results member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TResults& GetResults(void) const;
 
    /// Assign a value to Results data member.
    ///
    /// @return
    ///   Reference to the data value.
    TResults& SetResults(void);
 
    /// Additional Information
    /// Depositor provided publications for this assay
    /// Check if a value has been assigned to Pub data member.
    ///
    /// Data member Pub is optional;
    /// its type is defined as 'typedef list< CRef< CPub > > TPub'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPub(void) const;
 
    /// Check if it is safe to call GetPub method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPub(void) const;
 
    /// Reset Pub data member.
    void ResetPub(void);
 
    /// Get the Pub member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPub& GetPub(void) const;
 
    /// Assign a value to Pub data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPub& SetPub(void);
 
    /// Revision identifier for textual description
    /// Check if a value has been assigned to Revision data member.
    ///
    /// Data member Revision is optional;
    /// its type is defined as 'typedef int TRevision'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRevision(void) const;
 
    /// Check if it is safe to call GetRevision method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRevision(void) const;
 
    /// Reset Revision data member.
    void ResetRevision(void);
 
    /// Get the Revision member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRevision GetRevision(void) const;
 
    /// Assign a value to Revision data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRevision(TRevision value);
 
    /// Assign a value to Revision data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRevision& SetRevision(void);
 
    /// Target information
    /// Check if a value has been assigned to Target data member.
    ///
    /// Data member Target is optional;
    /// its type is defined as 'typedef list< CRef< CPC_AssayTargetInfo > > TTarget'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTarget(void) const;
 
    /// Check if it is safe to call GetTarget method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTarget(void) const;
 
    /// Reset Target data member.
    void ResetTarget(void);
 
    /// Get the Target member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTarget& GetTarget(void) const;
 
    /// Assign a value to Target data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTarget& SetTarget(void);
 
    /// Check if a value has been assigned to Activity_outcome_method data member.
    ///
    /// Data member Activity_outcome_method is optional;
    /// its type is defined as 'typedef int TActivity_outcome_method'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetActivity_outcome_method(void) const;
 
    /// Check if it is safe to call GetActivity_outcome_method method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetActivity_outcome_method(void) const;
 
    /// Reset Activity_outcome_method data member.
    void ResetActivity_outcome_method(void);
 
    /// Get the Activity_outcome_method member data.
    ///
    /// @return
    ///   Copy of the member data.
    TActivity_outcome_method GetActivity_outcome_method(void) const;
 
    /// Assign a value to Activity_outcome_method data member.
    ///
    /// @param value
    ///   Value to assign
    void SetActivity_outcome_method(TActivity_outcome_method value);
 
    /// Assign a value to Activity_outcome_method data member.
    ///
    /// @return
    ///   Reference to the data value.
    TActivity_outcome_method& SetActivity_outcome_method(void);
 
    /// Dose-Response Attribution
    /// Check if a value has been assigned to Dr data member.
    ///
    /// Data member Dr is optional;
    /// its type is defined as 'typedef list< CRef< CPC_AssayDRAttr > > TDr'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDr(void) const;
 
    /// Check if it is safe to call GetDr method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDr(void) const;
 
    /// Reset Dr data member.
    void ResetDr(void);
 
    /// Get the Dr member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDr& GetDr(void) const;
 
    /// Assign a value to Dr data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDr& SetDr(void);
 
    /// to distinguish the type of substance used in the screening
    /// Check if a value has been assigned to Substance_type data member.
    ///
    /// Data member Substance_type is optional;
    /// its type is defined as 'typedef int TSubstance_type'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubstance_type(void) const;
 
    /// Check if it is safe to call GetSubstance_type method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubstance_type(void) const;
 
    /// Reset Substance_type data member.
    void ResetSubstance_type(void);
 
    /// Get the Substance_type member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSubstance_type GetSubstance_type(void) const;
 
    /// Assign a value to Substance_type data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSubstance_type(TSubstance_type value);
 
    /// Assign a value to Substance_type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubstance_type& SetSubstance_type(void);
 
    /// Grant and project category information
    /// grant proposal number
    /// required for 'MLSCN' & 'MLPCN' projects
    /// Check if a value has been assigned to Grant_number data member.
    ///
    /// Data member Grant_number is optional;
    /// its type is defined as 'typedef list< string > TGrant_number'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetGrant_number(void) const;
 
    /// Check if it is safe to call GetGrant_number method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetGrant_number(void) const;
 
    /// Reset Grant_number data member.
    void ResetGrant_number(void);
 
    /// Get the Grant_number member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TGrant_number& GetGrant_number(void) const;
 
    /// Assign a value to Grant_number data member.
    ///
    /// @return
    ///   Reference to the data value.
    TGrant_number& SetGrant_number(void);
 
    /// to distinguish projects funded through MLSCN, MLPCN or other
    /// mlscn: assay depositions from MLSCN screen center
    /// mlpcn: assay depositions from MLPCN screen center
    /// mlscn-ap: assay depositions from MLSCN assay provider
    /// mlpcn-ap: assay depositions from MLPCN assay provider
    /// required for 'MLSCN' & 'MLPCN' projects
    /// journal-article: to be deprecated; replaced by option 7,8 & 9 to better characterize data from literature 
    /// literature-extracted: data from literature, extracted by curators
    /// literature-author: data from literature, submitted by author of articles
    /// literature-publisher: data from literature, submitted by journals/publishers
    /// rnaigi: RNAi screenings from RNAi Global Initiative 
    /// Check if a value has been assigned to Project_category data member.
    ///
    /// Data member Project_category is optional;
    /// its type is defined as 'typedef int TProject_category'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetProject_category(void) const;
 
    /// Check if it is safe to call GetProject_category method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetProject_category(void) const;
 
    /// Reset Project_category data member.
    void ResetProject_category(void);
 
    /// Get the Project_category member data.
    ///
    /// @return
    ///   Copy of the member data.
    TProject_category GetProject_category(void) const;
 
    /// Assign a value to Project_category data member.
    ///
    /// @param value
    ///   Value to assign
    void SetProject_category(TProject_category value);
 
    /// Assign a value to Project_category data member.
    ///
    /// @return
    ///   Reference to the data value.
    TProject_category& SetProject_category(void);
 
    /// annotation to indicate whether an assay is a panel, e.g. containing multiple components, or belongs to a group    
    /// annotation for panel assay, e.g. to indicate that this assay
    /// contains multiple members/components. 
    /// A panel assay can be one assay reporting readouts for
    /// many targets, or reporting readouts for different
    /// cell lines, or different organisms
    /// examples such as bioassay containing kinase profiling data
    /// or bioassay containing cytoxicity data for multiple cell lines
    /// or bioassay containing screening data from different stages, 
    /// such as primary screening, follow ups
    /// Check if a value has been assigned to Is_panel data member.
    ///
    /// Data member Is_panel is optional;
    /// its type is defined as 'typedef bool TIs_panel'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIs_panel(void) const;
 
    /// Check if it is safe to call GetIs_panel method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIs_panel(void) const;
 
    /// Reset Is_panel data member.
    void ResetIs_panel(void);
 
    /// Get the Is_panel member data.
    ///
    /// @return
    ///   Copy of the member data.
    TIs_panel GetIs_panel(void) const;
 
    /// Assign a value to Is_panel data member.
    ///
    /// @param value
    ///   Value to assign
    void SetIs_panel(TIs_panel value);
 
    /// Assign a value to Is_panel data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIs_panel& SetIs_panel(void);
 
    /// annotation for assay gruop information, e.g. this 
    /// assay belongs to a group of assay associated by 
    /// a unique name, e.g. the value assigned to 'assay-group',  
    /// assays belonging to this group can be 
    /// retrieved using this unique name
    /// it is depositor's responsibility to make the name 
    /// distinct if necessary
    /// this can be used as the mechanism to specify 'related bioassays'
    /// before hand so it is not necessary to update the descriptions of
    /// related assays when new group member submitted to PubChem 
    /// Check if a value has been assigned to Assay_group data member.
    ///
    /// Data member Assay_group is optional;
    /// its type is defined as 'typedef list< string > TAssay_group'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAssay_group(void) const;
 
    /// Check if it is safe to call GetAssay_group method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAssay_group(void) const;
 
    /// Reset Assay_group data member.
    void ResetAssay_group(void);
 
    /// Get the Assay_group member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAssay_group& GetAssay_group(void) const;
 
    /// Assign a value to Assay_group data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAssay_group& SetAssay_group(void);
 
    /// for 'panel' type of bioassay only
    /// store assay panel member information
    /// Check if a value has been assigned to Panel_info data member.
    ///
    /// Data member Panel_info is optional;
    /// its type is defined as 'typedef CPC_AssayPanel TPanel_info'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPanel_info(void) const;
 
    /// Check if it is safe to call GetPanel_info method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPanel_info(void) const;
 
    /// Reset Panel_info data member.
    void ResetPanel_info(void);
 
    /// Get the Panel_info member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPanel_info& GetPanel_info(void) const;
 
    /// Assign a value to Panel_info data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetPanel_info(TPanel_info& value);
 
    /// Assign a value to Panel_info data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPanel_info& SetPanel_info(void);
 
    /// verification for 'late-stage-data' deposition
    /// Check if a value has been assigned to Is_mlp_late_stage data member.
    ///
    /// Data member Is_mlp_late_stage is optional;
    /// its type is defined as 'typedef bool TIs_mlp_late_stage'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIs_mlp_late_stage(void) const;
 
    /// Check if it is safe to call GetIs_mlp_late_stage method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIs_mlp_late_stage(void) const;
 
    /// Reset Is_mlp_late_stage data member.
    void ResetIs_mlp_late_stage(void);
 
    /// Get the Is_mlp_late_stage member data.
    ///
    /// @return
    ///   Copy of the member data.
    TIs_mlp_late_stage GetIs_mlp_late_stage(void) const;
 
    /// Assign a value to Is_mlp_late_stage data member.
    ///
    /// @param value
    ///   Value to assign
    void SetIs_mlp_late_stage(TIs_mlp_late_stage value);
 
    /// Assign a value to Is_mlp_late_stage data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIs_mlp_late_stage& SetIs_mlp_late_stage(void);
 
    /// to report categorized description/comment by associating with a category title 
    /// Check if a value has been assigned to Categorized_comment data member.
    ///
    /// Data member Categorized_comment is optional;
    /// its type is defined as 'typedef list< CRef< CPC_CategorizedComment > > TCategorized_comment'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCategorized_comment(void) const;
 
    /// Check if it is safe to call GetCategorized_comment method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCategorized_comment(void) const;
 
    /// Reset Categorized_comment data member.
    void ResetCategorized_comment(void);
 
    /// Get the Categorized_comment member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCategorized_comment& GetCategorized_comment(void) const;
 
    /// Assign a value to Categorized_comment data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCategorized_comment& SetCategorized_comment(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPC_AssayDescription_Base(const CPC_AssayDescription_Base&);
    CPC_AssayDescription_Base& operator=(const CPC_AssayDescription_Base&);
 
    // data
    Uint4 m_set_State[2];
    CRef< TAid > m_Aid;
    CRef< TAid_source > m_Aid_source;
    string m_Name;
    list< string > m_Description;
    list< string > m_Protocol;
    list< string > m_Comment;
    list< CRef< CPC_AnnotatedXRef > > m_Xref;
    vector< CRef< CPC_ResultType > > m_Results;
    list< CRef< CPub > > m_Pub;
    int m_Revision;
    list< CRef< CPC_AssayTargetInfo > > m_Target;
    int m_Activity_outcome_method;
    list< CRef< CPC_AssayDRAttr > > m_Dr;
    int m_Substance_type;
    list< string > m_Grant_number;
    int m_Project_category;
    bool m_Is_panel;
    list< string > m_Assay_group;
    CRef< TPanel_info > m_Panel_info;
    bool m_Is_mlp_late_stage;
    list< CRef< CPC_CategorizedComment > > m_Categorized_comment;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPC_AssayDescription_Base::IsSetAid(void) const
{
    return m_Aid.NotEmpty();
}
 
inline
bool CPC_AssayDescription_Base::CanGetAid(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TAid& CPC_AssayDescription_Base::GetAid(void) const
{
    if ( !m_Aid ) {
        const_cast<CPC_AssayDescription_Base*>(this)->ResetAid();
    }
    return (*m_Aid);
}
 
inline
CPC_AssayDescription_Base::TAid& CPC_AssayDescription_Base::SetAid(void)
{
    if ( !m_Aid ) {
        ResetAid();
    }
    return (*m_Aid);
}
 
inline
bool CPC_AssayDescription_Base::IsSetAid_source(void) const
{
    return m_Aid_source.NotEmpty();
}
 
inline
bool CPC_AssayDescription_Base::CanGetAid_source(void) const
{
    return IsSetAid_source();
}
 
inline
const CPC_AssayDescription_Base::TAid_source& CPC_AssayDescription_Base::GetAid_source(void) const
{
    if (!CanGetAid_source()) {
        ThrowUnassigned(1);
    }
    return (*m_Aid_source);
}
 
inline
bool CPC_AssayDescription_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CPC_AssayDescription_Base::TName& CPC_AssayDescription_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(2);
    }
    return m_Name;
}
 
inline
void CPC_AssayDescription_Base::SetName(const CPC_AssayDescription_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CPC_AssayDescription_Base::SetName(CPC_AssayDescription_Base::TName&& value)
{
    m_Name = std::forward<CPC_AssayDescription_Base::TName>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CPC_AssayDescription_Base::TName& CPC_AssayDescription_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Name;
}
 
inline
bool CPC_AssayDescription_Base::IsSetDescription(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetDescription(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TDescription& CPC_AssayDescription_Base::GetDescription(void) const
{
    return m_Description;
}
 
inline
CPC_AssayDescription_Base::TDescription& CPC_AssayDescription_Base::SetDescription(void)
{
    m_set_State[0] |= 0x40;
    return m_Description;
}
 
inline
bool CPC_AssayDescription_Base::IsSetProtocol(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetProtocol(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TProtocol& CPC_AssayDescription_Base::GetProtocol(void) const
{
    return m_Protocol;
}
 
inline
CPC_AssayDescription_Base::TProtocol& CPC_AssayDescription_Base::SetProtocol(void)
{
    m_set_State[0] |= 0x100;
    return m_Protocol;
}
 
inline
bool CPC_AssayDescription_Base::IsSetComment(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetComment(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TComment& CPC_AssayDescription_Base::GetComment(void) const
{
    return m_Comment;
}
 
inline
CPC_AssayDescription_Base::TComment& CPC_AssayDescription_Base::SetComment(void)
{
    m_set_State[0] |= 0x400;
    return m_Comment;
}
 
inline
bool CPC_AssayDescription_Base::IsSetXref(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetXref(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TXref& CPC_AssayDescription_Base::GetXref(void) const
{
    return m_Xref;
}
 
inline
CPC_AssayDescription_Base::TXref& CPC_AssayDescription_Base::SetXref(void)
{
    m_set_State[0] |= 0x1000;
    return m_Xref;
}
 
inline
bool CPC_AssayDescription_Base::IsSetResults(void) const
{
    return ((m_set_State[0] & 0xc000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetResults(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TResults& CPC_AssayDescription_Base::GetResults(void) const
{
    return m_Results;
}
 
inline
CPC_AssayDescription_Base::TResults& CPC_AssayDescription_Base::SetResults(void)
{
    m_set_State[0] |= 0x4000;
    return m_Results;
}
 
inline
bool CPC_AssayDescription_Base::IsSetPub(void) const
{
    return ((m_set_State[0] & 0x30000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetPub(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TPub& CPC_AssayDescription_Base::GetPub(void) const
{
    return m_Pub;
}
 
inline
CPC_AssayDescription_Base::TPub& CPC_AssayDescription_Base::SetPub(void)
{
    m_set_State[0] |= 0x10000;
    return m_Pub;
}
 
inline
bool CPC_AssayDescription_Base::IsSetRevision(void) const
{
    return ((m_set_State[0] & 0xc0000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetRevision(void) const
{
    return IsSetRevision();
}
 
inline
void CPC_AssayDescription_Base::ResetRevision(void)
{
    m_Revision = 0;
    m_set_State[0] &= ~0xc0000;
}
 
inline
CPC_AssayDescription_Base::TRevision CPC_AssayDescription_Base::GetRevision(void) const
{
    if (!CanGetRevision()) {
        ThrowUnassigned(9);
    }
    return m_Revision;
}
 
inline
void CPC_AssayDescription_Base::SetRevision(CPC_AssayDescription_Base::TRevision value)
{
    m_Revision = value;
    m_set_State[0] |= 0xc0000;
}
 
inline
CPC_AssayDescription_Base::TRevision& CPC_AssayDescription_Base::SetRevision(void)
{
#ifdef _DEBUG
    if (!IsSetRevision()) {
        memset(&m_Revision,UnassignedByte(),sizeof(m_Revision));
    }
#endif
    m_set_State[0] |= 0x40000;
    return m_Revision;
}
 
inline
bool CPC_AssayDescription_Base::IsSetTarget(void) const
{
    return ((m_set_State[0] & 0x300000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetTarget(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TTarget& CPC_AssayDescription_Base::GetTarget(void) const
{
    return m_Target;
}
 
inline
CPC_AssayDescription_Base::TTarget& CPC_AssayDescription_Base::SetTarget(void)
{
    m_set_State[0] |= 0x100000;
    return m_Target;
}
 
inline
bool CPC_AssayDescription_Base::IsSetActivity_outcome_method(void) const
{
    return ((m_set_State[0] & 0xc00000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetActivity_outcome_method(void) const
{
    return IsSetActivity_outcome_method();
}
 
inline
void CPC_AssayDescription_Base::ResetActivity_outcome_method(void)
{
    m_Activity_outcome_method = (EActivity_outcome_method)(0);
    m_set_State[0] &= ~0xc00000;
}
 
inline
CPC_AssayDescription_Base::TActivity_outcome_method CPC_AssayDescription_Base::GetActivity_outcome_method(void) const
{
    if (!CanGetActivity_outcome_method()) {
        ThrowUnassigned(11);
    }
    return m_Activity_outcome_method;
}
 
inline
void CPC_AssayDescription_Base::SetActivity_outcome_method(CPC_AssayDescription_Base::TActivity_outcome_method value)
{
    m_Activity_outcome_method = value;
    m_set_State[0] |= 0xc00000;
}
 
inline
CPC_AssayDescription_Base::TActivity_outcome_method& CPC_AssayDescription_Base::SetActivity_outcome_method(void)
{
#ifdef _DEBUG
    if (!IsSetActivity_outcome_method()) {
        memset(&m_Activity_outcome_method,UnassignedByte(),sizeof(m_Activity_outcome_method));
    }
#endif
    m_set_State[0] |= 0x400000;
    return m_Activity_outcome_method;
}
 
inline
bool CPC_AssayDescription_Base::IsSetDr(void) const
{
    return ((m_set_State[0] & 0x3000000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetDr(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TDr& CPC_AssayDescription_Base::GetDr(void) const
{
    return m_Dr;
}
 
inline
CPC_AssayDescription_Base::TDr& CPC_AssayDescription_Base::SetDr(void)
{
    m_set_State[0] |= 0x1000000;
    return m_Dr;
}
 
inline
bool CPC_AssayDescription_Base::IsSetSubstance_type(void) const
{
    return ((m_set_State[0] & 0xc000000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetSubstance_type(void) const
{
    return IsSetSubstance_type();
}
 
inline
void CPC_AssayDescription_Base::ResetSubstance_type(void)
{
    m_Substance_type = (ESubstance_type)(0);
    m_set_State[0] &= ~0xc000000;
}
 
inline
CPC_AssayDescription_Base::TSubstance_type CPC_AssayDescription_Base::GetSubstance_type(void) const
{
    if (!CanGetSubstance_type()) {
        ThrowUnassigned(13);
    }
    return m_Substance_type;
}
 
inline
void CPC_AssayDescription_Base::SetSubstance_type(CPC_AssayDescription_Base::TSubstance_type value)
{
    m_Substance_type = value;
    m_set_State[0] |= 0xc000000;
}
 
inline
CPC_AssayDescription_Base::TSubstance_type& CPC_AssayDescription_Base::SetSubstance_type(void)
{
#ifdef _DEBUG
    if (!IsSetSubstance_type()) {
        memset(&m_Substance_type,UnassignedByte(),sizeof(m_Substance_type));
    }
#endif
    m_set_State[0] |= 0x4000000;
    return m_Substance_type;
}
 
inline
bool CPC_AssayDescription_Base::IsSetGrant_number(void) const
{
    return ((m_set_State[0] & 0x30000000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetGrant_number(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TGrant_number& CPC_AssayDescription_Base::GetGrant_number(void) const
{
    return m_Grant_number;
}
 
inline
CPC_AssayDescription_Base::TGrant_number& CPC_AssayDescription_Base::SetGrant_number(void)
{
    m_set_State[0] |= 0x10000000;
    return m_Grant_number;
}
 
inline
bool CPC_AssayDescription_Base::IsSetProject_category(void) const
{
    return ((m_set_State[0] & 0xc0000000) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetProject_category(void) const
{
    return IsSetProject_category();
}
 
inline
void CPC_AssayDescription_Base::ResetProject_category(void)
{
    m_Project_category = (EProject_category)(0);
    m_set_State[0] &= ~0xc0000000;
}
 
inline
CPC_AssayDescription_Base::TProject_category CPC_AssayDescription_Base::GetProject_category(void) const
{
    if (!CanGetProject_category()) {
        ThrowUnassigned(15);
    }
    return m_Project_category;
}
 
inline
void CPC_AssayDescription_Base::SetProject_category(CPC_AssayDescription_Base::TProject_category value)
{
    m_Project_category = value;
    m_set_State[0] |= 0xc0000000;
}
 
inline
CPC_AssayDescription_Base::TProject_category& CPC_AssayDescription_Base::SetProject_category(void)
{
#ifdef _DEBUG
    if (!IsSetProject_category()) {
        memset(&m_Project_category,UnassignedByte(),sizeof(m_Project_category));
    }
#endif
    m_set_State[0] |= 0x40000000;
    return m_Project_category;
}
 
inline
bool CPC_AssayDescription_Base::IsSetIs_panel(void) const
{
    return ((m_set_State[1] & 0x3) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetIs_panel(void) const
{
    return IsSetIs_panel();
}
 
inline
void CPC_AssayDescription_Base::ResetIs_panel(void)
{
    m_Is_panel = 0;
    m_set_State[1] &= ~0x3;
}
 
inline
CPC_AssayDescription_Base::TIs_panel CPC_AssayDescription_Base::GetIs_panel(void) const
{
    if (!CanGetIs_panel()) {
        ThrowUnassigned(16);
    }
    return m_Is_panel;
}
 
inline
void CPC_AssayDescription_Base::SetIs_panel(CPC_AssayDescription_Base::TIs_panel value)
{
    m_Is_panel = value;
    m_set_State[1] |= 0x3;
}
 
inline
CPC_AssayDescription_Base::TIs_panel& CPC_AssayDescription_Base::SetIs_panel(void)
{
#ifdef _DEBUG
    if (!IsSetIs_panel()) {
        memset(&m_Is_panel,UnassignedByte(),sizeof(m_Is_panel));
    }
#endif
    m_set_State[1] |= 0x1;
    return m_Is_panel;
}
 
inline
bool CPC_AssayDescription_Base::IsSetAssay_group(void) const
{
    return ((m_set_State[1] & 0xc) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetAssay_group(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TAssay_group& CPC_AssayDescription_Base::GetAssay_group(void) const
{
    return m_Assay_group;
}
 
inline
CPC_AssayDescription_Base::TAssay_group& CPC_AssayDescription_Base::SetAssay_group(void)
{
    m_set_State[1] |= 0x4;
    return m_Assay_group;
}
 
inline
bool CPC_AssayDescription_Base::IsSetPanel_info(void) const
{
    return m_Panel_info.NotEmpty();
}
 
inline
bool CPC_AssayDescription_Base::CanGetPanel_info(void) const
{
    return IsSetPanel_info();
}
 
inline
const CPC_AssayDescription_Base::TPanel_info& CPC_AssayDescription_Base::GetPanel_info(void) const
{
    if (!CanGetPanel_info()) {
        ThrowUnassigned(18);
    }
    return (*m_Panel_info);
}
 
inline
bool CPC_AssayDescription_Base::IsSetIs_mlp_late_stage(void) const
{
    return ((m_set_State[1] & 0xc0) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetIs_mlp_late_stage(void) const
{
    return IsSetIs_mlp_late_stage();
}
 
inline
void CPC_AssayDescription_Base::ResetIs_mlp_late_stage(void)
{
    m_Is_mlp_late_stage = 0;
    m_set_State[1] &= ~0xc0;
}
 
inline
CPC_AssayDescription_Base::TIs_mlp_late_stage CPC_AssayDescription_Base::GetIs_mlp_late_stage(void) const
{
    if (!CanGetIs_mlp_late_stage()) {
        ThrowUnassigned(19);
    }
    return m_Is_mlp_late_stage;
}
 
inline
void CPC_AssayDescription_Base::SetIs_mlp_late_stage(CPC_AssayDescription_Base::TIs_mlp_late_stage value)
{
    m_Is_mlp_late_stage = value;
    m_set_State[1] |= 0xc0;
}
 
inline
CPC_AssayDescription_Base::TIs_mlp_late_stage& CPC_AssayDescription_Base::SetIs_mlp_late_stage(void)
{
#ifdef _DEBUG
    if (!IsSetIs_mlp_late_stage()) {
        memset(&m_Is_mlp_late_stage,UnassignedByte(),sizeof(m_Is_mlp_late_stage));
    }
#endif
    m_set_State[1] |= 0x40;
    return m_Is_mlp_late_stage;
}
 
inline
bool CPC_AssayDescription_Base::IsSetCategorized_comment(void) const
{
    return ((m_set_State[1] & 0x300) != 0);
}
 
inline
bool CPC_AssayDescription_Base::CanGetCategorized_comment(void) const
{
    return true;
}
 
inline
const CPC_AssayDescription_Base::TCategorized_comment& CPC_AssayDescription_Base::GetCategorized_comment(void) const
{
    return m_Categorized_comment;
}
 
inline
CPC_AssayDescription_Base::TCategorized_comment& CPC_AssayDescription_Base::SetCategorized_comment(void)
{
    m_set_State[1] |= 0x100;
    return m_Categorized_comment;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_PCASSAY_PC_ASSAYDESCRIPTION_BASE_HPP