NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members
CCompoundIDField Class Reference

Search Toolkit Book for CCompoundIDField

Compound ID field – an element of the compound ID that has a type and a value. More...

#include <connect/services/compound_id.hpp>

+ Collaboration diagram for CCompoundIDField:

Public Types

typedef SCompoundIDFieldImplTInstance
 

Public Member Functions

 CCompoundIDField (EVoid)
 
 CCompoundIDField (SCompoundIDFieldImpl *impl)
 
CCompoundIDFieldoperator= (SCompoundIDFieldImpl *impl)
 
 operator SCompoundIDFieldImpl * ()
 
 operator const SCompoundIDFieldImpl * () const
 
SCompoundIDFieldImploperator-- (int)
 
const SCompoundIDFieldImploperator-- (int) const
 
SCompoundIDFieldImploperator-> ()
 
const SCompoundIDFieldImploperator-> () const
 
 CCompoundIDField ()
 
ECompoundIDFieldType GetType ()
 Return the type of this field. More...
 
CCompoundIDField GetNextNeighbor ()
 Return the next immediately adjacent field. More...
 
CCompoundIDField GetNextHomogeneous ()
 Return the next field of the same type. More...
 
void Remove ()
 Remove this field from the compound ID that contains it. More...
 
Uint8 GetID () const
 Return the ID value that this field contains. More...
 
Int8 GetInteger () const
 Return the integer value that this field contains. More...
 
string GetServiceName () const
 Return the LBSM service name that this field contains. More...
 
string GetDatabaseName () const
 Return the database name that this field contains. More...
 
Int8 GetTimestamp () const
 Return the UNIX timestamp that this field contains. More...
 
Uint4 GetRandom () const
 Return the random number value that this field contains. More...
 
Uint4 GetIPv4Address () const
 Return the 32-bit IP address that this field contains. More...
 
string GetHost () const
 Return the host name or address that this field contains. More...
 
Uint2 GetPort () const
 Return the network port number that this field contains. More...
 
string GetObjectRef () const
 Return the object or resource ID that this field contains. More...
 
string GetString () const
 Return the string value that this field contains. More...
 
bool GetBoolean () const
 Return the Boolean value that this field contains. More...
 
Uint8 GetFlags () const
 Return the combination of binary flags stored in this field. More...
 
string GetLabel () const
 Return the application-specific tag that this field contains. More...
 
Uint8 GetCue () const
 Return the application-specific numeric tag value that this field contains. More...
 
string GetSeqID () const
 Return the Sequence ID that this field contains. More...
 
Uint8 GetTaxID () const
 Return the Taxonomy ID that this field contains. More...
 
const CCompoundIDGetNestedCID () const
 Return the nested compound ID that this field contains. More...
 

Protected Attributes

CNetRef< SCompoundIDFieldImplm_Impl
 

Detailed Description

Compound ID field – an element of the compound ID that has a type and a value.

Definition at line 108 of file compound_id.hpp.

Member Typedef Documentation

◆ TInstance

Definition at line 110 of file compound_id.hpp.

Constructor & Destructor Documentation

◆ CCompoundIDField() [1/3]

CCompoundIDField::CCompoundIDField ( EVoid  )
inline

Definition at line 110 of file compound_id.hpp.

◆ CCompoundIDField() [2/3]

CCompoundIDField::CCompoundIDField ( SCompoundIDFieldImpl impl)
inline

Definition at line 110 of file compound_id.hpp.

◆ CCompoundIDField() [3/3]

CCompoundIDField::CCompoundIDField ( )
inline

Definition at line 110 of file compound_id.hpp.

Member Function Documentation

◆ GetBoolean()

bool CCompoundIDField::GetBoolean ( ) const

Return the Boolean value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Boolean.

Definition at line 167 of file compound_id.cpp.

Referenced by CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetCue()

Uint8 CCompoundIDField::GetCue ( ) const

Return the application-specific numeric tag value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Cue.

Definition at line 170 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse().

◆ GetDatabaseName()

string CCompoundIDField::GetDatabaseName ( void  ) const

Return the database name that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_DatabaseName.

Definition at line 157 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), CNetScheduleKey::ParseJobKey(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetFlags()

Uint8 CCompoundIDField::GetFlags ( ) const

Return the combination of binary flags stored in this field.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Flags.

Definition at line 168 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), and CNetCacheKey::ParseBlobKey().

◆ GetHost()

string CCompoundIDField::GetHost ( void  ) const

Return the host name or address that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Host.

Definition at line 162 of file compound_id.cpp.

Referenced by CNetCacheKey::ParseBlobKey(), CNetScheduleKey::ParseJobKey(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetID()

Uint8 CCompoundIDField::GetID ( ) const

Return the ID value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_ID.

Definition at line 154 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), CNetCacheKey::ParseBlobKey(), CNetScheduleKey::ParseJobKey(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetInteger()

Int8 CCompoundIDField::GetInteger ( void  ) const

Return the integer value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Integer.

Definition at line 155 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse().

◆ GetIPv4Address()

Uint4 CCompoundIDField::GetIPv4Address ( ) const

Return the 32-bit IP address that this field contains.

Exceptions
CCompoundIDExceptionif GetType() is neither eCIT_IPv4Address nor eCIT_IPv4SockAddr.

Definition at line 161 of file compound_id.cpp.

Referenced by CNetCacheKey::ParseBlobKey(), and CNetScheduleKey::ParseJobKey().

◆ GetLabel()

string CCompoundIDField::GetLabel ( void  ) const

Return the application-specific tag that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Label.

Definition at line 169 of file compound_id.cpp.

Referenced by CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetNestedCID()

const CCompoundID & CCompoundIDField::GetNestedCID ( ) const

Return the nested compound ID that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_NestedCID.

Definition at line 173 of file compound_id.cpp.

◆ GetNextHomogeneous()

CCompoundIDField CCompoundIDField::GetNextHomogeneous ( )

Return the next field of the same type.

Definition at line 131 of file compound_id.cpp.

References SFieldList< SSameTypeListLink >::GetNext(), m_Impl, next(), and NULL.

Referenced by CNetStorageObjectLoc::Parse(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetNextNeighbor()

CCompoundIDField CCompoundIDField::GetNextNeighbor ( )

Return the next immediately adjacent field.

Definition at line 123 of file compound_id.cpp.

References SFieldList< SNeighborListLink >::GetNext(), m_Impl, next(), and NULL.

Referenced by CNetStorageObjectLoc::Parse(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetObjectRef()

string CCompoundIDField::GetObjectRef ( ) const

Return the object or resource ID that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_ObjectRef.

Definition at line 165 of file compound_id.cpp.

◆ GetPort()

Uint2 CCompoundIDField::GetPort ( void  ) const

Return the network port number that this field contains.

Exceptions
CCompoundIDExceptionif GetType() is neither eCIT_Port nor eCIT_IPv4SockAddr.

Definition at line 164 of file compound_id.cpp.

Referenced by CNetCacheKey::ParseBlobKey(), and CNetScheduleKey::ParseJobKey().

◆ GetRandom()

Uint4 CCompoundIDField::GetRandom ( ) const

Return the random number value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Random

Definition at line 159 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), and CNetCacheKey::ParseBlobKey().

◆ GetSeqID()

string CCompoundIDField::GetSeqID ( ) const

Return the Sequence ID that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_SeqID.

Definition at line 171 of file compound_id.cpp.

◆ GetServiceName()

string CCompoundIDField::GetServiceName ( ) const

Return the LBSM service name that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_ServiceName.

Definition at line 156 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), CNetCacheKey::ParseBlobKey(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetString()

string CCompoundIDField::GetString ( void  ) const

Return the string value that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_String.

Definition at line 166 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetTaxID()

Uint8 CCompoundIDField::GetTaxID ( ) const

Return the Taxonomy ID that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_TaxID.

Definition at line 172 of file compound_id.cpp.

◆ GetTimestamp()

Int8 CCompoundIDField::GetTimestamp ( ) const

Return the UNIX timestamp that this field contains.

Exceptions
CCompoundIDExceptionif GetType() != eCIT_Timestamp.

Definition at line 158 of file compound_id.cpp.

Referenced by CNetStorageObjectLoc::Parse(), CNetCacheKey::ParseBlobKey(), and CGridCommandLineInterfaceApp::ParseLoginToken().

◆ GetType()

ECompoundIDFieldType CCompoundIDField::GetType ( void  )

Return the type of this field.

Definition at line 118 of file compound_id.cpp.

References m_Impl.

◆ operator const SCompoundIDFieldImpl *()

CCompoundIDField::operator const SCompoundIDFieldImpl * ( ) const
inline

Definition at line 110 of file compound_id.hpp.

◆ operator SCompoundIDFieldImpl *()

CCompoundIDField::operator SCompoundIDFieldImpl * ( )
inline

Definition at line 110 of file compound_id.hpp.

◆ operator--() [1/2]

SCompoundIDFieldImpl& CCompoundIDField::operator-- ( int  )
inline

Definition at line 110 of file compound_id.hpp.

◆ operator--() [2/2]

const SCompoundIDFieldImpl& CCompoundIDField::operator-- ( int  ) const
inline

Definition at line 110 of file compound_id.hpp.

◆ operator->() [1/2]

SCompoundIDFieldImpl* CCompoundIDField::operator-> ( void  )
inline

Definition at line 110 of file compound_id.hpp.

◆ operator->() [2/2]

const SCompoundIDFieldImpl* CCompoundIDField::operator-> ( void  ) const
inline

Definition at line 110 of file compound_id.hpp.

◆ operator=()

CCompoundIDField& CCompoundIDField::operator= ( SCompoundIDFieldImpl impl)
inline

Definition at line 110 of file compound_id.hpp.

◆ Remove()

void CCompoundIDField::Remove ( )

Remove this field from the compound ID that contains it.

This will cause the GetNext*() methods to always return NULL.

Definition at line 200 of file compound_id.cpp.

References m_Impl, NULL, and SCompoundIDImpl::Remove().

Member Data Documentation

◆ m_Impl

CNetRef< SCompoundIDFieldImpl > CCompoundIDField::m_Impl
protected

Definition at line 110 of file compound_id.hpp.

Referenced by GetNextHomogeneous(), GetNextNeighbor(), GetType(), and Remove().


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:03:20 2024 by modify_doxy.py rev. 669887