VBentoString Class Reference

VBentoString is a VBentoAttribute that holds a VString value. More...

#include <vbento.h>

Inheritance diagram for VBentoString:

List of all members.

Public Member Functions
	VBentoString ()
	Constructs with uninitialized name and empty string.
	VBentoString (VBinaryIOStream &stream)
	Constructs by reading from stream.
	VBentoString (const VString &name, const VString &s, const VString &encoding)
	Constructs from supplied name and value.
virtual	~VBentoString ()
	Destructor.
virtual VBentoAttribute *	clone () const
VBentoString &	operator= (const VBentoString &rhs)
virtual void	getValueAsXMLText (VString &s) const
	Returns a string suitable for an XML attribute value, including escaping via _escapeXMLValue() if needed.
virtual void	getValueAsString (VString &s) const
	Returns a printable form of the attribute value.
virtual void	getValueAsBentoTextString (VString &s) const
	Returns a Bento Text form of the attribute value.
const VString &	getValue () const
	Returns the attribute's value.
void	setValue (const VString &s)
	Sets the attribute's value.
const VString &	getEncoding () const
	Returns the value's encoding name; empty implies UTF-8.
void	setEncoding (const VString &encoding)
	Sets the the value's encoding name; empty implies UTF-8.
Static Public Member Functions
static const VString &	DATA_TYPE_ID ()
	The data type name / class ID string.
Protected Member Functions
virtual Vs64	getDataLength () const
	Returns the length of this object's raw data only.
virtual void	writeDataToBinaryStream (VBinaryIOStream &stream) const
	Writes the object's raw data only to a binary stream.

---

Detailed Description

VBentoString is a VBentoAttribute that holds a VString value.

Definition at line 1163 of file vbento.h.

---

Constructor & Destructor Documentation

VBentoString::VBentoString

(

VBinaryIOStream &

stream

)

[inline]

Constructs by reading from stream.

Parameters:

stream

the stream to read

Definition at line 1169 of file vbento.h.

---

Member Function Documentation

const VString& VBentoString::getValue

(

)

const [inline]

Returns the attribute's value.

Returns:

a reference to the value string

Definition at line 1180 of file vbento.h.

void VBentoString::setValue

(

const VString &

s

)

[inline]

Sets the attribute's value.

Parameters:

s	the attribute value

Definition at line 1181 of file vbento.h.

const VString& VBentoString::getEncoding

(

)

const [inline]

Returns the value's encoding name; empty implies UTF-8.

Returns:

a reference to the encoding name

Definition at line 1183 of file vbento.h.

void VBentoString::setEncoding

(

const VString &

encoding

)

[inline]

Sets the the value's encoding name; empty implies UTF-8.

Parameters:

encoding

the attribute value's encoding

Definition at line 1184 of file vbento.h.

virtual Vs64 VBentoString::getDataLength

(

)

const [inline, protected, virtual]

Returns the length of this object's raw data only.

Returns:

the length of the object's raw data

Implements VBentoAttribute.

Definition at line 1188 of file vbento.h.

virtual void VBentoString::writeDataToBinaryStream

(

VBinaryIOStream &

stream

)

const [inline, protected, virtual]

Writes the object's raw data only to a binary stream.

Parameters:

stream

the stream to write to

Implements VBentoAttribute.

Definition at line 1189 of file vbento.h.

References VBinaryIOStream::writeString().

---

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

• vbento.h