CComponent_Base::C_Attlist Class Reference

Search Toolkit Book for CComponent_Base::C_Attlist

C_Attlist –. More...

#include <objects/docsum/Component_.hpp>

Inheritance diagram for CComponent_Base::C_Attlist:

Collaboration diagram for CComponent_Base::C_Attlist:

Public Types
enum	EAttlist_componentType { eAttlist_componentType_contig = 1 , eAttlist_componentType_mrna = 2 }
	type of component: chromosome, contig, gene_region, etc. More...
enum	EAttlist_orientation { eAttlist_orientation_fwd = 1 , eAttlist_orientation_rev = 2 , eAttlist_orientation_unknown = 3 }
	orientation of this component to chromosome, forward (fwd) = 0, reverse (rev) = 1, unknown = NULL in ContigInfo.orient. More...
enum class	E_memberIndex {   e__allMandatory = 0 , e_componentType , e_ctgId , e_accession ,   e_name , e_chromosome , e_start , e_end ,   e_orientation , e_gi , e_groupTerm , e_contigLabel }
typedef EAttlist_componentType	TComponentType
typedef int	TCtgId
typedef string	TAccession
typedef string	TName
typedef string	TChromosome
typedef int	TStart
typedef int	TEnd
typedef EAttlist_orientation	TOrientation
typedef string	TGi
typedef string	TGroupTerm
typedef string	TContigLabel
typedef Tparent::CMemberIndex< E_memberIndex, 12 >	TmemberIndex
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...
typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...
typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...
typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	C_Attlist (void)
	~C_Attlist (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetComponentType (void) const
	Check if a value has been assigned to ComponentType data member. More...
bool	CanGetComponentType (void) const
	Check if it is safe to call GetComponentType method. More...
void	ResetComponentType (void)
	Reset ComponentType data member. More...
TComponentType	GetComponentType (void) const
	Get the ComponentType member data. More...
void	SetComponentType (TComponentType value)
	Assign a value to ComponentType data member. More...
TComponentType &	SetComponentType (void)
	Assign a value to ComponentType data member. More...
bool	IsSetCtgId (void) const
	dbSNP contig_id used to join on contig hit / mapset data to these assembly properties Check if a value has been assigned to CtgId data member. More...
bool	CanGetCtgId (void) const
	Check if it is safe to call GetCtgId method. More...
void	ResetCtgId (void)
	Reset CtgId data member. More...
TCtgId	GetCtgId (void) const
	Get the CtgId member data. More...
void	SetCtgId (TCtgId value)
	Assign a value to CtgId data member. More...
TCtgId &	SetCtgId (void)
	Assign a value to CtgId data member. More...
bool	IsSetAccession (void) const
	Accession[.version] for the sequence component Check if a value has been assigned to Accession data member. More...
bool	CanGetAccession (void) const
	Check if it is safe to call GetAccession method. More...
void	ResetAccession (void)
	Reset Accession data member. More...
const TAccession &	GetAccession (void) const
	Get the Accession member data. More...
void	SetAccession (const TAccession &value)
	Assign a value to Accession data member. More...
void	SetAccession (TAccession &&value)
TAccession &	SetAccession (void)
	Assign a value to Accession data member. More...
bool	IsSetName (void) const
	contig name defined as either a submitter local id, element of a whole genome assembly set, or internal NCBI local id Check if a value has been assigned to Name data member. More...
bool	CanGetName (void) const
	Check if it is safe to call GetName method. More...
void	ResetName (void)
	Reset Name data member. More...
const TName &	GetName (void) const
	Get the Name member data. More...
void	SetName (const TName &value)
	Assign a value to Name data member. More...
void	SetName (TName &&value)
TName &	SetName (void)
	Assign a value to Name data member. More...
bool	IsSetChromosome (void) const
	Organism appropriate chromosome tag, 'Un' reserved for default case of unplaced components Check if a value has been assigned to Chromosome data member. More...
bool	CanGetChromosome (void) const
	Check if it is safe to call GetChromosome method. More...
void	ResetChromosome (void)
	Reset Chromosome data member. More...
const TChromosome &	GetChromosome (void) const
	Get the Chromosome member data. More...
void	SetChromosome (const TChromosome &value)
	Assign a value to Chromosome data member. More...
void	SetChromosome (TChromosome &&value)
TChromosome &	SetChromosome (void)
	Assign a value to Chromosome data member. More...
bool	IsSetStart (void) const
	component starting position on the chromosome (base 0 inclusive) Check if a value has been assigned to Start data member. More...
bool	CanGetStart (void) const
	Check if it is safe to call GetStart method. More...
void	ResetStart (void)
	Reset Start data member. More...
TStart	GetStart (void) const
	Get the Start member data. More...
void	SetStart (TStart value)
	Assign a value to Start data member. More...
TStart &	SetStart (void)
	Assign a value to Start data member. More...
bool	IsSetEnd (void) const
	component ending position on the chromosome (base 0 inclusive) Check if a value has been assigned to End data member. More...
bool	CanGetEnd (void) const
	Check if it is safe to call GetEnd method. More...
void	ResetEnd (void)
	Reset End data member. More...
TEnd	GetEnd (void) const
	Get the End member data. More...
void	SetEnd (TEnd value)
	Assign a value to End data member. More...
TEnd &	SetEnd (void)
	Assign a value to End data member. More...
bool	IsSetOrientation (void) const
	Check if a value has been assigned to Orientation data member. More...
bool	CanGetOrientation (void) const
	Check if it is safe to call GetOrientation method. More...
void	ResetOrientation (void)
	Reset Orientation data member. More...
TOrientation	GetOrientation (void) const
	Get the Orientation member data. More...
void	SetOrientation (TOrientation value)
	Assign a value to Orientation data member. More...
TOrientation &	SetOrientation (void)
	Assign a value to Orientation data member. More...
bool	IsSetGi (void) const
	NCBI gi for component sequence (equivalent to accession.version) for nucleotide sequence. More...
bool	CanGetGi (void) const
	Check if it is safe to call GetGi method. More...
void	ResetGi (void)
	Reset Gi data member. More...
const TGi &	GetGi (void) const
	Get the Gi member data. More...
void	SetGi (const TGi &value)
	Assign a value to Gi data member. More...
void	SetGi (TGi &&value)
TGi &	SetGi (void)
	Assign a value to Gi data member. More...
bool	IsSetGroupTerm (void) const
	Identifier label for the genome assembly that defines the contigs in this mapset and their placement within the organism genome. More...
bool	CanGetGroupTerm (void) const
	Check if it is safe to call GetGroupTerm method. More...
void	ResetGroupTerm (void)
	Reset GroupTerm data member. More...
const TGroupTerm &	GetGroupTerm (void) const
	Get the GroupTerm member data. More...
void	SetGroupTerm (const TGroupTerm &value)
	Assign a value to GroupTerm data member. More...
void	SetGroupTerm (TGroupTerm &&value)
TGroupTerm &	SetGroupTerm (void)
	Assign a value to GroupTerm data member. More...
bool	IsSetContigLabel (void) const
	Display label for component Check if a value has been assigned to ContigLabel data member. More...
bool	CanGetContigLabel (void) const
	Check if it is safe to call GetContigLabel method. More...
void	ResetContigLabel (void)
	Reset ContigLabel data member. More...
const TContigLabel &	GetContigLabel (void) const
	Get the ContigLabel member data. More...
void	SetContigLabel (const TContigLabel &value)
	Assign a value to ContigLabel data member. More...
void	SetContigLabel (TContigLabel &&value)
TContigLabel &	SetContigLabel (void)
	Assign a value to ContigLabel data member. More...
void	Reset (void)
	Reset the whole object. More...
Public Member Functions inherited from CSerialObject
	CSerialObject (void)
virtual	~CSerialObject (void)
virtual const CTypeInfo *	GetThisTypeInfo (void) const =0
virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...
virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...
virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...
void	ThrowUnassigned (TMemberIndex index) const
void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...
const string &	GetNamespaceName (void) const
	Get namespace name. More...
bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...
const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...
Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...
	CObject (const CObject &src)
	Copy constructor. More...
virtual	~CObject (void)
	Destructor. More...
CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...
bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...
bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...
bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...
bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...
void	AddReference (void) const
	Add reference to object. More...
void	RemoveReference (void) const
	Remove reference to object. More...
void	ReleaseReference (void) const
	Remove reference without deleting object. More...
virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...
virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...
void *	operator new (size_t size)
	Define new operator for memory allocation. More...
void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...
void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...
void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...
void *	operator new (size_t size, void *place)
	Define new operator. More...
void	operator delete (void *ptr, void *place)
	Define delete operator. More...
void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...
void	operator delete (void *ptr, CObjectMemoryPool *place)
	Define delete operator. More...
Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)
virtual	~CDebugDumpable (void)
void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
void	DumpToConsole (void) const

Static Public Member Functions
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME()	EAttlist_componentType (void)
	Access to EAttlist_componentType's attributes (values, names) as defined in spec. More...
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME()	EAttlist_orientation (void)
	Access to EAttlist_orientation's attributes (values, names) as defined in spec. More...
Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)
static void	SetVerifyDataGlobal (ESerialVerifyData verify)
static string	UnassignedString (void)
static CStringUTF8	UnassignedStringUTF8 (void)
static char	UnassignedByte (void)
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)
static EAllocFillMode	GetAllocFillMode (void)
static void	SetAllocFillMode (EAllocFillMode mode)
static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...
Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)

Private Types
typedef CSerialObject	Tparent

Private Member Functions
	C_Attlist (const C_Attlist &)
C_Attlist &	operator= (const C_Attlist &)

Private Attributes
Uint4	m_set_State [1]
EAttlist_componentType	m_ComponentType
int	m_CtgId
string	m_Accession
string	m_Name
string	m_Chromosome
int	m_Start
int	m_End
EAttlist_orientation	m_Orientation
string	m_Gi
string	m_GroupTerm
string	m_ContigLabel

Additional Inherited Members
Static Public Attributes inherited from CSerialObject
static const char *	ms_UnassignedStr = "<*unassigned*>"
static const char	ms_UnassignedByte = char(0xcd)
Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...
static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...
static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...
static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...
static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
static const TCount	eCounterStateMask
	Valid object, and object in heap. More...
Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

C_Attlist –.

Definition at line 94 of file Component_.hpp.

---

The documentation for this class was generated from the following files:

• include/objects/docsum/Component_.hpp
• src/objects/docsum/Component_.cpp