NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
CGffBaseRecord Class Reference

Search Toolkit Book for CGffBaseRecord

#include <objtools/writers/gff_base_record.hpp>

+ Inheritance diagram for CGffBaseRecord:
+ Collaboration diagram for CGffBaseRecord:

Public Types

typedef map< string, vector< string > > TAttributes
 
typedef TAttributes::iterator TAttrIt
 
typedef TAttributes::const_iterator TAttrCit
 
typedef map< string, stringTScores
 
typedef TScores::iterator TScoreIt
 
typedef TScores::const_iterator TScoreCit
 
- 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CGffBaseRecord (const string &id="")
 
 CGffBaseRecord (const CGffBaseRecord &)
 
virtual ~CGffBaseRecord ()
 
const TAttributesAttributes () const
 
bool AddAttribute (const string &, const string &)
 
bool AddAttributes (const string &, const vector< string > &)
 
bool SetAttribute (const string &, const string &)
 
bool SetAttributes (const string &, const vector< string > &)
 
bool GetAttributes (const string &, vector< string > &) const
 
bool DropAttributes (const string &)
 
void SetSeqId (const string &)
 
void SetMethod (const string &)
 
void SetType (const string &)
 
void SetLocation (unsigned int, unsigned int, ENa_strand=objects::eNa_strand_unknown)
 
void SetStrand (ENa_strand)
 
void SetScore (const CScore &)
 
void SetScore (const std::string &)
 
void SetPhase (unsigned int)
 
virtual string StrSeqId () const
 
virtual string StrMethod () const
 
virtual string StrType () const
 
virtual string StrSeqStart () const
 
virtual string StrSeqStop () const
 
virtual string StrStrand () const
 
virtual string StrScore () const
 
virtual string StrPhase () const
 
virtual string StrAttributes () const
 
bool CanGetLocation () const
 
const CSeq_locGetLocation () const
 
unsigned int SeqStart () const
 
unsigned int SeqStop () const
 
objects::ENa_strand SeqStrand () const
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. 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
 

Protected Member Functions

const stringxEscapedValue (const string &key, const string &value) const
 
const stringxEscapedString (const string &value) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

CRef< CSeq_locm_pLoc
 
string mSeqId
 
string mType
 
string mMethod
 
unsigned int mSeqStart
 
unsigned int mSeqStop
 
string mScore
 
string mStrand
 
optional< intmPhase
 
TAttributes mAttributes
 
TScores mExtraScores
 

Static Protected Attributes

static const char * ATTR_SEPARATOR = ";"
 

Additional Inherited Members

- 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)
 
- 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...
 

Detailed Description

Definition at line 45 of file gff_base_record.hpp.

Member Typedef Documentation

◆ TAttrCit

Definition at line 52 of file gff_base_record.hpp.

◆ TAttributes

Definition at line 50 of file gff_base_record.hpp.

◆ TAttrIt

Definition at line 51 of file gff_base_record.hpp.

◆ TScoreCit

Definition at line 56 of file gff_base_record.hpp.

◆ TScoreIt

Definition at line 55 of file gff_base_record.hpp.

◆ TScores

Definition at line 54 of file gff_base_record.hpp.

Constructor & Destructor Documentation

◆ CGffBaseRecord() [1/2]

CGffBaseRecord::CGffBaseRecord ( const string id = "")

Definition at line 49 of file gff_base_record.cpp.

◆ CGffBaseRecord() [2/2]

CGffBaseRecord::CGffBaseRecord ( const CGffBaseRecord other)

◆ ~CGffBaseRecord()

CGffBaseRecord::~CGffBaseRecord ( )
virtual

Definition at line 82 of file gff_base_record.cpp.

Member Function Documentation

◆ AddAttribute()

bool CGffBaseRecord::AddAttribute ( const string key,
const string value 
)

◆ AddAttributes()

bool CGffBaseRecord::AddAttributes ( const string key,
const vector< string > &  values 
)

◆ Attributes()

const TAttributes& CGffBaseRecord::Attributes ( void  ) const
inline

Definition at line 65 of file gff_base_record.hpp.

References mAttributes.

Referenced by CGtfRecord::StrAttributes(), and CGtfRecord::StrStructibutes().

◆ CanGetLocation()

bool CGffBaseRecord::CanGetLocation ( void  ) const
inline

Definition at line 116 of file gff_base_record.hpp.

References m_pLoc.

Referenced by CGff3Writer::xWriteRecord().

◆ DropAttributes()

bool CGffBaseRecord::DropAttributes ( const string attr)

◆ GetAttributes()

bool CGffBaseRecord::GetAttributes ( const string key,
vector< string > &  value 
) const

◆ GetLocation()

const CSeq_loc& CGffBaseRecord::GetLocation ( void  ) const
inline

Definition at line 117 of file gff_base_record.hpp.

References m_pLoc.

Referenced by CGff3Writer::xWriteRecord().

◆ SeqStart()

unsigned int CGffBaseRecord::SeqStart ( ) const
inline

Definition at line 119 of file gff_base_record.hpp.

References mSeqStart.

◆ SeqStop()

unsigned int CGffBaseRecord::SeqStop ( ) const
inline

Definition at line 120 of file gff_base_record.hpp.

References mSeqStop.

◆ SeqStrand()

ENa_strand CGffBaseRecord::SeqStrand ( ) const

Definition at line 498 of file gff_base_record.cpp.

References eNa_strand_minus, eNa_strand_other, eNa_strand_plus, and mStrand.

◆ SetAttribute()

bool CGffBaseRecord::SetAttribute ( const string key,
const string value 
)

Definition at line 105 of file gff_base_record.cpp.

References AddAttribute(), DropAttributes(), ncbi::grid::netcache::search::fields::key, and rapidjson::value.

Referenced by CGffWriteRecord::CGffWriteRecord(), CGffAlignRecord::FinalizeMatches(), CGtfRecord::MakeChildRecord(), CGtfRecord::SetExonNumber(), CGffFeatureRecord::SetGbKeyFrom(), CGffFeatureRecord::SetLocation(), CGtfRecord::SetPartNumber(), CGvfWriteRecord::x_AssignAttributeEndRange(), CGvfWriteRecord::x_AssignAttributeID(), CGvfWriteRecord::x_AssignAttributeName(), CGvfWriteRecord::x_AssignAttributeParent(), CGvfWriteRecord::x_AssignAttributesCustom(), CGvfWriteRecord::x_AssignAttributeStartRange(), CGvfWriteRecord::x_AssignAttributeVarType(), CGff3Writer::xAssignAlignmentDensegTarget(), CGff3FlybaseWriter::xAssignAlignmentDensegTarget(), CGff3Writer::xAssignAlignmentSplicedTarget(), CGff3FlybaseWriter::xAssignAlignmentSplicedTarget(), CGff3FlybaseWriter::xAssignDefline(), CGff2Writer::xAssignFeatureAttributeException(), CGff2Writer::xAssignFeatureAttributeExonNumber(), CGff2Writer::xAssignFeatureAttributeFunction(), CGff2Writer::xAssignFeatureAttributeGeneBiotype(), CGff2Writer::xAssignFeatureAttributeIsOrdered(), CGff2Writer::xAssignFeatureAttributeMapLoc(), CGff2Writer::xAssignFeatureAttributeModelEvidence(), CGff3Writer::xAssignFeatureAttributeName(), CGff3Writer::xAssignFeatureAttributeNcrnaClass(), CGff3Writer::xAssignFeatureAttributeNote(), CGtfWriter::xAssignFeatureAttributeNote(), CGff2Writer::xAssignFeatureAttributeOldLocusTag(), CGff2Writer::xAssignFeatureAttributePartial(), CGff2Writer::xAssignFeatureAttributeProduct(), CGff2Writer::xAssignFeatureAttributePseudo(), CGff2Writer::xAssignFeatureAttributePseudoGene(), CGff2Writer::xAssignFeatureAttributeRptFamily(), CGvfWriter::xAssignFeatureAttributes(), CGff2Writer::xAssignFeatureAttributesGene(), CGff2Writer::xAssignFeatureAttributesGoMarkup(), CGff3Writer::xAssignFeatureAttributesQualifiers(), CGtfWriter::xAssignFeatureAttributeTranscriptBiotype(), CGff3Writer::xAssignFeatureAttributeTranscriptId(), CGff2Writer::xAssignFeatureAttributeTranslationTable(), CGff3Writer::xAssignFeatureEndpoints(), CGff3Writer::xAssignSourceAttributeGbKey(), CGff3Writer::xAssignSourceAttributeGenome(), CGff3Writer::xAssignSourceAttributeIsCircular(), CGff3Writer::xAssignSourceAttributeMolType(), CGff3Writer::xAssignSourceAttributeName(), CGff3Writer::xAssignSourceAttributesOrgMod(), CGff3Writer::xAssignSourceAttributesSubSource(), CGff3FlybaseWriter::xAssignTaxid(), CGff3Writer::xWriteFeatureCds(), CGff3Writer::xWriteFeatureRna(), CGff3Writer::xWriteFeatureTrna(), and CGff3Writer::xWriteNucleotideFeatureTransSpliced().

◆ SetAttributes()

bool CGffBaseRecord::SetAttributes ( const string key,
const vector< string > &  values 
)

◆ SetLocation()

void CGffBaseRecord::SetLocation ( unsigned int  seqStart,
unsigned int  seqStop,
ENa_strand  seqStrand = objects::eNa_strand_unknown 
)

◆ SetMethod()

void CGffBaseRecord::SetMethod ( const string method)

◆ SetPhase()

void CGffBaseRecord::SetPhase ( unsigned int  phase)

◆ SetScore() [1/2]

void CGffBaseRecord::SetScore ( const CScore score)

◆ SetScore() [2/2]

void CGffBaseRecord::SetScore ( const std::string )

◆ SetSeqId()

void CGffBaseRecord::SetSeqId ( const string seqId)

◆ SetStrand()

void CGffBaseRecord::SetStrand ( ENa_strand  seqStrand)

◆ SetType()

void CGffBaseRecord::SetType ( const string type)

◆ StrAttributes()

string CGffBaseRecord::StrAttributes ( ) const
virtual

◆ StrMethod()

string CGffBaseRecord::StrMethod ( ) const
virtual

◆ StrPhase()

string CGffBaseRecord::StrPhase ( ) const
virtual

◆ StrScore()

string CGffBaseRecord::StrScore ( ) const
virtual

◆ StrSeqId()

string CGffBaseRecord::StrSeqId ( ) const
virtual

◆ StrSeqStart()

string CGffBaseRecord::StrSeqStart ( ) const
virtual

◆ StrSeqStop()

string CGffBaseRecord::StrSeqStop ( ) const
virtual

◆ StrStrand()

string CGffBaseRecord::StrStrand ( ) const
virtual

◆ StrType()

string CGffBaseRecord::StrType ( ) const
virtual

◆ xEscapedString()

const string& CGffBaseRecord::xEscapedString ( const string value) const
inlineprotected

◆ xEscapedValue()

const string & CGffBaseRecord::xEscapedValue ( const string key,
const string value 
) const
protected

Member Data Documentation

◆ ATTR_SEPARATOR

const char * CGffBaseRecord::ATTR_SEPARATOR = ";"
staticprotected

◆ m_pLoc

CRef<CSeq_loc> CGffBaseRecord::m_pLoc
protected

◆ mAttributes

TAttributes CGffBaseRecord::mAttributes
protected

◆ mExtraScores

TScores CGffBaseRecord::mExtraScores
protected

Definition at line 147 of file gff_base_record.hpp.

Referenced by SetScore(), and StrAttributes().

◆ mMethod

string CGffBaseRecord::mMethod
protected

◆ mPhase

optional<int> CGffBaseRecord::mPhase
protected

Definition at line 145 of file gff_base_record.hpp.

Referenced by CGtfRecord::SetCdsPhase(), SetPhase(), and StrPhase().

◆ mScore

string CGffBaseRecord::mScore
protected

◆ mSeqId

string CGffBaseRecord::mSeqId
protected

◆ mSeqStart

unsigned int CGffBaseRecord::mSeqStart
protected

◆ mSeqStop

unsigned int CGffBaseRecord::mSeqStop
protected

◆ mStrand

string CGffBaseRecord::mStrand
protected

Definition at line 144 of file gff_base_record.hpp.

Referenced by SeqStrand(), SetStrand(), and StrStrand().

◆ mType

string CGffBaseRecord::mType
protected

The documentation for this class was generated from the following files:
Modified on Tue May 14 16:21:15 2024 by modify_doxy.py rev. 669887