NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | List of all members
CName_std Class Reference

Represents ASN.1 type Name-std defined in file general.asn

Search Toolkit Book for CName_std

@Name_std.hpp User-defined methods of the data storage class. More...

#include <objects/general/Name_std.hpp>

+ Inheritance diagram for CName_std:
+ Collaboration diagram for CName_std:

Public Types

typedef CStaticArraySet< stringTSuffixes
 
- Public Types inherited from CName_std_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_last , e_first , e_middle ,
  e_full , e_initials , e_suffix , e_title
}
 
typedef string TLast
 
typedef string TFirst
 
typedef string TMiddle
 
typedef string TFull
 
typedef string TInitials
 
typedef string TSuffix
 
typedef string TTitle
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CName_std (void)
 constructor More...
 
 ~CName_std (void)
 destructor More...
 
bool ExtractSuffixFromLastName ()
 
- Public Member Functions inherited from CName_std_Base
 CName_std_Base (void)
 
virtual ~CName_std_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLast (void) const
 Check if a value has been assigned to Last data member. More...
 
bool CanGetLast (void) const
 Check if it is safe to call GetLast method. More...
 
void ResetLast (void)
 Reset Last data member. More...
 
const TLastGetLast (void) const
 Get the Last member data. More...
 
void SetLast (const TLast &value)
 Assign a value to Last data member. More...
 
void SetLast (TLast &&value)
 
TLastSetLast (void)
 Assign a value to Last data member. More...
 
bool IsSetFirst (void) const
 Check if a value has been assigned to First data member. More...
 
bool CanGetFirst (void) const
 Check if it is safe to call GetFirst method. More...
 
void ResetFirst (void)
 Reset First data member. More...
 
const TFirstGetFirst (void) const
 Get the First member data. More...
 
void SetFirst (const TFirst &value)
 Assign a value to First data member. More...
 
void SetFirst (TFirst &&value)
 
TFirstSetFirst (void)
 Assign a value to First data member. More...
 
bool IsSetMiddle (void) const
 Check if a value has been assigned to Middle data member. More...
 
bool CanGetMiddle (void) const
 Check if it is safe to call GetMiddle method. More...
 
void ResetMiddle (void)
 Reset Middle data member. More...
 
const TMiddleGetMiddle (void) const
 Get the Middle member data. More...
 
void SetMiddle (const TMiddle &value)
 Assign a value to Middle data member. More...
 
void SetMiddle (TMiddle &&value)
 
TMiddleSetMiddle (void)
 Assign a value to Middle data member. More...
 
bool IsSetFull (void) const
 full name eg. More...
 
bool CanGetFull (void) const
 Check if it is safe to call GetFull method. More...
 
void ResetFull (void)
 Reset Full data member. More...
 
const TFullGetFull (void) const
 Get the Full member data. More...
 
void SetFull (const TFull &value)
 Assign a value to Full data member. More...
 
void SetFull (TFull &&value)
 
TFullSetFull (void)
 Assign a value to Full data member. More...
 
bool IsSetInitials (void) const
 first + middle initials Check if a value has been assigned to Initials data member. More...
 
bool CanGetInitials (void) const
 Check if it is safe to call GetInitials method. More...
 
void ResetInitials (void)
 Reset Initials data member. More...
 
const TInitialsGetInitials (void) const
 Get the Initials member data. More...
 
void SetInitials (const TInitials &value)
 Assign a value to Initials data member. More...
 
void SetInitials (TInitials &&value)
 
TInitialsSetInitials (void)
 Assign a value to Initials data member. More...
 
bool IsSetSuffix (void) const
 Jr, Sr, III Check if a value has been assigned to Suffix data member. More...
 
bool CanGetSuffix (void) const
 Check if it is safe to call GetSuffix method. More...
 
void ResetSuffix (void)
 Reset Suffix data member. More...
 
const TSuffixGetSuffix (void) const
 Get the Suffix member data. More...
 
void SetSuffix (const TSuffix &value)
 Assign a value to Suffix data member. More...
 
void SetSuffix (TSuffix &&value)
 
TSuffixSetSuffix (void)
 Assign a value to Suffix data member. More...
 
bool IsSetTitle (void) const
 Dr., Sister, etc 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 TTitleGetTitle (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)
 
TTitleSetTitle (void)
 Assign a value to Title 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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
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...
 
- 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 TSuffixesGetStandardSuffixes (void)
 Get a list of NCBI's standard suffixes. More...
 
static void FixSuffix (string &suffix)
 
- 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 CName_std_Base Tparent
 

Private Member Functions

 CName_std (const CName_std &value)
 
CName_stdoperator= (const CName_std &value)
 

Additional Inherited Members

- 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

@Name_std.hpp User-defined methods of the data storage class.

This file was originally generated by application DATATOOL using the following specifications: 'general.asn'.

New methods or data members can be added to it if needed. See also: Name_std_.hpp

Definition at line 55 of file Name_std.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 57 of file Name_std.hpp.

◆ TSuffixes

Definition at line 60 of file Name_std.hpp.

Constructor & Destructor Documentation

◆ CName_std() [1/2]

CName_std::CName_std ( void  )
inline

constructor

Definition at line 84 of file Name_std.hpp.

◆ ~CName_std()

CName_std::~CName_std ( void  )

destructor

Definition at line 50 of file Name_std.cpp.

◆ CName_std() [2/2]

CName_std::CName_std ( const CName_std value)
private

Member Function Documentation

◆ ExtractSuffixFromLastName()

bool CName_std::ExtractSuffixFromLastName ( )

◆ FixSuffix()

void CName_std::FixSuffix ( string suffix)
static

◆ GetStandardSuffixes()

const CName_std::TSuffixes & CName_std::GetStandardSuffixes ( void  )
static

Get a list of NCBI's standard suffixes.

Definition at line 55 of file Name_std.cpp.

References DEFINE_STATIC_ARRAY_MAP_WITH_COPY.

Referenced by CValidError_imp::ValidateAuthorList().

◆ operator=()

CName_std& CName_std::operator= ( const CName_std value)
private

The documentation for this class was generated from the following files:
Modified on Thu Jul 18 16:00:27 2024 by modify_doxy.py rev. 669887