Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCObjectIStream.html below:
NCBI C++ ToolKit: CObjectIStream Class Reference
enum EFailFlags {
fNoError = 0 , eNoError = fNoError , fEOF = 1 << 0 , eEOF = fEOF ,
fReadError = 1 << 1 , eReadError = fReadError , fFormatError = 1 << 2 , eFormatError = fFormatError ,
fOverflow = 1 << 3 , eOverflow = fOverflow , fInvalidData = 1 << 4 , eInvalidData = fInvalidData ,
fIllegalCall = 1 << 5 , eIllegalCall = fIllegalCall , fFail = 1 << 6 , eFail = fFail ,
fNotOpen = 1 << 7 , eNotOpen = fNotOpen , fNotImplemented = 1 << 8 , eNotImplemented = fNotImplemented ,
fMissingValue = 1 << 9 , eMissingValue = fMissingValue , fUnknownValue = 1 << 10 , eUnknownValue = fUnknownValue ,
fNullValue = 1 << 11 , eNullValue = fNullValue
} Fail flags. More...
enum EDelayBufferParsing { eDelayBufferPolicyNotSet , eDelayBufferPolicyAlwaysParse , eDelayBufferPolicyNeverParse } DelayBuffer parsing policy. More...
enum ENoFileHeader { eNoFileHeader } enum EPointerType { eNullPointer , eObjectPointer , eThisPointer , eOtherPointer } enum EFlags {
fFlagNone = 0 , eFlagNone = fFlagNone , fFlagAllowNonAsciiChars = 1 << 0 , eFlagAllowNonAsciiChars = fFlagAllowNonAsciiChars ,
fFlagEnforcedStdXml = 1 << 1 , eFlagEnforcedStdXml = fFlagEnforcedStdXml
} enum ESpecialCaseRead { eReadAsNormal = 0 , eReadAsDefault = 1 , eReadAsNil = 2 , eReadAsBigInt = 4 } typedef int TFailFlags typedef int TFlags typedef CObjectStackFrame TFrame typedef TFrame::EFrameType EFrameType virtual ~CObjectIStream (void) Destructor. More...
ESerialDataFormat GetDataFormat (void) const Get data format. More...
void Open (CByteSourceReader &reader) Attach reader to a data source. More...
void Open (CByteSource &source) Attach reader to a data source. More...
void Open (CNcbiIstream &inStream, bool deleteInStream) Attach reader to an input stream. More...
void Open (CNcbiIstream &inStream, EOwnership deleteInStream=eNoOwnership) Attach reader to an input stream. More...
void OpenFromBuffer (const char *buffer, size_t size) Attach reader to a data source. More...
void Close (void) Detach reader from a data source. More...
void SetVerifyData (ESerialVerifyData verify) Set up input data verification for this particular stream. More...
ESerialVerifyData GetVerifyData (void) const Get input data verification parameter. More...
void SetSkipUnknownMembers (ESerialSkipUnknown skip) Set up skipping unknown members for this particular stream. More...
ESerialSkipUnknown GetSkipUnknownMembers (void) Get skip unknown members parameter. More...
void SetSkipUnknownVariants (ESerialSkipUnknown skip) Set up skipping unknown choice variants for this particular stream. More...
ESerialSkipUnknown GetSkipUnknownVariants (void) Get skip unknown choice variants parameter. More...
bool CanSkipUnknownMembers (void) Simple check if it's allowed to skip unknown members. More...
bool CanSkipUnknownVariants (void) Simple check if it's allowed to skip unknown variants. More...
ESerialSkipUnknown UpdateSkipUnknownMembers (void) Update skip unknown members option to non-default value. More...
ESerialSkipUnknown UpdateSkipUnknownVariants (void) Update skip unknown variants option to non-default value. More...
EFixNonPrint FixNonPrint (EFixNonPrint how) void FixNonPrintSubst (char subst) bool fail (void) const Check if any of fail flags is set. More...
TFailFlags GetFailFlags (void) const Get fail flags. More...
TFailFlags SetFailFlags (TFailFlags flags, const char *message=0) Set fail flags. More...
TFailFlags ClearFailFlags (TFailFlags flags) Reset fail flags. More...
bool InGoodState (void) Check fail flags and also the state of input data source. More...
virtual bool EndOfData (void) Check if there is still some meaningful data that can be read; in text streams this function will skip white spaces and comments. More...
void SetCanceledCallback (const ICanceled *callback) Set cancellation check callback. More...
CNcbiStreampos GetStreamOffset (void) const CNcbiStreampos GetStreamPos (void) const Get the current stream position. More...
void SetStreamOffset (CNcbiStreampos pos) void SetStreamPos (CNcbiStreampos pos) Set the current read position in underlying input stream This is the same as istream::seekg() More...
virtual string GetStackTrace (void) const override Get current stack trace as string. More...
virtual string GetPosition (void) const override Get current stream position as string. More...
virtual void Location (string &, size_t &) const Get current stream location as tuple (positiontype:string, size_t). More...
void SetPathReadObjectHook (const string &path, CReadObjectHook *hook) void SetPathSkipObjectHook (const string &path, CSkipObjectHook *hook) void SetPathReadMemberHook (const string &path, CReadClassMemberHook *hook) void SetPathSkipMemberHook (const string &path, CSkipClassMemberHook *hook) void SetPathReadVariantHook (const string &path, CReadChoiceVariantHook *hook) void SetPathSkipVariantHook (const string &path, CSkipChoiceVariantHook *hook) void SetMonitorType (TTypeInfo type) void AddMonitorType (TTypeInfo type) void ResetMonitorType (void) void SetDelayBufferParsingPolicy (EDelayBufferParsing policy) EDelayBufferParsing GetDelayBufferParsingPolicy (void) const bool ShouldParseDelayBuffer (void) const virtual set< TTypeInfo > GuessDataType (const set< TTypeInfo > &known_types, size_t max_length=16, size_t max_bytes=1024 *1024) Identify the type of data in the stream. More...
void Read (const CObjectInfo &object) Read object of know type. More...
void Read (TObjectPtr object, TTypeInfo type) Read object of know type. More...
CObjectInfo Read (const CObjectTypeInfo &type) Read object of know type. More...
CObjectInfo Read (TTypeInfo type) Read object of know type. More...
void Skip (const CObjectTypeInfo &type) Skip object of know type. More...
void Skip (TTypeInfo type) Skip object of know type. More...
virtual string ReadFileHeader (void) Read file header. More...
void SkipFileHeader (TTypeInfo typeInfo) Read file header and compare the type name with the expected one. More...
void Read (const CObjectInfo &object, ENoFileHeader noFileHeader) Read object of know type when the file header is already read. More...
void Read (TObjectPtr object, TTypeInfo type, ENoFileHeader noFileHeader) Read object of know type when the file header is already read. More...
void Skip (TTypeInfo type, ENoFileHeader noFileHeader) Skip object of know type when the file header is already read. More...
void ReadObject (const CObjectInfo &object) Read child object. More...
void ReadObject (TObjectPtr object, TTypeInfo typeInfo) Read child object. More...
void SkipObject (const CObjectTypeInfo &objectType) Skip child object. More...
void SkipObject (TTypeInfo typeInfo) Skip child object. More...
void ReadSeparateObject (const CObjectInfo &object) Temporary reader. More...
void ReadClassMember (const CObjectInfoMI &member) void ReadChoiceVariant (const CObjectInfoCV &object) void SetDiscardCurrObject (bool discard=true) Discard the object, which has been just read. More...
bool GetDiscardCurrObject (void) const virtual string PeekNextTypeName (void) Peek next data type name in XML stream. More...
void ReadStd (bool &data) void SkipStd (const bool &) void ReadStd (char &data) void SkipStd (const char &) void ReadStd (signed char &data) void ReadStd (unsigned char &data) void SkipStd (const signed char &) void SkipStd (const unsigned char &) void ReadStd (short &data) void ReadStd (unsigned short &data) void SkipStd (const short &) void SkipStd (const unsigned short &) void ReadStd (int &data) void ReadStd (unsigned &data) void SkipStd (const int &) void SkipStd (const unsigned &) void ReadStd (long &data) void ReadStd (unsigned long &data) void SkipStd (const long &) void SkipStd (const unsigned long &) void ReadStd (Int8 &data) void ReadStd (Uint8 &data) void SkipStd (const Int8 &) void SkipStd (const Uint8 &) void ReadStd (float &data) void ReadStd (double &data) void SkipStd (const float &) void SkipStd (const double &) void ReadStd (string &data) void SkipStd (const string &) void ReadStd (char *&data) void ReadStd (const char *&data) void SkipStd (char *const &) void SkipStd (const char *const &) void ReadStd (CBitString &data) void SkipStd (const CBitString &data) virtual bool ReadBool (void)=0 virtual void SkipBool (void)=0 virtual char ReadChar (void)=0 virtual void SkipChar (void)=0 virtual Int1 ReadInt1 (void) virtual Uint1 ReadUint1 (void) virtual Int2 ReadInt2 (void) virtual Uint2 ReadUint2 (void) virtual Int4 ReadInt4 (void) virtual Uint4 ReadUint4 (void) virtual Int8 ReadInt8 (void)=0 virtual Uint8 ReadUint8 (void)=0 virtual void SkipInt1 (void) virtual void SkipUint1 (void) virtual void SkipInt2 (void) virtual void SkipUint2 (void) virtual void SkipInt4 (void) virtual void SkipUint4 (void) virtual void SkipInt8 (void) virtual void SkipUint8 (void) virtual void SkipSNumber (void)=0 virtual void SkipUNumber (void)=0 virtual float ReadFloat (void) virtual double ReadDouble (void)=0 virtual void SkipFloat (void) virtual void SkipDouble (void) virtual void SkipFNumber (void)=0 virtual void ReadString (string &s, EStringType type=eStringTypeVisible)=0 virtual void ReadPackedString (string &s, CPackString &pack_string, EStringType type=eStringTypeVisible) virtual void SkipString (EStringType type=eStringTypeVisible)=0 virtual void ReadStringStore (string &s) virtual void SkipStringStore (void) virtual char * ReadCString (void) virtual void SkipCString (void) virtual void ReadNull (void)=0 virtual void SkipNull (void)=0 virtual void ReadAnyContentObject (CAnyContentObject &obj)=0 virtual void SkipAnyContentObject (void)=0 virtual void SkipAnyContentVariant (void) virtual void ReadBitString (CBitString &obj)=0 virtual void SkipBitString (void)=0 void ReadCompressedBitString (CBitString &data) virtual void SkipByteBlock (void)=0 virtual pair< TObjectPtr, TTypeInfo > ReadPointer (TTypeInfo declaredType) virtual void SkipPointer (TTypeInfo declaredType) template<class TKey , class TStorage > void ReadStd (CStrictId< TKey, TStorage > &data) template<class TKey , class TStorage > void SkipStd (const CStrictId< TKey, TStorage > &data) virtual void ReadGi (TGi &obj) virtual void SkipGi (void) void SetMemoryPool (CObjectMemoryPool *memory_pool) CObjectMemoryPool * GetMemoryPool (void) void UseMemoryPool (void) void ReadExternalObject (TObjectPtr object, TTypeInfo typeInfo) void SkipExternalObject (TTypeInfo typeInfo) CObjectInfo ReadObject (void) virtual void EndOfRead (void) virtual TEnumValueType ReadEnum (const CEnumeratedTypeValues &values)=0 void ResetLocalHooks (void) bool DetectLoops (void) const void HandleEOF (CEofException &) void ThrowError1 (const CDiagCompileInfo &diag_info, TFailFlags fail, const char *message) void ThrowError1 (const CDiagCompileInfo &diag_info, TFailFlags fail, const string &message) void Unended (const string &msg) virtual void UnendedFrame (void) override void DuplicatedMember (const CMemberInfo *memberInfo) bool ExpectedMember (const CMemberInfo *memberInfo) bool HaveMoreData (void) TFlags GetFlags (void) const TFlags SetFlags (TFlags flags) TFlags ClearFlags (TFlags flags) MLIOVIR void ReadNamedType (TTypeInfo namedTypeInfo, TTypeInfo typeInfo, TObjectPtr object) MLIOVIR void SkipNamedType (TTypeInfo namedTypeInfo, TTypeInfo typeInfo) MLIOVIR void ReadContainer (const CContainerTypeInfo *containerType, TObjectPtr containerPtr) MLIOVIR void SkipContainer (const CContainerTypeInfo *containerType) MLIOVIR void ReadClassSequential (const CClassTypeInfo *classType, TObjectPtr classPtr) MLIOVIR void ReadClassRandom (const CClassTypeInfo *classType, TObjectPtr classPtr) MLIOVIR void SkipClassSequential (const CClassTypeInfo *classType) MLIOVIR void SkipClassRandom (const CClassTypeInfo *classType) MLIOVIR void ReadChoiceSimple (const CChoiceTypeInfo *choiceType, TObjectPtr choicePtr) MLIOVIR void SkipChoiceSimple (const CChoiceTypeInfo *choiceType) MLIOVIR void ReadAlias (const CAliasTypeInfo *aliasType, TObjectPtr aliasPtr) MLIOVIR void SkipAlias (const CAliasTypeInfo *aliasType) virtual void BeginNamedType (TTypeInfo namedTypeInfo) virtual void EndNamedType (void) virtual void BeginContainer (const CContainerTypeInfo *containerType)=0 virtual void EndContainer (void)=0 virtual bool BeginContainerElement (TTypeInfo elementType)=0 virtual void EndContainerElement (void) virtual void BeginClass (const CClassTypeInfo *classInfo)=0 virtual void EndClass (void) virtual TMemberIndex BeginClassMember (const CClassTypeInfo *classType)=0 virtual TMemberIndex BeginClassMember (const CClassTypeInfo *classType, TMemberIndex pos)=0 virtual void EndClassMember (void) virtual void UndoClassMember (void) virtual void BeginChoice (const CChoiceTypeInfo *choiceType) virtual void EndChoice (void) virtual TMemberIndex BeginChoiceVariant (const CChoiceTypeInfo *choiceType)=0 virtual void EndChoiceVariant (void) virtual void BeginBytes (ByteBlock &block)=0 virtual size_t ReadBytes (ByteBlock &block, char *buffer, size_t count)=0 virtual void EndBytes (const ByteBlock &block) virtual void BeginChars (CharBlock &block)=0 virtual size_t ReadChars (CharBlock &block, char *buffer, size_t count)=0 virtual void EndChars (const CharBlock &block) virtual void StartDelayBuffer (void) virtual CRef< CByteSource > EndDelayBuffer (void) void EndDelayBuffer (CDelayBuffer &buffer, const CItemInfo *itemInfo, TObjectPtr objectPtr) TObjectPtr GetParentObjectPtr (TTypeInfo type, size_t max_depth=1, size_t min_depth=1) const int ExpectSpecialCase (void) const TConstObjectPtr GetMemberDefault (void) const void SetSpecialCaseUsed (ESpecialCaseRead used) ESpecialCaseRead GetSpecialCaseUsed (void) const CObjectStack (void) virtual ~CObjectStack (void) size_t GetStackDepth (void) const TFrame & PushFrame (EFrameType type, TTypeInfo typeInfo, TConstObjectPtr objectPtr=0) TFrame & PushFrame (EFrameType type, const CMemberId &memberId) TFrame & PushFrame (EFrameType type) void PopFrame (void) void PopErrorFrame (void) void SetTopMemberId (const CMemberId &memberId) bool IsNsQualified (void) bool IsCompressed (void) const bool StackIsEmpty (void) const void ClearStack (void) string GetStackTraceASN (void) const const TFrame & TopFrame (void) const TFrame & TopFrame (void) TFrame & FetchFrameFromTop (size_t index) const TFrame & FetchFrameFromTop (size_t index) const const TFrame & FetchFrameFromBottom (size_t index) const TTypeInfo GetRecentTypeInfo (void) const bool IsKnownElement (const CTempString &name) const const string & GetStackPath (void) const void WatchPathHooks (bool set=true) void RegisterPathHook (CPathHook *h) void ResetPathHooks (void) static CObjectIStream * Open (ESerialDataFormat format, CNcbiIstream &inStream, bool deleteInStream) Create serial object reader and attach it to an input stream. More...
static CObjectIStream * Open (ESerialDataFormat format, CNcbiIstream &inStream, EOwnership deleteInStream=eNoOwnership) Create serial object reader and attach it to an input stream. More...
static CObjectIStream * Open (ESerialDataFormat format, const string &fileName, TSerialOpenFlags openFlags=0) Create serial object reader and attach it to a file stream. More...
static CObjectIStream * Open (const string &fileName, ESerialDataFormat format) Create serial object reader and attach it to a file stream. More...
static CObjectIStream * Create (ESerialDataFormat format) Create serial object reader. More...
static CObjectIStream * Create (ESerialDataFormat format, CByteSource &source) Create serial object reader and attach it to a data source. More...
static CObjectIStream * Create (ESerialDataFormat format, CByteSourceReader &reader) Create serial object reader and attach it to a data source. More...
static CObjectIStream * CreateFromBuffer (ESerialDataFormat format, const char *buffer, size_t size) Create serial object reader and attach it to a data source. More...
static void SetVerifyDataThread (ESerialVerifyData verify) Set up default input data verification for streams created by the current thread. More...
static void SetVerifyDataGlobal (ESerialVerifyData verify) Set up default input data verification for streams created by the current process. More...
static void SetSkipUnknownThread (ESerialSkipUnknown skip) Set up default skipping unknown members for streams created by the current thread. More...
static void SetSkipUnknownGlobal (ESerialSkipUnknown skip) Set up default skipping unknown members for streams created by the current process. More...
static void SetSkipUnknownVariantsThread (ESerialSkipUnknown skip) Set up default skipping unknown choice variants for streams created by the current thread. More...
static void SetSkipUnknownVariantsGlobal (ESerialSkipUnknown skip) Set up default skipping unknown choice variants for streams created by the current process. More...
static TTypeInfo GetRealTypeInfo (TTypeInfo typeInfo) static ETypeFamily GetRealTypeFamily (TTypeInfo typeInfo) static TTypeInfo GetContainerElementTypeInfo (TTypeInfo typeInfo) static ETypeFamily GetContainerElementTypeFamily (TTypeInfo typeInfo)
CObjectIStream –.
Base class of serial object stream decoders
Definition at line 92 of file objistr.hpp.
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4