Vault  4.1
Public Member Functions | Static Public Member Functions | Protected Member Functions
VBentoStringArray Class Reference

VBentoStringArray is a VBentoArray that holds an array of VString values. More...

#include <vbento.h>

Inheritance diagram for VBentoStringArray:
VBentoArray VBentoAttribute

List of all members.

Public Member Functions

 VBentoStringArray ()
 Constructs with uninitialized name and an initially empty array.
 VBentoStringArray (VBinaryIOStream &stream)
 Constructs by reading from stream.
 VBentoStringArray (const VString &name)
 Constructs from supplied name, with an initially empty array.
 VBentoStringArray (const VString &name, const VStringVector &elements)
 Constructs from supplied name and array to be copied.
virtual ~VBentoStringArray ()
 Destructor.
virtual VBentoAttributeclone () const
VBentoStringArrayoperator= (const VBentoStringArray &rhs)
const VStringVectorgetValue () const
 Returns the attribute's value.
void setValue (const VStringVector &elements)
 Sets the attribute's value.
void appendValue (const VString &element)
 Appends to the attribute's value.
void appendValues (const VStringVector &elements)
 Appends to the attribute's value.
virtual void writeToXMLTextStream (VTextIOStream &stream, bool lineWrap, int depth) const
 Override to form this complex attribute as a child tag with its own attributes.

Static Public Member Functions

static VBentoStringArraynewFromBentoTextString (const VString &name, const VString &bentoText)
static const VStringDATA_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.
virtual int _getNumElements () const
virtual void _appendElementBentoText (int elementIndex, VString &s) const

Detailed Description

VBentoStringArray is a VBentoArray that holds an array of VString values.

Definition at line 2117 of file vbento.h.


Constructor & Destructor Documentation

VBentoStringArray::VBentoStringArray ( VBinaryIOStream stream) [inline]

Constructs by reading from stream.

Parameters:
streamthe stream to read

Definition at line 2125 of file vbento.h.

References VBinaryIOStream::readS32(), and VBinaryIOStream::readString().


Member Function Documentation

const VStringVector& VBentoStringArray::getValue ( ) const [inline]

Returns the attribute's value.

Returns:
the value

Definition at line 2133 of file vbento.h.

void VBentoStringArray::setValue ( const VStringVector elements) [inline]

Sets the attribute's value.

Parameters:
elementsthe vector of elements

Definition at line 2134 of file vbento.h.

void VBentoStringArray::appendValue ( const VString element) [inline]

Appends to the attribute's value.

Parameters:
elementthe element to append

Definition at line 2135 of file vbento.h.

void VBentoStringArray::appendValues ( const VStringVector elements) [inline]

Appends to the attribute's value.

Parameters:
elementsthe vector of elements

Definition at line 2136 of file vbento.h.

virtual Vs64 VBentoStringArray::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 2142 of file vbento.h.

virtual void VBentoStringArray::writeDataToBinaryStream ( VBinaryIOStream stream) const [inline, protected, virtual]

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

Parameters:
streamthe stream to write to

Implements VBentoAttribute.

Definition at line 2143 of file vbento.h.

References VBinaryIOStream::writeS32(), and VBinaryIOStream::writeString().


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

Copyright ©1997-2014 Trygve Isaacson. All rights reserved. This documentation was generated with Doxygen.