Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/classCObjectOStreamXml.html below:
NCBI C++ ToolKit: CObjectOStreamXml Class Reference
enum ERealValueFormat { eRealFixedFormat , eRealScientificFormat } formatting of values of type 'real' ('double') More...
enum EFailFlags {
fNoError = 0 , eNoError = fNoError , fWriteError = 1 << 1 , eWriteError = fWriteError ,
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 ,
fUnassigned = 1 << 9 , eUnassigned = fUnassigned
} Fail flags. More...
enum EDelayBufferParsing { eDelayBufferPolicyNotSet , eDelayBufferPolicyAlwaysParse , eDelayBufferPolicyNeverParse } DelayBuffer parsing policy. More...
enum EFlags {
fFlagNone = 0 , eFlagNone = fFlagNone , fFlagAllowNonAsciiChars = 1 << 0 , eFlagAllowNonAsciiChars = fFlagAllowNonAsciiChars ,
fFlagNoAutoFlush = 1 << 1
} enum ESpecialCaseWrite { eWriteAsNormal = 0 , eWriteAsDefault = 1 , eWriteAsNil = 2 , eWriteAsBigInt = 3 } typedef int TFailFlags typedef int TFlags typedef CObjectStackFrame TFrame typedef TFrame::EFrameType EFrameType CObjectOStreamXml (CNcbiOstream &out, bool deleteOut) Constructor. More...
CObjectOStreamXml (CNcbiOstream &out, EOwnership deleteOut) Constructor. More...
virtual ~CObjectOStreamXml (void) Destructor. More...
virtual string GetPosition (void) const override Get current stream position as string. More...
void SetEncoding (EEncoding enc) Set XML character encoding. More...
EEncoding GetEncoding (void) const Get XML character encoding. More...
void SetDefaultStringEncoding (EEncoding enc) Set default encoding of 'string' objects If XML data encoding is different, string will be converted to this encoding. More...
EEncoding GetDefaultStringEncoding (void) const Get default encoding of 'string' objects. More...
void SetEnforcedStdXml (bool set=true) Set up scope prefixes handling. More...
bool GetEnforcedStdXml (void) Get scope prefixes handling parameter. More...
void SetReferenceSchema (bool use_schema=true) Make generated XML document reference XML schema. More...
bool GetReferenceSchema (void) const Get Schema referencing parameter. More...
void SetReferenceDTD (bool use_dtd=true) Make generated XML document reference DTD. More...
bool GetReferenceDTD (void) const Get DTD referencing parameter. More...
void SetUseSchemaLocation (bool use_loc=true) Put Schema location information into generated XML document. More...
bool GetUseSchemaLocation (void) const Get Schema location output parameter. More...
void SetDefaultSchemaNamespace (const string &schema_ns) Set default value of namespace name of generated DTD documents. More...
string GetDefaultSchemaNamespace (void) Get default value of namespace name of generated DTD documents. More...
void SetDTDFilePrefix (const string &prefix) Set DTD or schema file prefix. More...
string GetDTDFilePrefix (void) const Get DTD or schema file prefix. More...
void SetDTDFileName (const string &filename) Set DTD or schema file name. More...
string GetDTDFileName (void) const Get DTD or schema file name. More...
void EnableDTDPublicId (void) Enable DTD public identifier. More...
void DisableDTDPublicId (void) Disable DTD public identifier. More...
void SetDTDPublicId (const string &publicId) Set DTD public identifier. More...
string GetDTDPublicId (void) const Get DTD public identifier. More...
ERealValueFormat GetRealValueFormat (void) const Get formatting of values of type real. More...
void SetRealValueFormat (ERealValueFormat fmt) Set formatting of values of type real The method is provided for convenience only. More...
virtual void SetFormattingFlags (TSerial_Format_Flags flags) override Set output formatting flags. More...
virtual void WriteFileHeader (TTypeInfo type) override virtual void EndOfWrite (void) override virtual ~CObjectOStream (void) Destructor. More...
ESerialDataFormat GetDataFormat (void) const Get data format. More...
void SetVerifyData (ESerialVerifyData verify) Set up output data verification for this particular stream. More...
ESerialVerifyData GetVerifyData (void) const Get output data verification parameter. More...
EFixNonPrint FixNonPrint (EFixNonPrint how) void FixNonPrintSubst (char subst) void EnforceWritingDefaultValues (bool enforce=true) bool IsWritingDefaultValuesEnforced () const void SetUseIndentation (bool set) Set up indentation usage in text streams. More...
bool GetUseIndentation (void) const Get indentation usage in text streams. More...
void SetUseEol (bool set) Set up end-of-line symbol usage in text streams. More...
bool GetUseEol (void) const Get end-of-line symbol usage in text streams. More...
void SetWriteNamedIntegersByValue (bool set) Set up writing named integers (in ANS.1 sense) by value only. More...
bool GetWriteNamedIntegersByValue (void) const Get writing named integers by value parameter. More...
string GetSeparator (void) const Get separator. More...
void SetSeparator (const string sep) Set separator. More...
bool GetAutoSeparator (void) Get separator auto-output paramater. More...
void SetAutoSeparator (bool value) Set separator auto-output paramater. More...
bool fail (void) const Check if any of fail flags is set. More...
TFailFlags GetFailFlags (void) const Get fail flags. More...
TFailFlags SetFailFlagsNoError (TFailFlags flags) Set fail flags, but do not ERR_POST any messages. More...
TFailFlags SetFailFlags (TFailFlags flags, const char *message) Set fail flags. More...
TFailFlags ClearFailFlags (TFailFlags flags) Reset fail flags. More...
bool InGoodState (void) Check fail flags and also the state of output stream. 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...
virtual string GetStackTrace (void) const override Get current stack trace as string. More...
void SetPathWriteObjectHook (const string &path, CWriteObjectHook *hook) void SetPathWriteMemberHook (const string &path, CWriteClassMemberHook *hook) void SetPathWriteVariantHook (const string &path, CWriteChoiceVariantHook *hook) void SetDelayBufferParsingPolicy (EDelayBufferParsing policy) EDelayBufferParsing GetDelayBufferParsingPolicy (void) const bool ShouldParseDelayBuffer (void) const void FlushBuffer (void) void Flush (void) void DefaultFlush (void) void Write (const CConstObjectInfo &object) void Write (TConstObjectPtr object, TTypeInfo type) void Write (TConstObjectPtr object, const CTypeRef &type) void WriteObject (const CConstObjectInfo &object) void WriteObject (TConstObjectPtr object, TTypeInfo typeInfo) void CopyObject (TTypeInfo objectType, CObjectStreamCopier &copier) void WriteSeparateObject (const CConstObjectInfo &object) void WriteExternalObject (TConstObjectPtr object, TTypeInfo typeInfo) void WriteClassMember (const CConstObjectInfoMI &member) void WriteChoiceVariant (const CConstObjectInfoCV &member) CObjectOStream & operator<< (CObjectOStream &(*mod)(CObjectOStream &os)) void WriteStd (const bool &data) void WriteStd (const char &data) void WriteStd (const signed char &data) void WriteStd (const unsigned char &data) void WriteStd (const short &data) void WriteStd (const unsigned short &data) void WriteStd (const int &data) void WriteStd (const unsigned int &data) void WriteStd (const long &data) void WriteStd (const unsigned long &data) void WriteStd (const Int8 &data) void WriteStd (const Uint8 &data) void WriteStd (const float &data) void WriteStd (const double &data) void WriteStd (const string &data) void WriteStd (const char *const data) void WriteStd (char *const data) void WriteStd (const CBitString &data) virtual bool Write (CByteSource &source) void Write (const char *data, size_t size) void WriteStd (const TGi &data) virtual void WriteGi (const TGi &obj) virtual void CopyGi (CObjectIStream &in) void Close (void) void ResetLocalHooks (void) void HandleEOF (CEofException &) void ThrowError1 (const CDiagCompileInfo &diag_info, TFailFlags fail, const char *message, CException *exc=0) void ThrowError1 (const CDiagCompileInfo &diag_info, TFailFlags fail, const string &message, CException *exc=0) void Unended (const string &msg) virtual void UnendedFrame (void) override TFlags GetFlags (void) const TFlags SetFlags (TFlags flags) TFlags ClearFlags (TFlags flags) MLIOVIR void WriteNamedType (TTypeInfo namedTypeInfo, TTypeInfo typeInfo, TConstObjectPtr object) MLIOVIR void WriteContainer (const CContainerTypeInfo *containerType, TConstObjectPtr containerPtr) void WriteContainerElement (const CConstObjectInfo &element) void WriteClassRandom (const CClassTypeInfo *classType, TConstObjectPtr classPtr) void WriteClassSequential (const CClassTypeInfo *classType, TConstObjectPtr classPtr) MLIOVIR void WriteClass (const CClassTypeInfo *objectType, TConstObjectPtr objectPtr) MLIOVIR void WriteClassMember (const CMemberId &memberId, TTypeInfo memberType, TConstObjectPtr memberPtr) MLIOVIR bool WriteClassMember (const CMemberId &memberId, const CDelayBuffer &buffer) MLIOVIR void WriteAlias (const CAliasTypeInfo *aliasType, TConstObjectPtr aliasPtr) MLIOVIR void CopyNamedType (TTypeInfo namedTypeInfo, TTypeInfo typeInfo, CObjectStreamCopier &copier) MLIOVIR void CopyContainer (const CContainerTypeInfo *containerType, CObjectStreamCopier &copier) MLIOVIR void CopyClassRandom (const CClassTypeInfo *objectType, CObjectStreamCopier &copier) MLIOVIR void CopyClassSequential (const CClassTypeInfo *objectType, CObjectStreamCopier &copier) MLIOVIR void CopyChoice (const CChoiceTypeInfo *choiceType, CObjectStreamCopier &copier) MLIOVIR void CopyAlias (const CAliasTypeInfo *AliasType, CObjectStreamCopier &copier) virtual void BeginBytes (const ByteBlock &block) virtual void EndBytes (const ByteBlock &block) virtual void BeginChars (const CharBlock &block) virtual void EndChars (const CharBlock &block) void WritePointer (TConstObjectPtr object, TTypeInfo typeInfo) void SetSpecialCaseWrite (ESpecialCaseWrite how) MLIOVIR void WriteClassMemberSpecialCase (const CMemberId &memberId, TTypeInfo memberType, TConstObjectPtr memberPtr, ESpecialCaseWrite how) 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 void SetDefaultDTDFilePrefix (const string &prefix) Set default (global) DTD file prefix. More...
static string GetDefaultDTDFilePrefix (void) Get default (global) DTD file prefix. More...
static CObjectOStream * Open (ESerialDataFormat format, CNcbiOstream &outStream, bool deleteOutStream) Create serial object writer and attach it to an output stream. More...
static CObjectOStream * Open (ESerialDataFormat format, CNcbiOstream &outStream, EOwnership deleteOutStream=eNoOwnership, TSerial_Format_Flags formatFlags=0) Create serial object writer and attach it to an output stream. More...
static CObjectOStream * Open (ESerialDataFormat format, const string &fileName, TSerialOpenFlags openFlags=0, TSerial_Format_Flags formatFlags=0) Create serial object writer and attach it to a file stream. More...
static CObjectOStream * Open (const string &fileName, ESerialDataFormat format, TSerial_Format_Flags formatFlags=0) Create serial object writer and attach it to a file stream. More...
static void SetVerifyDataThread (ESerialVerifyData verify) Set up default output data verification for streams created by the current thread. More...
static void SetVerifyDataGlobal (ESerialVerifyData verify) Set up default output data verification 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) virtual void WriteBool (bool data) override virtual void WriteChar (char data) override virtual void WriteInt4 (Int4 data) override virtual void WriteUint4 (Uint4 data) override virtual void WriteInt8 (Int8 data) override virtual void WriteUint8 (Uint8 data) override virtual void WriteFloat (float data) override virtual void WriteDouble (double data) override void WriteDouble2 (double data, unsigned digits) virtual void WriteCString (const char *str) override virtual void WriteString (const string &s, EStringType type=eStringTypeVisible) override virtual void WriteStringStore (const string &s) override virtual void CopyString (CObjectIStream &in, EStringType type=eStringTypeVisible) override virtual void CopyStringStore (CObjectIStream &in) override virtual void WriteNullPointer (void) override virtual void WriteObjectReference (TObjectIndex index) override virtual void WriteOtherBegin (TTypeInfo typeInfo) override virtual void WriteOtherEnd (TTypeInfo typeInfo) override virtual void WriteOther (TConstObjectPtr object, TTypeInfo typeInfo) override virtual void WriteNull (void) override virtual void WriteAnyContentObject (const CAnyContentObject &obj) override virtual void CopyAnyContentObject (CObjectIStream &in) override virtual void WriteBitString (const CBitString &obj) override virtual void CopyBitString (CObjectIStream &in) override void WriteEscapedChar (char c) void WriteEncodedChar (const char *&src, EStringType type=eStringTypeVisible) virtual void WriteEnum (const CEnumeratedTypeValues &values, TEnumValueType value) override virtual void CopyEnum (const CEnumeratedTypeValues &values, CObjectIStream &in) override void WriteEnum (const CEnumeratedTypeValues &values, TEnumValueType value, const string &valueName) void WriteContainerContents (const CContainerTypeInfo *containerType, TConstObjectPtr containerPtr) void WriteChoiceContents (const CChoiceTypeInfo *choiceType, TConstObjectPtr choicePtr) virtual void BeginNamedType (TTypeInfo namedTypeInfo) override virtual void EndNamedType (void) override virtual void BeginContainer (const CContainerTypeInfo *containerType) override virtual void EndContainer (void) override virtual void BeginContainerElement (TTypeInfo elementType) override virtual void EndContainerElement (void) override void BeginArrayElement (TTypeInfo elementType) void EndArrayElement (void) void CheckStdXml (TTypeInfo classType) virtual void BeginClass (const CClassTypeInfo *classInfo) override virtual void EndClass (void) override virtual void BeginClassMember (const CMemberId &id) override void BeginClassMember (TTypeInfo memberType, const CMemberId &id) virtual void EndClassMember (void) override virtual void BeginChoice (const CChoiceTypeInfo *choiceType) override virtual void EndChoice (void) override virtual void BeginChoiceVariant (const CChoiceTypeInfo *choiceType, const CMemberId &id) override virtual void EndChoiceVariant (void) override virtual void WriteBytes (const ByteBlock &block, const char *bytes, size_t length) override virtual void WriteChars (const CharBlock &block, const char *chars, size_t length) override virtual void WriteSeparator (void) override CObjectOStream (ESerialDataFormat format, CNcbiOstream &out, EOwnership deleteOut=eNoOwnership) virtual void WriteThis (TConstObjectPtr object, TTypeInfo typeInfo) void RegisterObject (TTypeInfo typeInfo) void RegisterObject (TConstObjectPtr object, TTypeInfo typeInfo) virtual void x_SetPathHooks (bool set) override EFixNonPrint x_GetFixCharsMethodDefault (void) const EFixNonPrint x_FixCharsMethod (void) const char x_FixCharsSubst (void) const virtual void ResetState (void)
CObjectOStreamXml –.
Encode serial data object using XML format
Definition at line 53 of file objostrxml.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