OdStringBuf Class Reference

#include <OdStringBuf.h>

Inheritance diagram for OdStringBuf:

Public Types
enum	CharFormat {   CharFormat_Undefined = 0 , CharFormat_ANSI , CharFormat_UTF8 , CharFormat_UTF16LE ,   CharFormat_UTF16BE , CharFormat_UTF32LE , CharFormat_UTF32BE }

Public Member Functions
	OdStringBuf ()
void	init (OdStreamBuf *pIo, CharFormat cf=CharFormat_Undefined)
	ODRX_DECLARE_MEMBERS (OdStringBuf)
virtual OdString	getString ()
OdStreamBuf *	getIOPtr () const
CharFormat	getCharFormat ()
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdUInt32	GetUnicodeHeaderForType (OdStringBuf::CharFormat type)
static OdInt64	GetUnicodeHeaderSizeForType (OdStringBuf::CharFormat type)
static OdInt64	GetUnicodeBitSizeForType (OdStringBuf::CharFormat type)
static void	DefaultingType (OdStringBuf::CharFormat &type)
static void	DefaultUTF16Type (OdStringBuf::CharFormat &type)
static void	DefaultUTF32Type (OdStringBuf::CharFormat &type)
static void	WriteUnicodeHeader (OdStringBuf::CharFormat type, OdStreamBuf &io)
static void	WriteString (OdStringBuf::CharFormat type, OdStreamBuf &io, const char *text)
static void	WriteString (OdStringBuf::CharFormat type, OdStreamBuf &io, const OdChar *text)
static void	WriteNL (OdStringBuf::CharFormat type, OdStreamBuf &io, bool use_odc=true)
static void	WriteSpace (OdStringBuf::CharFormat type, OdStreamBuf &io, bool use_odc=true)
static void	WriteTab (OdStringBuf::CharFormat type, OdStreamBuf &io, bool use_odc=true)
static void	WriteOdInt8 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdInt8 var)
static void	WriteOdUInt8 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdUInt8 var)
static void	WriteOdInt16 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdInt16 var)
static void	WriteOdUInt16 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdUInt16 var)
static void	WriteOdInt32 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdInt32 var)
static void	WriteOdUInt32 (OdStringBuf::CharFormat type, OdStreamBuf &io, OdUInt32 var)
static void	WriteOdFloat (OdStringBuf::CharFormat type, OdStreamBuf &io, float var)
static void	WriteOdDouble (OdStringBuf::CharFormat type, OdStreamBuf &io, double var)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
static void	rxInit ()
static void	rxUninit ()

Protected Member Functions
OdStringBuf::CharFormat	DetermineCharFormat () const
OdChar	ReadChar (OdChar &secChr) const
OdInt64	GetUnicodeHeaderSize () const
OdInt64	GetUnicodeBitSize () const
OdChar	FromANSI (OdUInt8 chr) const
OdChar	FromUTF8 (OdUInt8 chr) const
OdChar	FromUTF16LE (OdUInt16 chr) const
OdChar	FromUTF16BE (OdUInt16 chr) const
OdChar	FromUTF32LE (OdUInt32 chr, OdChar &secChr) const
OdChar	FromUTF32BE (OdUInt32 chr, OdChar &secChr) const

Static Protected Member Functions
static void	Swap2BytesNumber (OdUInt16 &W)
static void	Swap4BytesNumber (OdUInt32 &DW)
static void	Swap2BytesChar (OdChar &W)

Protected Attributes
OdStreamBufPtr	m_pIo
CharFormat	m_cf

Detailed Description

Text read/write helper. Provide Unicode charsets support for text files processing.

  Corresponding C++ library: TD_DbRoot

<group Other_Classes>

Definition at line 39 of file OdStringBuf.h.

Member Enumeration Documentation

CharFormat

enum OdStringBuf::CharFormat

Charset.

Enumerator
CharFormat_Undefined
CharFormat_ANSI
CharFormat_UTF8
CharFormat_UTF16LE
CharFormat_UTF16BE
CharFormat_UTF32LE
CharFormat_UTF32BE

Definition at line 45 of file OdStringBuf.h.

Constructor & Destructor Documentation

OdStringBuf()

OdStringBuf::OdStringBuf

(

)

Member Function Documentation

DefaultingType()

static void OdStringBuf::DefaultingType ( OdStringBuf::CharFormat & type )

static

Sets charset for current configuration.

Parameters

type	[out] Charset.

DefaultUTF16Type()

static void OdStringBuf::DefaultUTF16Type ( OdStringBuf::CharFormat & type )

static

Sets charset for current UTF-16 configuration.

Parameters

type	[out] Charset.

DefaultUTF32Type()

static void OdStringBuf::DefaultUTF32Type ( OdStringBuf::CharFormat & type )

static

Sets charset for current UTF-32 configuration.

Parameters

type	[out] Charset.

DetermineCharFormat()

OdStringBuf::CharFormat OdStringBuf::DetermineCharFormat ( ) const

protected

FromANSI()

OdChar OdStringBuf::FromANSI ( OdUInt8 chr ) const

protected

FromUTF16BE()

OdChar OdStringBuf::FromUTF16BE ( OdUInt16 chr ) const

protected

FromUTF16LE()

OdChar OdStringBuf::FromUTF16LE ( OdUInt16 chr ) const

protected

FromUTF32BE()

OdChar OdStringBuf::FromUTF32BE ( OdUInt32 chr, OdChar & secChr ) const

protected

FromUTF32LE()

OdChar OdStringBuf::FromUTF32LE ( OdUInt32 chr, OdChar & secChr ) const

protected

FromUTF8()

OdChar OdStringBuf::FromUTF8 ( OdUInt8 chr ) const

protected

getCharFormat()

CharFormat OdStringBuf::getCharFormat ( )

inline

Returns current charset.

Definition at line 85 of file OdStringBuf.h.

getIOPtr()

OdStreamBuf * OdStringBuf::getIOPtr ( ) const

inline

Returns pointer onto current OdStreamBuf interface.

Definition at line 77 of file OdStringBuf.h.

getString()

virtual OdString OdStringBuf::getString ( )

virtual

Reads next line of text from text file.

GetUnicodeBitSize()

OdInt64 OdStringBuf::GetUnicodeBitSize ( ) const

protected

GetUnicodeBitSizeForType()

static OdInt64 OdStringBuf::GetUnicodeBitSizeForType ( OdStringBuf::CharFormat type )

static

Returns character size in bytes for specified charset.

Parameters

type	[in] Charset.

GetUnicodeHeaderForType()

static OdUInt32 OdStringBuf::GetUnicodeHeaderForType ( OdStringBuf::CharFormat type )

static

Returns text file header value for specified charset.

Parameters

type	[in] Charset.

GetUnicodeHeaderSize()

OdInt64 OdStringBuf::GetUnicodeHeaderSize ( ) const

protected

GetUnicodeHeaderSizeForType()

static OdInt64 OdStringBuf::GetUnicodeHeaderSizeForType ( OdStringBuf::CharFormat type )

static

Returns text file header size for specified charset.

Parameters

type	[in] Charset.

init()

void OdStringBuf::init	(	OdStreamBuf *	pIo,
		CharFormat	cf = CharFormat_Undefined )

Initialize OdStringBuf by OdStreamBuf interface and, optionally, by charset.

Parameters

pIo	[in] OdStreamBuf interface.
cf	[in] Charset.

ODRX_DECLARE_MEMBERS()

OdStringBuf::ODRX_DECLARE_MEMBERS

(

OdStringBuf

)

ReadChar()

OdChar OdStringBuf::ReadChar ( OdChar & secChr ) const

protected

Swap2BytesChar()

static void OdStringBuf::Swap2BytesChar ( OdChar & W )

staticprotected

Swap2BytesNumber()

static void OdStringBuf::Swap2BytesNumber ( OdUInt16 & W )

staticprotected

Swap4BytesNumber()

static void OdStringBuf::Swap4BytesNumber ( OdUInt32 & DW )

staticprotected

WriteNL()

static void OdStringBuf::WriteNL ( OdStringBuf::CharFormat type, OdStreamBuf & io, bool use_odc = true )

static

Writes line feed into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
use_odc	[in] Write as Unicode text.

WriteOdDouble()

static void OdStringBuf::WriteOdDouble ( OdStringBuf::CharFormat type, OdStreamBuf & io, double var )

static

Writes double floating point value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdFloat()

static void OdStringBuf::WriteOdFloat ( OdStringBuf::CharFormat type, OdStreamBuf & io, float var )

static

Writes floating point value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdInt16()

static void OdStringBuf::WriteOdInt16 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdInt16 var )

static

Writes OdInt16 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdInt32()

static void OdStringBuf::WriteOdInt32 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdInt32 var )

static

Writes OdInt32 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdInt8()

static void OdStringBuf::WriteOdInt8 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdInt8 var )

static

Writes OdInt8 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdUInt16()

static void OdStringBuf::WriteOdUInt16 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdUInt16 var )

static

Writes OdUInt16 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdUInt32()

static void OdStringBuf::WriteOdUInt32 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdUInt32 var )

static

Writes OdUInt32 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteOdUInt8()

static void OdStringBuf::WriteOdUInt8 ( OdStringBuf::CharFormat type, OdStreamBuf & io, OdUInt8 var )

static

Writes OdUInt8 value as text into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
var	[in] Numeric value.

WriteSpace()

static void OdStringBuf::WriteSpace ( OdStringBuf::CharFormat type, OdStreamBuf & io, bool use_odc = true )

static

Writes space character into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
use_odc	[in] Write as Unicode text.

WriteString() [1/2]

static void OdStringBuf::WriteString ( OdStringBuf::CharFormat type, OdStreamBuf & io, const char * text )

static

Writes ANSI string into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
text	[in] ANSI text string.

WriteString() [2/2]

static void OdStringBuf::WriteString ( OdStringBuf::CharFormat type, OdStreamBuf & io, const OdChar * text )

static

Writes Unicode string into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
text	[in] Unicode text string.

WriteTab()

static void OdStringBuf::WriteTab ( OdStringBuf::CharFormat type, OdStreamBuf & io, bool use_odc = true )

static

Writes tabulation character into specified OdStreamBuf.

Parameters

type	[in] Writing charset.
io	[in] OdStreamBuf interface.
use_odc	[in] Write as Unicode text.

WriteUnicodeHeader()

static void OdStringBuf::WriteUnicodeHeader ( OdStringBuf::CharFormat type, OdStreamBuf & io )

static

Writes text file header into specified OdStreamBuf.

Parameters

type	[in] Charset.
io	[in] OdStreamBuf interface.

Member Data Documentation

m_cf

CharFormat OdStringBuf::m_cf

protected

Definition at line 57 of file OdStringBuf.h.

m_pIo

OdStreamBufPtr OdStringBuf::m_pIo

mutableprotected

Definition at line 56 of file OdStringBuf.h.

---

The documentation for this class was generated from the following file:

• OdStringBuf.h