#include <objects/valid/Comment_set.hpp>

Inheritance diagram for CComment_set:

Collaboration diagram for CComment_set:

Public Member Functions
	CComment_set (void)

	~CComment_set (void)

const CComment_rule &	FindCommentRule (const string &prefix) const

CConstRef< CComment_rule >	FindCommentRuleEx (const string &prefix) const

Public Member Functions inherited from CComment_set_Base
	CComment_set_Base (void)

virtual	~CComment_set_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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

bool	CanGet (void) const
	Check if it is safe to call Get method. More...

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

const Tdata &	Get (void) const
	Get the member data. More...

Tdata &	Set (void)
	Assign a value to data member. More...

	operator const Tdata & (void) const
	Conversion operator to 'const Tdata' type. More...

	operator Tdata & (void)
	Conversion operator to 'Tdata' type. 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 CConstRef< CComment_set >	GetCommentRules ()

static vector< string >	GetFieldNames (const string &prefix)

static list< string >	GetKeywords (const CUser_object &user)

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 CComment_set_Base	Tparent

Private Member Functions
	CComment_set (const CComment_set &value)

CComment_set &	operator= (const CComment_set &value)

Additional Inherited Members
Public Types inherited from CComment_set_Base
typedef list< CRef< CComment_rule > >	Tdata

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

Member Typedef Documentation

◆ Tparent

typedef CComment_set_Base CComment_set::Tparent

private

Definition at line 56 of file Comment_set.hpp.

Constructor & Destructor Documentation

◆ CComment_set() [1/2]

CComment_set::CComment_set ( void )

inline

Definition at line 81 of file Comment_set.hpp.

◆ ~CComment_set()

CComment_set::~CComment_set ( void )

Definition at line 58 of file Comment_set.cpp.

◆ CComment_set() [2/2]

CComment_set::CComment_set ( const CComment_set & value )

private

Member Function Documentation

◆ FindCommentRule()

const CComment_rule & CComment_set::FindCommentRule ( const string & prefix ) const

Definition at line 81 of file Comment_set.cpp.

References FindCommentRuleEx(), and NCBI_THROW.

◆ FindCommentRuleEx()

CConstRef< CComment_rule > CComment_set::FindCommentRuleEx ( const string & prefix ) const

Definition at line 62 of file Comment_set.cpp.

References NStr::EqualNocase(), CComment_set_Base::Get(), CComment_rule_Base::GetPrefix(), ITERATE, and CComment_rule::NormalizePrefix().

Referenced by FindCommentRule().

◆ GetCommentRules()

CConstRef< CComment_set > CComment_set::GetCommentRules ( )

static

Definition at line 142 of file Comment_set.cpp.

References s_InitializeStructuredCommentRules().

Referenced by CReorderStructuredComment::apply(), BOOST_AUTO_TEST_CASE(), CSequencingTechnologyPanel::CreateControls(), CStructuredCommentPanel::CreateControls(), GetFieldNames(), GetKeywords(), CStructuredCommentField::IsValid(), CStructuredCommentField::ReorderFields(), CCleanup::s_CleanupStructuredComment(), CNewCleanup_imp::x_FixStructuredCommentKeywords(), CKeywordsItem::x_GatherInfo(), and CValidError_desc::x_ValidateStructuredComment().

◆ GetFieldNames()

vector< string > CComment_set::GetFieldNames ( const string & prefix )

static

Definition at line 149 of file Comment_set.cpp.

References CField_set_Base::Get(), GetCommentRules(), CComment_rule_Base::GetFields(), ITERATE, and CComment_rule::MakePrefixFromRoot().

Referenced by BOOST_AUTO_TEST_CASE(), CStructuredCommentField::x_InsertFieldAtCorrectPosition(), and CStructCommFieldValuePair::x_InsertFieldAtCorrectPosition().

◆ GetKeywords()

list< string > CComment_set::GetKeywords ( const CUser_object & user )

static

Definition at line 172 of file Comment_set.cpp.

References NStr::fSplit_Tokenize, GetCommentRules(), CComment_rule::GetStructuredCommentPrefix(), CComment_rule::IsValid(), CComment_rule::KeywordForPrefix(), CComment_rule::MakePrefixFromRoot(), and NStr::Split().

Referenced by CKeywordsItem::x_GatherInfo().

◆ operator=()

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

private

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

include/objects/valid/Comment_set.hpp
src/objects/valid/Comment_set.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

◆ CComment_set() [1/2]

◆ ~CComment_set()

◆ CComment_set() [2/2]

Member Function Documentation

◆ FindCommentRule()

◆ FindCommentRuleEx()

◆ GetCommentRules()

◆ GetFieldNames()

◆ GetKeywords()

◆ operator=()