NCBI C++ ToolKit
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Friends | List of all members

Represents ASN.1 type Author defined in file biblio.asn

Search Toolkit Book for CAuthor

CAuthor –. More...

#include <objects/biblio/Author.hpp>

+ Inheritance diagram for CAuthor:
+ Collaboration diagram for CAuthor:

Public Member Functions

 CAuthor ()
 
 ~CAuthor ()
 
 CAuthor (void)
 
 ~CAuthor (void)
 
- Public Member Functions inherited from CAuthor_Base
 CAuthor_Base (void)
 
virtual ~CAuthor_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetName (void) const
 Author, Primary or Secondary Check if a value has been assigned to Name data member. More...
 
bool CanGetName (void) const
 Check if it is safe to call GetName method. More...
 
void ResetName (void)
 Reset Name data member. More...
 
const TNameGetName (void) const
 Get the Name member data. More...
 
void SetName (TName &value)
 Assign a value to Name data member. More...
 
TNameSetName (void)
 Assign a value to Name data member. More...
 
bool IsSetLevel (void) const
 Check if a value has been assigned to Level data member. More...
 
bool CanGetLevel (void) const
 Check if it is safe to call GetLevel method. More...
 
void ResetLevel (void)
 Reset Level data member. More...
 
TLevel GetLevel (void) const
 Get the Level member data. More...
 
void SetLevel (TLevel value)
 Assign a value to Level data member. More...
 
TLevelSetLevel (void)
 Assign a value to Level data member. More...
 
bool IsSetRole (void) const
 Check if a value has been assigned to Role data member. More...
 
bool CanGetRole (void) const
 Check if it is safe to call GetRole method. More...
 
void ResetRole (void)
 Reset Role data member. More...
 
TRole GetRole (void) const
 Get the Role member data. More...
 
void SetRole (TRole value)
 Assign a value to Role data member. More...
 
TRoleSetRole (void)
 Assign a value to Role data member. More...
 
bool IsSetAffil (void) const
 Check if a value has been assigned to Affil data member. More...
 
bool CanGetAffil (void) const
 Check if it is safe to call GetAffil method. More...
 
void ResetAffil (void)
 Reset Affil data member. More...
 
const TAffilGetAffil (void) const
 Get the Affil member data. More...
 
void SetAffil (TAffil &value)
 Assign a value to Affil data member. More...
 
TAffilSetAffil (void)
 Assign a value to Affil data member. More...
 
bool IsSetIs_corr (void) const
 TRUE if corresponding author Check if a value has been assigned to Is_corr data member. More...
 
bool CanGetIs_corr (void) const
 Check if it is safe to call GetIs_corr method. More...
 
void ResetIs_corr (void)
 Reset Is_corr data member. More...
 
TIs_corr GetIs_corr (void) const
 Get the Is_corr member data. More...
 
void SetIs_corr (TIs_corr value)
 Assign a value to Is_corr data member. More...
 
TIs_corrSetIs_corr (void)
 Assign a value to Is_corr data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
 CAuthor_Base (void)
 
virtual ~CAuthor_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetAttlist (void) const
 Check if a value has been assigned to Attlist data member. More...
 
bool CanGetAttlist (void) const
 Check if it is safe to call GetAttlist method. More...
 
void ResetAttlist (void)
 Reset Attlist data member. More...
 
const TAttlistGetAttlist (void) const
 Get the Attlist member data. More...
 
void SetAttlist (TAttlist &value)
 Assign a value to Attlist data member. More...
 
TAttlistSetAttlist (void)
 Assign a value to Attlist data member. More...
 
bool IsSetLC (void) const
 Check if a value has been assigned to LC data member. More...
 
bool CanGetLC (void) const
 Check if it is safe to call GetLC method. More...
 
void ResetLC (void)
 Reset LC data member. More...
 
const TLCGetLC (void) const
 Get the LC member data. More...
 
void SetLC (TLC &value)
 Assign a value to LC data member. More...
 
TLCSetLC (void)
 Assign a value to LC data member. More...
 
bool IsSetIdentifier (void) const
 Check if a value has been assigned to Identifier data member. More...
 
bool CanGetIdentifier (void) const
 Check if it is safe to call GetIdentifier method. More...
 
void ResetIdentifier (void)
 Reset Identifier data member. More...
 
const TIdentifierGetIdentifier (void) const
 Get the Identifier member data. More...
 
TIdentifierSetIdentifier (void)
 Assign a value to Identifier data member. More...
 
bool IsSetAffiliationInfo (void) const
 Check if a value has been assigned to AffiliationInfo data member. More...
 
bool CanGetAffiliationInfo (void) const
 Check if it is safe to call GetAffiliationInfo method. More...
 
void ResetAffiliationInfo (void)
 Reset AffiliationInfo data member. More...
 
const TAffiliationInfoGetAffiliationInfo (void) const
 Get the AffiliationInfo member data. More...
 
TAffiliationInfoSetAffiliationInfo (void)
 Assign a value to AffiliationInfo 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
 
- Public Member Functions inherited from ICitationBase
bool GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override
 Append a label to the specified string per the specified flags. More...
 
bool GetLabel (string *label, bool unique) const
 
- Public Member Functions inherited from IAbstractCitation
virtual ~IAbstractCitation ()
 

Static Public Member Functions

static CRef< CAuthorConvertMlToStandard (const CAuthor &author, bool normalize_suffix=false)
 
static CRef< CAuthorConvertMlToStandard (const string &ml_name, bool normalize_suffix=false)
 
- Static Public Member Functions inherited from CAuthor_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ELevel (void)
 Access to ELevel's attributes (values, names) as defined in spec. More...
 
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME() ERole (void)
 Access to ERole's attributes (values, names) as defined in spec. 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 Member Functions inherited from ICitationBase
static string FixPages (const string &orig_pages)
 Canonicalize a range of page numbers, expanding Medline-style 125-35 -> 125-135, F124-34 -> F124-F134, and 12a-c -> 12a-12c, and returning a single number (without a dash) for a single page. More...
 
static string GetParenthesizedYear (const CDate &date)
 
static bool HasText (const string &s)
 
static bool HasText (const string *s)
 
static void MaybeAddSpace (string *label)
 
static void NoteSup (string *label, const CImprint &imp)
 
static bool SWNC (const string &str, const string &pfx)
 

Protected Member Functions

bool GetLabelV1 (string *label, TLabelFlags flags) const override
 
bool GetLabelV2 (string *label, TLabelFlags flags) const override
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Private Types

typedef CAuthor_Base Tparent
 
typedef CAuthor_Base Tparent
 

Private Member Functions

 CAuthor (const CAuthor &value)
 
CAuthoroperator= (const CAuthor &value)
 
 CAuthor (const CAuthor &value)
 
CAuthoroperator= (const CAuthor &value)
 

Static Private Member Functions

static bool x_GetLabelV2 (string *label, TLabelFlags flags, CTempString name, CTempString initials=kEmptyStr, CTempString suffix=kEmptyStr)
 
static CRef< CPerson_idx_ConvertMlToStandard (const string &name, bool normalize_suffix=false)
 

Friends

class CAuth_list
 

Additional Inherited Members

- Public Types inherited from CAuthor_Base
enum  ELevel { eLevel_primary = 1 , eLevel_secondary = 2 }
 
enum  ERole { eRole_compiler = 1 , eRole_editor = 2 , eRole_patent_assignee = 3 , eRole_translator = 4 }
 Author Role Indicator. More...
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_name , e_level , e_role ,
  e_affil , e_is_corr , e__allMandatory = 0 , e_Attlist ,
  e_LC , e_Identifier , e_AffiliationInfo
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_name , e_level , e_role ,
  e_affil , e_is_corr , e__allMandatory = 0 , e_Attlist ,
  e_LC , e_Identifier , e_AffiliationInfo
}
 
typedef CPerson_id TName
 
typedef ELevel TLevel
 
typedef ERole TRole
 
typedef CAffil TAffil
 
typedef bool TIs_corr
 
typedef Tparent::CMemberIndex< E_memberIndex, 6 > TmemberIndex
 
typedef C_Attlist TAttlist
 
typedef C_LC TLC
 
typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CIdentifier > > TIdentifier
 
typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CAffiliationInfo > > TAffiliationInfo
 
typedef Tparent::CMemberIndex< E_memberIndex, 5 > 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 Types inherited from IAbstractCitation
enum  ELabelFlags {
  fLabel_Unique = 1 << 0 , fLabel_FlatNCBI = 1 << 1 , fLabel_FlatEMBL = 1 << 2 , fLabel_ISO_JTA = 1 << 3 ,
  fLabel_NoBadCitGen = 1 << 4 , fLabel_NoUnpubAffil = 1 << 5 , fLabel_Consortia = 1 << 30
}
 Flags for use by GetLabel methods. More...
 
enum  ELabelVersion {
  eLabel_V1 = 1 , eLabel_V2 = 2 , eLabel_MinVersion = eLabel_V1 , eLabel_DefaultVersion = eLabel_V1 ,
  eLabel_MaxVersion = eLabel_V2
}
 
typedef int TLabelFlags
 binary OR of ELabelFlags 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...
 
- Static Protected Member Functions inherited from ICitationBase
static bool x_GetLabelV1 (string *label, bool unique, const CAuth_list *authors, const CImprint *imprint, const CTitle *title, const CCit_book *book, const CCit_jour *journal, const string *title1=0, const string *title2=0, const string *titleunique=0, const string *date=0, const string *volume=0, const string *issue=0, const string *pages=0, bool unpublished=false)
 

Detailed Description

CAuthor –.

Definition at line 58 of file Author.hpp.

Member Typedef Documentation

◆ Tparent

typedef CAuthor_Base CAuthor::Tparent
private

Definition at line 60 of file Author.hpp.

Constructor & Destructor Documentation

◆ CAuthor() [1/2]

CAuthor::CAuthor ( void  )
inline

Definition at line 63 of file Author.hpp.

Referenced by ConvertMlToStandard().

◆ ~CAuthor()

BEGIN_eutils_SCOPE CAuthor::~CAuthor ( void  )

Definition at line 51 of file Author.cpp.

◆ CAuthor() [2/2]

CAuthor::CAuthor ( const CAuthor value)
private

Member Function Documentation

◆ ConvertMlToStandard() [1/2]

CRef< CAuthor > CAuthor::ConvertMlToStandard ( const CAuthor author,
bool  normalize_suffix = false 
)
static

◆ ConvertMlToStandard() [2/2]

CRef< CAuthor > CAuthor::ConvertMlToStandard ( const string ml_name,
bool  normalize_suffix = false 
)
static

◆ GetLabelV1()

bool CAuthor::GetLabelV1 ( string label,
TLabelFlags  flags 
) const
overrideprotectedvirtual

Implements ICitationBase.

Definition at line 56 of file Author.cpp.

References CPerson_id::GetLabel(), CAuthor_Base::GetName(), and label.

◆ GetLabelV2()

bool CAuthor::GetLabelV2 ( string label,
TLabelFlags  flags 
) const
overrideprotectedvirtual

◆ operator=()

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

◆ x_ConvertMlToStandard()

CRef< CPerson_id > CAuthor::x_ConvertMlToStandard ( const string name,
bool  normalize_suffix = false 
)
staticprivate

◆ x_GetLabelV2()

bool CAuthor::x_GetLabelV2 ( string label,
TLabelFlags  flags,
CTempString  name,
CTempString  initials = kEmptyStr,
CTempString  suffix = kEmptyStr 
)
staticprivate

Friends And Related Function Documentation

◆ CAuth_list

friend class CAuth_list
friend

Definition at line 87 of file Author.hpp.


The documentation for this class was generated from the following files:
Modified on Wed Apr 17 13:08:04 2024 by modify_doxy.py rev. 669887