NCBI C++ ToolKit
GC_AssemblyUnit.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id: GC_AssemblyUnit.hpp 82628 2018-06-18 15:43:23Z mozese2 $
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file GC_AssemblyUnit.hpp
29 /// User-defined methods of the data storage class.
30 ///
31 /// This file was originally generated by application DATATOOL
32 /// using the following specifications:
33 /// 'genome_collection.asn'.
34 ///
35 /// New methods or data members can be added to it if needed.
36 /// See also: GC_AssemblyUnit_.hpp
37 
38 
39 #ifndef INTERNAL_GPIPE_OBJECTS_GENOMECOLL_GC_ASSEMBLYUNIT_HPP
40 #define INTERNAL_GPIPE_OBJECTS_GENOMECOLL_GC_ASSEMBLYUNIT_HPP
41 
42 
43 // generated includes
45 
46 // generated classes
47 
49 
50 BEGIN_objects_SCOPE // namespace ncbi::objects::
51 
52 class CGC_Assembly;
53 
54 /////////////////////////////////////////////////////////////////////////////
56 {
58  friend class CGC_Assembly;
59 public:
60  // constructor
61  CGC_AssemblyUnit(void);
62  // destructor
63  ~CGC_AssemblyUnit(void);
64 
65  /// Retrieve this unit's name
66  string GetName() const;
67 
68  /// Retrieve this unit's accession
69  string GetAccession() const;
70 
71  /// Get full display name of assembly unit
72  string GetDisplayName() const;
73 
74  /// Retrieve the file-safe version of assembly name, if available;
75  /// othwreise default to standard name
76  string GetFileSafeName() const;
77 
78  /// Get file-safe version of full label for assmebly
79  string GetFileSafeDisplayName() const;
80 
81 
82  /// Retrieve the release id for this assembly
83  int GetReleaseId() const;
84 
85  /// Access the most specific full assembly the assembly unit belongs to
86  /// This is needed because assemblies are packaged as sets of assemblies;
87  /// knowing the unit is not always enough
88  CConstRef<CGC_Assembly> GetFullAssembly() const;
89 
90  /// Is this the primary unit of its full assembly?
91  bool IsPrimaryUnit() const;
92  //
93  /// Is this a non-nuclear assembly unit?
94  bool IsOrganelle() const;
95 
96 protected:
98 
99 private:
100  // Prohibit copy constructor and assignment operator
103 
104 };
105 
106 /////////////////// CGC_AssemblyUnit inline methods
107 
108 /////////////////// end of CGC_AssemblyUnit inline methods
109 
110 
111 END_objects_SCOPE // namespace ncbi::objects::
112 
114 
115 
116 #endif // INTERNAL_GPIPE_OBJECTS_GENOMECOLL_GC_ASSEMBLYUNIT_HPP
117 /* Original file checksum: lines: 86, chars: 2622, CRC32: 3a202f4e */
Data storage class.
CGC_AssemblyUnit_Base –.
CGC_AssemblyUnit & operator=(const CGC_AssemblyUnit &value)
CGC_AssemblyUnit(const CGC_AssemblyUnit &value)
CGC_Assembly * m_Assembly
CGC_AssemblyUnit_Base Tparent
string GetName() const
Retrieve the name of this assembly.
string GetFileSafeName() const
Retrieve the file-safe version of assembly name, if available; othwreise default to standard name.
string GetFileSafeDisplayName() const
Get file-safe version of full label for assmebly.
int GetReleaseId() const
Retrieve the release id for this assembly.
Definition: GC_Assembly.cpp:84
string GetDisplayName() const
Get full label for assmebly; if this is a unit, full assembly name followed by unit name.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_GENOME_COLLECTION_EXPORT
Definition: ncbi_export.h:528
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
const CConstRef< CSeq_id > GetAccession(const CSeq_id_Handle &id_handle)
bool IsOrganelle(int genome)
Definition: utilities.cpp:2831
Modified on Sun Apr 14 05:28:26 2024 by modify_doxy.py rev. 669887