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

Represents ASN.1 type PC-Substance defined in file pcsubstance.asn

Search Toolkit Book for CPC_Substance

CPC_Substance –. More...

#include <objects/pcsubstance/PC_Substance.hpp>

+ Inheritance diagram for CPC_Substance:
+ Collaboration diagram for CPC_Substance:

Public Member Functions

 CPC_Substance (void)
 
 ~CPC_Substance (void)
 
- Public Member Functions inherited from CPC_Substance_Base
 CPC_Substance_Base (void)
 
virtual ~CPC_Substance_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetSid (void) const
 Internal Tracking Information Substance ID/Version [Either valid ID or a "0" dummy value, if "source" is to be used] Note: Version is for internal use (only?) Note: A valid ID is greater than "0" Check if a value has been assigned to Sid data member. More...
 
bool CanGetSid (void) const
 Check if it is safe to call GetSid method. More...
 
void ResetSid (void)
 Reset Sid data member. More...
 
const TSidGetSid (void) const
 Get the Sid member data. More...
 
void SetSid (TSid &value)
 Assign a value to Sid data member. More...
 
TSidSetSid (void)
 Assign a value to Sid data member. More...
 
bool IsSetSource (void) const
 Data Source for this Submission Check if a value has been assigned to Source data member. More...
 
bool CanGetSource (void) const
 Check if it is safe to call GetSource method. More...
 
void ResetSource (void)
 Reset Source data member. More...
 
const TSourceGetSource (void) const
 Get the Source member data. More...
 
void SetSource (TSource &value)
 Assign a value to Source data member. More...
 
TSourceSetSource (void)
 Assign a value to Source data member. More...
 
bool IsSetPub (void) const
 Substance Description Information Articles Describing this Substance Check if a value has been assigned to Pub data member. More...
 
bool CanGetPub (void) const
 Check if it is safe to call GetPub method. More...
 
void ResetPub (void)
 Reset Pub data member. More...
 
const TPubGetPub (void) const
 Get the Pub member data. More...
 
TPubSetPub (void)
 Assign a value to Pub data member. More...
 
bool IsSetSynonyms (void) const
 Substance Names provided by Depositor Check if a value has been assigned to Synonyms data member. More...
 
bool CanGetSynonyms (void) const
 Check if it is safe to call GetSynonyms method. More...
 
void ResetSynonyms (void)
 Reset Synonyms data member. More...
 
const TSynonymsGetSynonyms (void) const
 Get the Synonyms member data. More...
 
TSynonymsSetSynonyms (void)
 Assign a value to Synonyms data member. More...
 
bool IsSetComment (void) const
 Comments and Description provided by Depositor Check if a value has been assigned to Comment data member. More...
 
bool CanGetComment (void) const
 Check if it is safe to call GetComment method. More...
 
void ResetComment (void)
 Reset Comment data member. More...
 
const TCommentGetComment (void) const
 Get the Comment member data. More...
 
TCommentSetComment (void)
 Assign a value to Comment data member. More...
 
bool IsSetXref (void) const
 X-Ref/LinkOut Data provided by Depositor Check if a value has been assigned to Xref data member. More...
 
bool CanGetXref (void) const
 Check if it is safe to call GetXref method. More...
 
void ResetXref (void)
 Reset Xref data member. More...
 
const TXrefGetXref (void) const
 Get the Xref member data. More...
 
TXrefSetXref (void)
 Assign a value to Xref data member. More...
 
bool IsSetCompound (void) const
 Structure Description Original Deposited Structure Information Check if a value has been assigned to Compound data member. More...
 
bool CanGetCompound (void) const
 Check if it is safe to call GetCompound method. More...
 
void ResetCompound (void)
 Reset Compound data member. More...
 
const TCompoundGetCompound (void) const
 Get the Compound member data. More...
 
void SetCompound (TCompound &value)
 Assign a value to Compound data member. More...
 
TCompoundSetCompound (void)
 Assign a value to Compound 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
 

Private Types

typedef CPC_Substance_Base Tparent
 

Private Member Functions

 CPC_Substance (const CPC_Substance &value)
 
CPC_Substanceoperator= (const CPC_Substance &value)
 

Additional Inherited Members

- Public Types inherited from CPC_Substance_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_sid , e_source , e_pub ,
  e_synonyms , e_comment , e_xref , e_compound
}
 
typedef CPC_ID TSid
 
typedef CPC_Source TSource
 
typedef list< CRef< CPub > > TPub
 
typedef list< stringTSynonyms
 
typedef list< stringTComment
 
typedef list< CRef< CPC_XRefData > > TXref
 
typedef CPC_Compounds TCompound
 
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...
 
- 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

CPC_Substance –.

Definition at line 65 of file PC_Substance.hpp.


The documentation for this class was generated from the following files:
Modified on Sat Jul 13 13:38:37 2024 by modify_doxy.py rev. 669887