Search Toolkit Book for CSeqTable_column_info

#include <objects/seqtable/SeqTable_column_info.hpp>

Inheritance diagram for CSeqTable_column_info:

Collaboration diagram for CSeqTable_column_info:

Public Member Functions
	CSeqTable_column_info (void)

	~CSeqTable_column_info (void)

Public Member Functions inherited from CSeqTable_column_info_Base
	CSeqTable_column_info_Base (void)

virtual	~CSeqTable_column_info_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetTitle (void) const
	user friendly column name, can be skipped Check if a value has been assigned to Title data member. More...

bool	CanGetTitle (void) const
	Check if it is safe to call GetTitle method. More...

void	ResetTitle (void)
	Reset Title data member. More...

const TTitle &	GetTitle (void) const
	Get the Title member data. More...

void	SetTitle (const TTitle &value)
	Assign a value to Title data member. More...

void	SetTitle (TTitle &&value)

TTitle &	SetTitle (void)
	Assign a value to Title data member. More...

bool	IsSetField_id (void) const
	Check if a value has been assigned to Field_id data member. More...

bool	CanGetField_id (void) const
	Check if it is safe to call GetField_id method. More...

void	ResetField_id (void)
	Reset Field_id data member. More...

TField_id	GetField_id (void) const
	Get the Field_id member data. More...

void	SetField_id (TField_id value)
	Assign a value to Field_id data member. More...

TField_id &	SetField_id (void)
	Assign a value to Field_id data member. More...

bool	IsSetField_name (void) const
	any column can be identified by ASN.1 text locator string with omitted object type. More...

bool	CanGetField_name (void) const
	Check if it is safe to call GetField_name method. More...

void	ResetField_name (void)
	Reset Field_name data member. More...

const TField_name &	GetField_name (void) const
	Get the Field_name member data. More...

void	SetField_name (const TField_name &value)
	Assign a value to Field_name data member. More...

void	SetField_name (TField_name &&value)

TField_name &	SetField_name (void)
	Assign a value to Field_name data member. More...

virtual 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 char *	GetNameForId (int id)

static int	GetIdForName (const string &name)

Static Public Member Functions inherited from CSeqTable_column_info_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME()	EField_id (void)
	Access to EField_id'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 CSeqTable_column_info_Base	Tparent

Private Member Functions
	CSeqTable_column_info (const CSeqTable_column_info &value)

CSeqTable_column_info &	operator= (const CSeqTable_column_info &value)

Additional Inherited Members
Public Types inherited from CSeqTable_column_info_Base
enum	EField_id { eField_id_location = 0 , eField_id_location_id = 1 , eField_id_location_gi = 2 , eField_id_location_from = 3 , eField_id_location_to = 4 , eField_id_location_strand = 5 , eField_id_location_fuzz_from_lim = 6 , eField_id_location_fuzz_to_lim = 7 , eField_id_product = 10 , eField_id_product_id = 11 , eField_id_product_gi = 12 , eField_id_product_from = 13 , eField_id_product_to = 14 , eField_id_product_strand = 15 , eField_id_product_fuzz_from_lim = 16 , eField_id_product_fuzz_to_lim = 17 , eField_id_id_local = 20 , eField_id_xref_id_local = 21 , eField_id_partial = 22 , eField_id_comment = 23 , eField_id_title = 24 , eField_id_ext = 25 , eField_id_qual = 26 , eField_id_dbxref = 27 , eField_id_data_imp_key = 30 , eField_id_data_region = 31 , eField_id_data_cdregion_frame = 32 , eField_id_ext_type = 40 , eField_id_qual_qual = 41 , eField_id_qual_val = 42 , eField_id_dbxref_db = 43 , eField_id_dbxref_tag = 44 }
	identification of the column data in the objects described by the table known column data types position types More...

enum class	E_memberIndex { e__allMandatory = 0 , e_title , e_field_id , e_field_name }

typedef string	TTitle

typedef int	TField_id

typedef string	TField_name

typedef Tparent::CMemberIndex< E_memberIndex, 4 >	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...

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

Definition at line 53 of file SeqTable_column_info.hpp.

Member Typedef Documentation

◆ Tparent

typedef CSeqTable_column_info_Base CSeqTable_column_info::Tparent

private

Definition at line 55 of file SeqTable_column_info.hpp.

Constructor & Destructor Documentation

◆ CSeqTable_column_info() [1/2]

CSeqTable_column_info::CSeqTable_column_info ( void )

inline

Definition at line 78 of file SeqTable_column_info.hpp.

◆ ~CSeqTable_column_info()

CSeqTable_column_info::~CSeqTable_column_info ( void )

Definition at line 51 of file SeqTable_column_info.cpp.

◆ CSeqTable_column_info() [2/2]

CSeqTable_column_info::CSeqTable_column_info ( const CSeqTable_column_info & value )

private

Member Function Documentation

◆ GetIdForName()

int CSeqTable_column_info::GetIdForName ( const string & name )

static

Definition at line 142 of file SeqTable_column_info.cpp.

◆ GetNameForId()

const char * CSeqTable_column_info::GetNameForId ( int id )

static

Definition at line 149 of file SeqTable_column_info.cpp.

References s_Field_id_names.

◆ operator=()

CSeqTable_column_info& CSeqTable_column_info::operator= ( const CSeqTable_column_info & value )

private

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

include/objects/seqtable/SeqTable_column_info.hpp
src/objects/seqtable/SeqTable_column_info.cpp

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CSeqTable_column_info() [1/2]

◆ ~CSeqTable_column_info()

◆ CSeqTable_column_info() [2/2]

Member Function Documentation

◆ GetIdForName()

◆ GetNameForId()

◆ operator=()