Represents ASN.1 type Blast4-range defined in file blast.asn

#include <objects/blast/Blast4_range.hpp>

Inheritance diagram for CBlast4_range:

Collaboration diagram for CBlast4_range:

Public Member Functions
	CBlast4_range (void)

	~CBlast4_range (void)

	operator TSeqRange () const
	If all values are set, convert this object into a TSeqRange, otherwise an exception will be thrown. More...

Public Member Functions inherited from CBlast4_range_Base
	CBlast4_range_Base (void)

virtual	~CBlast4_range_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetStart (void) const
	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
	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	IsSetStrand (void) const
	The frame of the range (absent for proteins; -1/1 for nucleotides; -1,-2,-3,1,2,3 for translated sequences) Check if a value has been assigned to Strand data member. More...

bool	CanGetStrand (void) const
	Check if it is safe to call GetStrand method. More...

void	ResetStrand (void)
	Reset Strand data member. More...

TStrand	GetStrand (void) const
	Get the Strand member data. More...

void	SetStrand (TStrand value)
	Assign a value to Strand data member. More...

TStrand &	SetStrand (void)
	Assign a value to Strand 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

Private Types
typedef CBlast4_range_Base	Tparent

Private Member Functions
	CBlast4_range (const CBlast4_range &value)

CBlast4_range &	operator= (const CBlast4_range &value)

Additional Inherited Members
Public Types inherited from CBlast4_range_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_start , e_end , e_strand }

typedef int	TStart

typedef int	TEnd

typedef int	TStrand

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

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 54 of file Blast4_range.hpp.

Member Typedef Documentation

◆ Tparent

typedef CBlast4_range_Base CBlast4_range::Tparent

private

Definition at line 56 of file Blast4_range.hpp.

Constructor & Destructor Documentation

◆ CBlast4_range() [1/2]

CBlast4_range::CBlast4_range ( void )

inline

Definition at line 80 of file Blast4_range.hpp.

◆ ~CBlast4_range()

CBlast4_range::~CBlast4_range ( void )

Definition at line 50 of file Blast4_range.cpp.

◆ CBlast4_range() [2/2]

CBlast4_range::CBlast4_range ( const CBlast4_range & value )

private

Member Function Documentation

◆ operator TSeqRange()

CBlast4_range::operator TSeqRange ( ) const

inline

If all values are set, convert this object into a TSeqRange, otherwise an exception will be thrown.

Definition at line 65 of file Blast4_range.hpp.

References CBlast4_range_Base::GetEnd(), and CBlast4_range_Base::GetStart().

◆ operator=()

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

private

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

include/objects/blast/Blast4_range.hpp
src/objects/blast/Blast4_range.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CBlast4_range() [1/2]

◆ ~CBlast4_range()

◆ CBlast4_range() [2/2]

Member Function Documentation

◆ operator TSeqRange()

◆ operator=()