Represents ASN.1 type User-field defined in file general.asn

#include <objects/general/User_field.hpp>

Inheritance diagram for CUser_field:

Collaboration diagram for CUser_field:

Classes
struct	SFieldNameChain
	For functions that don't use delims, we instead use a chain of names. More...

Public Types
enum	EParseField { eParse_String , eParse_Number }

enum	EFieldMapFlags { fFieldMapFlags_ExcludeThis = (1<<0) }
	Flags that affect behavior of TMapFieldNameToRef functions. More...

typedef map< SFieldNameChain, CConstRef< CUser_field > >	TMapFieldNameToRef
	Maps field names like the input for GetFieldRef to the user-field. More...

typedef int	TFieldMapFlags
	holds bitwise OR of "EFieldMapFlags" More...

Public Types inherited from CUser_field_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_label , e_num , e_data }

typedef CObject_id	TLabel

typedef int	TNum

typedef C_Data	TData

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

Public Member Functions
	CUser_field (void)

	~CUser_field (void)

CUser_field &	SetInt (int value)
	set value More...

CUser_field &	SetInt8 (Int8 value)

CUser_field &	SetGi (TGi gi)

CUser_field &	SetDouble (double value)

CUser_field &	SetBool (bool value)

CUser_field &	SetString (const char *value)

CUser_field &	SetString (const string &value)

CUser_field &	SetValue (int value)
	set a data field to a given value Int8 and TGi values can be stored into 'str' field if the value doesn't fit into 'int' field More...

CUser_field &	SetValue (Int8 value)

CUser_field &	SetValue (TGi value)

CUser_field &	SetValue (double value)

CUser_field &	SetValue (bool value)

CUser_field &	SetValue (const char *value)

CUser_field &	SetValue (const string &value)

CUser_field &	SetValue (const char *value, EParseField parse)

CUser_field &	SetValue (const string &value, EParseField parse)

CUser_field &	SetValue (const vector< int > &value)

CUser_field &	SetValue (const vector< double > &value)

CUser_field &	SetValue (const vector< string > &value)

CUser_field &	SetValue (CUser_object &value)

CUser_field &	SetValue (const vector< CRef< CUser_object > > &value)

CUser_field &	SetValue (const vector< CRef< CUser_field > > &value)

int	GetInt (void) const
	get value More...

Int8	GetInt8 (void) const

TGi	GetGi (void) const

bool	GetBool (void) const

double	GetDouble (void) const

const string &	GetString (void) const

template<class Type >
Type	GetValue (void) const

CUser_field &	AddField (const string &label, int value)
	add fields to the current user field More...

CUser_field &	AddField (const string &label, Int8 value)

CUser_field &	AddField (const string &label, TGi value)

CUser_field &	AddField (const string &label, double value)

CUser_field &	AddField (const string &label, bool value)

CUser_field &	AddField (const string &label, const char *value)

CUser_field &	AddField (const string &label, const string &value)

CUser_field &	AddField (const string &label, const char *value, EParseField field)

CUser_field &	AddField (const string &label, const string &value, EParseField field)
	add fields to the current user field More...

CUser_field &	AddField (const string &label, const vector< string > &value)

CUser_field &	AddField (const string &label, const vector< int > &value)

CUser_field &	AddField (const string &label, const vector< double > &value)

CUser_field &	AddField (const string &label, CUser_object &value)

CUser_field &	AddField (const string &label, const vector< CRef< CUser_object > > &value)

CUser_field &	AddField (const string &label, const vector< CRef< CUser_field > > &value)

void	SetNumFromSize (size_t value)
	Set num field from a container size Check for overflow and throw CSerialException::eOverflow if the size doesn't fit into the field. More...

const CUser_field &	GetField (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase) const
	Access a named field in this user field. More...

CConstRef< CUser_field >	GetFieldRef (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase) const
	Return a field reference representing the tokenized key, or a NULL reference if the key doesn't exist. More...

void	GetFieldsMap (CUser_field::TMapFieldNameToRef &out_mapFieldNameToRef, TFieldMapFlags fFieldMapFlags=0, const SFieldNameChain &parent_name=SFieldNameChain()) const
	Recursively get the map of field names like the input for GetFieldRef to the user-field. More...

CUser_field &	SetField (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase)
	Access a named field in this user field. More...

CRef< CUser_field >	SetFieldRef (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase)
	Return a field reference representing the tokenized key, or a NULL reference if the key cannot be created for some reason. More...

bool	HasField (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase) const
	Verify that a named field exists. More...

bool	DeleteField (const string &str, const string &delim=".", NStr::ECase use_case=NStr::eCase)
	Delete the named field. More...

template<>
int	GetValue (void) const

template<>
Int8	GetValue (void) const

template<>
double	GetValue (void) const

template<>
bool	GetValue (void) const

template<>
string	GetValue (void) const

template<>
TGi	GetValue (void) const

Public Member Functions inherited from CUser_field_Base
	CUser_field_Base (void)

virtual	~CUser_field_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetLabel (void) const
	field label Check if a value has been assigned to Label data member. More...

bool	CanGetLabel (void) const
	Check if it is safe to call GetLabel method. More...

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

const TLabel &	GetLabel (void) const
	Get the Label member data. More...

void	SetLabel (TLabel &value)
	Assign a value to Label data member. More...

TLabel &	SetLabel (void)
	Assign a value to Label data member. More...

bool	IsSetNum (void) const
	required for strs, ints, reals, oss Check if a value has been assigned to Num data member. More...

bool	CanGetNum (void) const
	Check if it is safe to call GetNum method. More...

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

TNum	GetNum (void) const
	Get the Num member data. More...

void	SetNum (TNum value)
	Assign a value to Num data member. More...

TNum &	SetNum (void)
	Assign a value to Num data member. More...

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

bool	CanGetData (void) const
	Check if it is safe to call GetData method. More...

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

const TData &	GetData (void) const
	Get the Data member data. More...

void	SetData (TData &value)
	Assign a value to Data data member. More...

TData &	SetData (void)
	Assign a value to Data 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 CUser_field_Base	Tparent

Private Member Functions
	CUser_field (const CUser_field &value)

CUser_field &	operator= (const CUser_field &value)

Additional Inherited Members
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 50 of file User_field.hpp.

Member Typedef Documentation

◆ TFieldMapFlags

typedef int CUser_field::TFieldMapFlags

holds bitwise OR of "EFieldMapFlags"

Definition at line 174 of file User_field.hpp.

◆ TMapFieldNameToRef

typedef map<SFieldNameChain, CConstRef<CUser_field> > CUser_field::TMapFieldNameToRef

Maps field names like the input for GetFieldRef to the user-field.

Definition at line 168 of file User_field.hpp.

◆ Tparent

typedef CUser_field_Base CUser_field::Tparent

private

Definition at line 52 of file User_field.hpp.

Member Enumeration Documentation

◆ EFieldMapFlags

enum CUser_field::EFieldMapFlags

Flags that affect behavior of TMapFieldNameToRef functions.

Enumerator
fFieldMapFlags_ExcludeThis	= 0x1 (excludes this CUser_field's name and mapping to self from results)

Definition at line 171 of file User_field.hpp.

◆ EParseField

enum CUser_field::EParseField

Enumerator
eParse_String	Add string even if all numbers.
eParse_Number	Parse a real or integer number, otherwise string.

Definition at line 59 of file User_field.hpp.

Constructor & Destructor Documentation

◆ CUser_field() [1/2]

CUser_field::CUser_field ( void )

inline

Definition at line 231 of file User_field.hpp.

Referenced by AddField(), and SetFieldRef().

◆ ~CUser_field()

CUser_field::~CUser_field ( void )

Definition at line 52 of file User_field.cpp.

◆ CUser_field() [2/2]

CUser_field::CUser_field ( const CUser_field & value )

private

Member Function Documentation

◆ AddField() [1/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		bool	value
	)

Definition at line 134 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [2/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const char *	value
	)

Definition at line 77 of file User_field.cpp.

References AddField(), eParse_String, label, and rapidjson::value.

◆ AddField() [3/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const char *	value,
		EParseField	field
	)

Definition at line 84 of file User_field.cpp.

References AddField(), label, and rapidjson::value.

◆ AddField() [4/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const string &	value
	)

Definition at line 70 of file User_field.cpp.

References AddField(), eParse_String, label, and rapidjson::value.

◆ AddField() [5/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const string &	value,
		EParseField	field
	)

add fields to the current user field

Definition at line 58 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [6/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const vector< CRef< CUser_field > > &	value
	)

Definition at line 197 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [7/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const vector< CRef< CUser_object > > &	value
	)

Definition at line 186 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [8/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const vector< double > &	value
	)

Definition at line 164 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [9/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		const vector< int > &	value
	)

Definition at line 153 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [10/15]

CUser_field& CUser_field::AddField	(	const string &	label,
		const vector< string > &	value
	)

◆ AddField() [11/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		CUser_object &	value
	)

Definition at line 175 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [12/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		double	value
	)

Definition at line 124 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [13/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		int	value
	)

add fields to the current user field

Definition at line 92 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

Referenced by AddField(), CAnnotationASN1::CImplementationData::create_ModelEvidence_user_object(), CRegistryFile::FromConfigFile(), s_SetFieldsFromAnyContent(), CTableImportColumn::SaveAsn(), CTableDelimiterRules::SaveAsn(), and CVcfReader::xProcessFormat().

◆ AddField() [14/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		Int8	value
	)

Definition at line 102 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ AddField() [15/15]

CUser_field & CUser_field::AddField	(	const string &	label,
		TGi	value
	)

Definition at line 113 of file User_field.cpp.

References CUser_field(), label, CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), CUser_field_Base::SetLabel(), SetValue(), and rapidjson::value.

◆ DeleteField()

bool CUser_field::DeleteField	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)

Delete the named field.

delete a named field.

return true if successful. false if field doesn't exist.

Definition at line 404 of file User_field.cpp.

References NStr::Equal(), f(), NStr::fSplit_Tokenize, CUser_field_Base::GetData(), CUser_field_Base::GetLabel(), CObject_id_Base::GetStr(), CUser_field_Base::C_Data::IsFields(), CObject_id_Base::IsStr(), ITERATE, last(), NON_CONST_ITERATE, NStr::Split(), and str().

Referenced by CRegistryFile::DeleteField().

◆ GetBool()

bool CUser_field::GetBool ( void ) const

inline

Definition at line 341 of file User_field.hpp.

References CUser_field_Base::C_Data::GetBool(), and CUser_field_Base::GetData().

Referenced by CSeqUtils::GetAnnotShown(), and GetValue().

◆ GetDouble()

double CUser_field::GetDouble ( void ) const

inline

Definition at line 334 of file User_field.hpp.

References CUser_field_Base::GetData(), and CUser_field_Base::C_Data::GetReal().

Referenced by GetValue().

◆ GetField()

const CUser_field & CUser_field::GetField	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)		const

Access a named field in this user field.

This will tokenize the string 'str' on the delimiters; if the field doesn't exist, an exception will be thrown.

Definition at line 211 of file User_field.cpp.

References eUnknown, f(), GetFieldRef(), NCBI_THROW, and str().

Referenced by BOOST_AUTO_TEST_SUITE_END(), CollectUserField(), CSequenceEditingEventHandler::DeleteSpecificStructuredComment(), CDockLayoutTree::CNode::FromUserObject(), CGuiRegistry::GetField(), GetHasFrameShift(), GetHasOrderAssignment(), GetLowTrace(), CBlastQuerySourceBioseqSet::GetSegmentInfo(), CTableDelimiterRules::LoadAsn(), CTableImportColumn::LoadAsn(), s_GetSegmentFlags(), s_HasRefSeqPGAPStructuredComment(), and CFeatureGenerator::SImplementation::x_CheckMatch().

◆ GetFieldRef()

CConstRef< CUser_field > CUser_field::GetFieldRef	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)		const

Return a field reference representing the tokenized key, or a NULL reference if the key doesn't exist.

Definition at line 226 of file User_field.cpp.

References NStr::Equal(), f(), NStr::fSplit_Tokenize, CUser_field_Base::GetData(), CObject_id_Base::GetId(), CUser_field_Base::GetLabel(), CObject_id_Base::GetStr(), CUser_field_Base::C_Data::IsFields(), CObject_id_Base::IsId(), CObject_id_Base::IsStr(), ITERATE, last(), NStr::Split(), str(), and NStr::StringToInt().

Referenced by BOOST_AUTO_TEST_CASE(), CRegistryReadView::GetField(), GetField(), CUser_object::GetFieldRef(), CFlatGoQVal::GetPubmedId(), CSGSeqGraphJob::GetSeqtableAnnots(), CFlatGoQVal::GetTextString(), CGuiObjectInfoPrimer::GetToolTip(), CGuiObjectInfoVariant::GetToolTip(), CGBProjectHandle::GetViewSettings(), HasField(), CIntronGlyph::IsConsensus(), CRegistryReadView::ResolveField(), s_CheckTraceMateAlign(), s_GetSpliceSite(), s_IsMatchById(), CRegistryReadView::x_AppendToReadView(), CDensegGraphicDataSource::x_GetCigarStr(), CDensegGraphicDataSource::x_GetMismatchStr(), and CSGAnnotJob::x_PercentileButNotMax().

◆ GetFieldsMap()

void CUser_field::GetFieldsMap	(	CUser_field::TMapFieldNameToRef &	out_mapFieldNameToRef,
		TFieldMapFlags	fFieldMapFlags = `0`,
		const SFieldNameChain &	parent_name = `SFieldNameChain()`
	)		const

Recursively get the map of field names like the input for GetFieldRef to the user-field.

Parameters

out_mapFieldNameToRef	The results are put into here, but it becomes INVALID if this CUser_field or any of its descendents change their label. It will NOT be cleared before more data is added, and in that case would overwrite any item which has the same key.
fFieldMapFlags	Flags that affect behavior of function.
parent_name	Outside users probably don't need this. It's really for internal recursive calls when building the map.

Definition at line 295 of file User_field.cpp.

References ConstRef(), fFieldMapFlags_ExcludeThis, FIELD_IS_SET_AND_IS, CUser_field_Base::GetData(), CUser_field_Base::GetLabel(), CObject_id_Base::GetStr(), map_checker< Container >::insert(), and ITERATE.

Referenced by BOOST_AUTO_TEST_CASE(), and CCommentItem::GetStringForRefSeqGenome().

◆ GetGi()

TGi CUser_field::GetGi ( void ) const

inline

Definition at line 395 of file User_field.hpp.

References GI_FROM.

Referenced by GetValue().

◆ GetInt()

int CUser_field::GetInt ( void ) const

inline

get value

Definition at line 327 of file User_field.hpp.

References CUser_field_Base::GetData(), and CUser_field_Base::C_Data::GetInt().

Referenced by GetValue(), and CFeatureGenerator::SImplementation::x_CheckMatch().

◆ GetInt8()

Int8 CUser_field::GetInt8 ( void ) const

Definition at line 549 of file User_field.cpp.

References data, CUser_field_Base::GetData(), and kMaxAsReal.

Referenced by GetValue().

◆ GetString()

const string & CUser_field::GetString ( void ) const

inline

Definition at line 348 of file User_field.hpp.

bool CUser_field::HasField	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)		const

Verify that a named field exists.

Definition at line 393 of file User_field.cpp.

References f(), GetFieldRef(), NULL, and str().

Referenced by CollectUserField(), CRegistryReadView::HasField(), CTableDelimiterRules::LoadAsn(), CTableImportColumn::LoadAsn(), s_GetModelEvidance(), and CFeatureGenerator::SImplementation::x_CheckMatch().

◆ operator=()

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

private

◆ SetBool()

CUser_field & CUser_field::SetBool ( bool value )

inline

Definition at line 253 of file User_field.hpp.

References CUser_field_Base::C_Data::SetBool(), CUser_field_Base::SetData(), and rapidjson::value.

Referenced by CUser_object::SetRefGeneTrackingGenerated(), and SetValue().

◆ SetDouble()

CUser_field & CUser_field::SetDouble ( double value )

inline

Definition at line 261 of file User_field.hpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetReal(), and rapidjson::value.

Referenced by SetValue().

◆ SetField()

CUser_field & CUser_field::SetField	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)

Access a named field in this user field.

This will tokenize the string 'str' on the delimiters and recursively add fields where needed

Definition at line 334 of file User_field.cpp.

References f(), SetFieldRef(), and str().

Referenced by CTableImportColumn::LoadAsn().

◆ SetFieldRef()

CRef< CUser_field > CUser_field::SetFieldRef	(	const string &	str,
		const string &	delim = `"."`,
		NStr::ECase	use_case = `NStr::eCase`
	)

Return a field reference representing the tokenized key, or a NULL reference if the key cannot be created for some reason.

Definition at line 345 of file User_field.cpp.

References CUser_field(), CUser_field_Base::C_Data::e_not_set, NStr::Equal(), eUnknown, f(), NStr::fSplit_Tokenize, CUser_field_Base::GetData(), CUser_field_Base::GetLabel(), CObject_id_Base::GetStr(), CUser_field_Base::C_Data::IsFields(), ITERATE, last(), NCBI_THROW, NON_CONST_ITERATE, CRef< C, Locker >::Reset(), CUser_field_Base::SetLabel(), NStr::Split(), str(), and CUser_field_Base::C_Data::Which().

Referenced by s_SetFieldAt(), SetField(), and CUser_object::SetFieldRef().

◆ SetGi()

CUser_field & CUser_field::SetGi ( TGi gi )

inline

Definition at line 311 of file User_field.hpp.

References GI_TO, SetValue(), and rapidjson::value.

Referenced by CUser_object::CRefGeneTrackingAccession::MakeAccessionField(), and SetValue().

◆ SetInt()

CUser_field & CUser_field::SetInt ( int value )

inline

set value

Definition at line 245 of file User_field.hpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetInt(), and rapidjson::value.

Referenced by SetInt8(), and SetValue().

◆ SetInt8()

CUser_field & CUser_field::SetInt8 ( Int8 value )

Definition at line 481 of file User_field.cpp.

References NStr::NumericToString(), SetInt(), SetString(), and rapidjson::value.

Referenced by SetValue().

◆ SetNumFromSize()

void CUser_field::SetNumFromSize ( size_t value )

Set num field from a container size Check for overflow and throw CSerialException::eOverflow if the size doesn't fit into the field.

Definition at line 492 of file User_field.cpp.

References max(), NCBI_THROW_FMT, CUser_field_Base::SetNum(), and rapidjson::value.

Referenced by s_PackAsUserField(), s_SetFieldsFromAnyContent(), and SetValue().

◆ SetString() [1/2]

CUser_field & CUser_field::SetString ( const char * value )

Definition at line 445 of file User_field.cpp.

References SetValue(), and rapidjson::value.

Referenced by fta_get_str_user_field(), fta_get_user_field(), SetInt8(), CProjectItemExtra::SetStr(), SetValue(), and CUser_object::x_SetRefGeneTrackingField().

◆ SetString() [2/2]

CUser_field & CUser_field::SetString ( const string & value )

inline

Definition at line 237 of file User_field.hpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetStr(), and rapidjson::value.

◆ SetValue() [1/15]

CUser_field & CUser_field::SetValue ( bool value )

inline

Definition at line 290 of file User_field.hpp.

References SetBool(), and rapidjson::value.

◆ SetValue() [2/15]

CUser_field & CUser_field::SetValue ( const char * value )

inline

Definition at line 269 of file User_field.hpp.

References SetString(), and rapidjson::value.

◆ SetValue() [3/15]

CUser_field & CUser_field::SetValue	(	const char *	value,
		EParseField	parse
	)

Definition at line 470 of file User_field.cpp.

References SetValue(), and rapidjson::value.

◆ SetValue() [4/15]

CUser_field & CUser_field::SetValue ( const string & value )

inline

Definition at line 276 of file User_field.hpp.

References SetString(), and rapidjson::value.

◆ SetValue() [5/15]

CUser_field & CUser_field::SetValue	(	const string &	value,
		EParseField	parse
	)

Definition at line 451 of file User_field.cpp.

References eParse_Number, SetValue(), NStr::StringToDouble(), and rapidjson::value.

◆ SetValue() [6/15]

CUser_field & CUser_field::SetValue ( const vector< CRef< CUser_field > > & value )

Definition at line 541 of file User_field.cpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetFields(), SetNumFromSize(), and rapidjson::value.

◆ SetValue() [7/15]

CUser_field & CUser_field::SetValue ( const vector< CRef< CUser_object > > & value )

Definition at line 533 of file User_field.cpp.

References CUser_field_Base::SetData(), SetNumFromSize(), CUser_field_Base::C_Data::SetObjects(), and rapidjson::value.

◆ SetValue() [8/15]

CUser_field & CUser_field::SetValue ( const vector< double > & value )

Definition at line 510 of file User_field.cpp.

References CUser_field_Base::SetData(), SetNumFromSize(), CUser_field_Base::C_Data::SetReals(), and rapidjson::value.

◆ SetValue() [9/15]

CUser_field & CUser_field::SetValue ( const vector< int > & value )

Definition at line 502 of file User_field.cpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetInts(), SetNumFromSize(), and rapidjson::value.

◆ SetValue() [10/15]

CUser_field & CUser_field::SetValue ( const vector< string > & value )

Definition at line 518 of file User_field.cpp.

References CUser_field_Base::SetData(), SetNumFromSize(), CUser_field_Base::C_Data::SetStrs(), and rapidjson::value.

◆ SetValue() [11/15]

CUser_field & CUser_field::SetValue ( CUser_object & value )

Definition at line 526 of file User_field.cpp.

References CUser_field_Base::SetData(), CUser_field_Base::C_Data::SetObject(), and rapidjson::value.

◆ SetValue() [12/15]

CUser_field & CUser_field::SetValue ( double value )

inline

Definition at line 297 of file User_field.hpp.

References SetDouble(), and rapidjson::value.

◆ SetValue() [13/15]

CUser_field & CUser_field::SetValue ( int value )

inline

set a data field to a given value Int8 and TGi values can be stored into 'str' field if the value doesn't fit into 'int' field

Definition at line 283 of file User_field.hpp.

References SetInt(), and rapidjson::value.

Referenced by AddField(), CUser_object::AddField(), CSegregateSetsBase::AddUserObject(), CWithdrawSequences::GetCommand(), s_SetVectorValue(), s_UpdateField(), SetGi(), SetString(), CEditingActionDescGenomeProjectId::SetValue(), CEditingActionDescStructCommDbName::SetValue(), SetValue(), and CUser_object::UpdateNcbiCleanup().

◆ SetValue() [14/15]

CUser_field & CUser_field::SetValue ( Int8 value )

inline

Definition at line 304 of file User_field.hpp.

References SetInt8(), and rapidjson::value.

◆ SetValue() [15/15]

CUser_field & CUser_field::SetValue ( TGi value )

inline

Definition at line 319 of file User_field.hpp.

References SetGi(), and rapidjson::value.

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

include/objects/general/User_field.hpp
src/objects/general/User_field.cpp

Classes

Public Types

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TFieldMapFlags

◆ TMapFieldNameToRef

◆ Tparent

Member Enumeration Documentation

◆ EFieldMapFlags

◆ EParseField

Constructor & Destructor Documentation

◆ CUser_field() [1/2]

◆ ~CUser_field()

◆ CUser_field() [2/2]

Member Function Documentation

◆ AddField() [1/15]

◆ AddField() [2/15]

◆ AddField() [3/15]

◆ AddField() [4/15]

◆ AddField() [5/15]

◆ AddField() [6/15]

◆ AddField() [7/15]

◆ AddField() [8/15]

◆ AddField() [9/15]

◆ AddField() [10/15]

◆ AddField() [11/15]

◆ AddField() [12/15]

◆ AddField() [13/15]

◆ AddField() [14/15]

◆ AddField() [15/15]

◆ DeleteField()

◆ GetBool()

◆ GetDouble()

◆ GetField()

◆ GetFieldRef()

◆ GetFieldsMap()

◆ GetGi()

◆ GetInt()

◆ GetInt8()

◆ GetString()

◆ GetValue() [1/7]

◆ GetValue() [2/7]

◆ GetValue() [3/7]

◆ GetValue() [4/7]

◆ GetValue() [5/7]

◆ GetValue() [6/7]

◆ GetValue() [7/7]

◆ HasField()

◆ operator=()

◆ SetBool()

◆ SetDouble()

◆ SetField()

◆ SetFieldRef()

◆ SetGi()

◆ SetInt()

◆ SetInt8()

◆ SetNumFromSize()

◆ SetString() [1/2]

◆ SetString() [2/2]

◆ SetValue() [1/15]

◆ SetValue() [2/15]

◆ SetValue() [3/15]

◆ SetValue() [4/15]

◆ SetValue() [5/15]

◆ SetValue() [6/15]

◆ SetValue() [7/15]

◆ SetValue() [8/15]

◆ SetValue() [9/15]

◆ SetValue() [10/15]

◆ SetValue() [11/15]

◆ SetValue() [12/15]

◆ SetValue() [13/15]

◆ SetValue() [14/15]

◆ SetValue() [15/15]