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

Search Toolkit Book for CObjectInfo

CObjectInfo –. More...

#include <serial/objectinfo.hpp>

+ Inheritance diagram for CObjectInfo:
+ Collaboration diagram for CObjectInfo:

Public Types

typedef TObjectPtr TObjectPtrType
 
typedef CObjectInfoEI CElementIterator
 
typedef CObjectInfoMI CMemberIterator
 
typedef CObjectInfoCV CChoiceVariant
 
- Public Types inherited from CConstObjectInfo
enum  ENonCObject { eNonCObject }
 
typedef TConstObjectPtr TObjectPtrType
 
typedef CConstObjectInfoEI CElementIterator
 
typedef CConstObjectInfoMI CMemberIterator
 
typedef CConstObjectInfoCV CChoiceVariant
 
- Public Types inherited from CObjectTypeInfo
typedef CObjectTypeInfoMI CMemberIterator
 
typedef CObjectTypeInfoVI CVariantIterator
 
typedef CObjectTypeInfoCV CChoiceVariant
 
typedef int TASNTag
 

Public Member Functions

 CObjectInfo (void)
 Create empty CObjectInfo. More...
 
 CObjectInfo (TObjectPtr objectPtr, TTypeInfo typeInfo)
 Initialize CObjectInfo. More...
 
 CObjectInfo (pair< TObjectPtr, TTypeInfo > object)
 
 CObjectInfo (TObjectPtr objectPtr, TTypeInfo typeInfo, ENonCObject nonCObject)
 Initialize CObjectInfo when we are sure that object is not inherited from CObject (for efficiency) More...
 
 CObjectInfo (TTypeInfo typeInfo)
 Create CObjectInfo with new object. More...
 
 CObjectInfo (const CObjectTypeInfo &type)
 
CObjectInfooperator= (pair< TObjectPtr, TTypeInfo > object)
 Set CObjectInfo to point to another object. More...
 
TObjectPtr GetObjectPtr (void) const
 Get pointer to object. More...
 
pair< TObjectPtr, TTypeInfoGetPair (void) const
 
void SetPrimitiveValueBool (bool value)
 Set boolean data. More...
 
void SetPrimitiveValueChar (char value)
 
void SetPrimitiveValueInt4 (Int4 value)
 
void SetPrimitiveValueUint4 (Uint4 value)
 
void SetPrimitiveValueInt8 (Int8 value)
 
void SetPrimitiveValueUint8 (Uint8 value)
 
void SetPrimitiveValueInt (int value)
 
void SetPrimitiveValueUInt (unsigned value)
 
void SetPrimitiveValueLong (long value)
 
void SetPrimitiveValueULong (unsigned long value)
 
void SetPrimitiveValueDouble (double value)
 
void SetPrimitiveValueString (const string &value)
 
void SetPrimitiveValueOctetString (const vector< char > &value)
 
void SetPrimitiveValueBitString (const CBitString &value)
 
void SetPrimitiveValueAnyContent (const CAnyContentObject &value)
 
CMemberIterator GetMember (CObjectTypeInfo::CMemberIterator m) const
 Find class member by type iterator. More...
 
CMemberIterator BeginMembers (void) const
 Create class member iterator. More...
 
CMemberIterator GetClassMemberIterator (TMemberIndex index) const
 Create class member iterator that initially points to specified member. More...
 
CMemberIterator FindClassMember (const string &memberName) const
 Find class member by its name. More...
 
CMemberIterator FindClassMemberByTag (int memberTag) const
 Find class member by its numerical tag. More...
 
CObjectInfo SetClassMember (TMemberIndex index) const
 Create member if necessary and return member object. More...
 
CChoiceVariant GetCurrentChoiceVariant (void) const
 Get data and type information of selected choice variant. More...
 
CObjectInfo SetChoiceVariant (TMemberIndex index) const
 Select choice variant, if necessary, and return variant object. More...
 
CObjectInfo GetPointedObject (void) const
 Get data and type information of object to which this type refers. More...
 
CObjectInfo SetPointedObject (void) const
 Create if necessary and return pointed object. More...
 
CElementIterator BeginElements (void) const
 Create container elements iterator. More...
 
void ReadContainer (CObjectIStream &in, CReadContainerElementHook &hook)
 Read element data from stream. More...
 
CObjectInfo AddNewElement (void) const
 Add and return new element object. More...
 
CObjectInfo AddNewPointedElement (void) const
 add new pointer element, create new pointed object and return it More...
 
- Public Member Functions inherited from CConstObjectInfo
 CConstObjectInfo (void)
 Create empty CObjectInfo. More...
 
 CConstObjectInfo (TConstObjectPtr objectPtr, TTypeInfo typeInfo)
 Initialize CObjectInfo. More...
 
 CConstObjectInfo (pair< TConstObjectPtr, TTypeInfo > object)
 
 CConstObjectInfo (pair< TObjectPtr, TTypeInfo > object)
 
 CConstObjectInfo (TConstObjectPtr objectPtr, TTypeInfo typeInfo, ENonCObject nonCObject)
 Initialize CObjectInfo when we are sure that object is not inherited from CObject (for efficiency) More...
 
void Reset (void)
 Reset CObjectInfo to empty state. More...
 
CConstObjectInfooperator= (pair< TConstObjectPtr, TTypeInfo > object)
 Set CObjectInfo. More...
 
CConstObjectInfooperator= (pair< TObjectPtr, TTypeInfo > object)
 
bool operator== (const CConstObjectInfo &obj) const
 
bool operator!= (const CConstObjectInfo &obj) const
 
TConstObjectPtr GetObjectPtr (void) const
 Get pointer to object. More...
 
pair< TConstObjectPtr, TTypeInfoGetPair (void) const
 
bool GetPrimitiveValueBool (void) const
 Get boolean data. More...
 
char GetPrimitiveValueChar (void) const
 Get char data. More...
 
Int4 GetPrimitiveValueInt4 (void) const
 Get data as Int4. More...
 
Uint4 GetPrimitiveValueUint4 (void) const
 Get data as Uint4. More...
 
Int8 GetPrimitiveValueInt8 (void) const
 Get data as Int8. More...
 
Uint8 GetPrimitiveValueUint8 (void) const
 Get data as Uint8. More...
 
int GetPrimitiveValueInt (void) const
 Get data as int. More...
 
unsigned GetPrimitiveValueUInt (void) const
 Get data as unsigned int. More...
 
long GetPrimitiveValueLong (void) const
 Get data as long. More...
 
unsigned long GetPrimitiveValueULong (void) const
 Get data as unsigned loch. More...
 
double GetPrimitiveValueDouble (void) const
 Get data as double. More...
 
void GetPrimitiveValueString (string &value) const
 Get string data. More...
 
string GetPrimitiveValueString (void) const
 Get string data. More...
 
void GetPrimitiveValueOctetString (vector< char > &value) const
 Get octet string data. More...
 
void GetPrimitiveValueBitString (CBitString &value) const
 Get bit string data. More...
 
void GetPrimitiveValueAnyContent (CAnyContentObject &value) const
 Get data as CAnyContentObject. More...
 
CMemberIterator BeginMembers (void) const
 Create class member iterator. More...
 
CMemberIterator GetClassMemberIterator (TMemberIndex index) const
 Create class member iterator that initially points to specified member. More...
 
CMemberIterator FindClassMember (const string &memberName) const
 Find class member by its name. More...
 
CMemberIterator FindClassMemberByTag (int memberTag) const
 Find class member by its numerical tag. More...
 
CMemberIterator GetMember (CObjectTypeInfo::CMemberIterator m) const
 Find class member by type iterator. More...
 
TMemberIndex GetCurrentChoiceVariantIndex (void) const
 Get index of currently selected choice variant. More...
 
CChoiceVariant GetCurrentChoiceVariant (void) const
 Get data and type information of selected choice variant. More...
 
CConstObjectInfo GetPointedObject (void) const
 Get data and type information of object to which this type refers. More...
 
CElementIterator BeginElements (void) const
 Create container elements iterator. More...
 
- Public Member Functions inherited from CObjectTypeInfo
 CObjectTypeInfo (TTypeInfo typeinfo=0)
 
const stringGetName (void) const
 Get type name. More...
 
ETypeFamily GetTypeFamily (void) const
 Get data type family. More...
 
bool Valid (void) const
 Check if object is valid. More...
 
 DECLARE_OPERATOR_BOOL_PTR (m_TypeInfo)
 
bool operator== (const CObjectTypeInfo &type) const
 
bool operator!= (const CObjectTypeInfo &type) const
 
EPrimitiveValueType GetPrimitiveValueType (void) const
 Get type of primitive value. More...
 
bool IsPrimitiveValueSigned (void) const
 Is primitive value signed. More...
 
const CEnumeratedTypeValuesGetEnumeratedTypeValues (void) const
 Get a set of possible values of enumeration. More...
 
CObjectTypeInfo GetElementType (void) const
 Get type information of an element of container. More...
 
CMemberIterator BeginMembers (void) const
 Create class member iterator. More...
 
CMemberIterator FindMember (const string &memberName) const
 Find class member by its name. More...
 
TMemberIndex FindMemberIndex (const string &name) const
 Find class member index by its name. More...
 
CMemberIterator FindMemberByTag (int memberTag) const
 Find class member by its numerical tag. More...
 
TMemberIndex FindMemberIndex (int tag) const
 Find class member index by its numerical tag. More...
 
CVariantIterator BeginVariants (void) const
 Create choice variant iterator. More...
 
CVariantIterator FindVariant (const string &memberName) const
 Find choice variant by its name. More...
 
TMemberIndex FindVariantIndex (const string &name) const
 Find choice variant index by its name. More...
 
CVariantIterator FindVariantByTag (int memberTag) const
 Find choice variant by its numerical tag. More...
 
TMemberIndex FindVariantIndex (int tag) const
 Find choice variant index by its numerical tag. More...
 
CObjectTypeInfo GetPointedType (void) const
 Get type information of data to which this type refers. More...
 
void SetLocalReadHook (CObjectIStream &stream, CReadObjectHook *hook) const
 Set local (for the specified stream) read hook. More...
 
void SetGlobalReadHook (CReadObjectHook *hook) const
 Set global (for all streams) read hook. More...
 
void ResetLocalReadHook (CObjectIStream &stream) const
 Reset local read hook. More...
 
void ResetGlobalReadHook (void) const
 Reset global read hooks. More...
 
void SetPathReadHook (CObjectIStream *stream, const string &path, CReadObjectHook *hook) const
 Set local context-specific read hook. More...
 
void SetLocalWriteHook (CObjectOStream &stream, CWriteObjectHook *hook) const
 Set local (for the specified stream) write hook. More...
 
void SetGlobalWriteHook (CWriteObjectHook *hook) const
 Set global (for all streams) write hook. More...
 
void ResetLocalWriteHook (CObjectOStream &stream) const
 Reset local write hook. More...
 
void ResetGlobalWriteHook (void) const
 Reset global write hooks. More...
 
void SetPathWriteHook (CObjectOStream *stream, const string &path, CWriteObjectHook *hook) const
 Set local context-specific write hook. More...
 
void SetLocalSkipHook (CObjectIStream &stream, CSkipObjectHook *hook) const
 Set local (for the specified stream) skip hook. More...
 
void ResetLocalSkipHook (CObjectIStream &stream) const
 Reset local skip hook. More...
 
void SetPathSkipHook (CObjectIStream *stream, const string &path, CSkipObjectHook *hook) const
 Set local context-specific skip hook. More...
 
void SetLocalCopyHook (CObjectStreamCopier &stream, CCopyObjectHook *hook) const
 Set local (for the specified stream) copy hook. More...
 
void SetGlobalCopyHook (CCopyObjectHook *hook) const
 Set global (for all streams) copy hook. More...
 
void ResetLocalCopyHook (CObjectStreamCopier &stream) const
 Reset local copy hook. More...
 
void ResetGlobalCopyHook (void) const
 Reset global read hooks. More...
 
void SetPathCopyHook (CObjectStreamCopier *stream, const string &path, CCopyObjectHook *hook) const
 Set local context-specific copy hook. More...
 
TTypeInfo GetTypeInfo (void) const
 
const CPrimitiveTypeInfoGetPrimitiveTypeInfo (void) const
 
const CEnumeratedTypeInfoGetEnumeratedTypeInfo (void) const
 
const CClassTypeInfoGetClassTypeInfo (void) const
 
const CChoiceTypeInfoGetChoiceTypeInfo (void) const
 
const CContainerTypeInfoGetContainerTypeInfo (void) const
 
const CPointerTypeInfoGetPointerTypeInfo (void) const
 
CMemberIterator GetMemberIterator (TMemberIndex index) const
 
CVariantIterator GetVariantIterator (TMemberIndex index) const
 
TASNTag GetASNTag () const
 

Private Types

typedef CConstObjectInfo CParent
 

Additional Inherited Members

- Protected Member Functions inherited from CConstObjectInfo
void ResetObjectPtr (void)
 
void Set (TConstObjectPtr objectPtr, TTypeInfo typeInfo)
 
- Protected Member Functions inherited from CObjectTypeInfo
void ResetTypeInfo (void)
 
void SetTypeInfo (TTypeInfo typeinfo)
 
void CheckTypeFamily (ETypeFamily family) const
 
void WrongTypeFamily (ETypeFamily needFamily) const
 

Detailed Description

CObjectInfo –.

Facilitate read/write access to a particular instance of an object of the specified type.

Definition at line 596 of file objectinfo.hpp.


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