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

VBentoUnknownValue is a VBentoAttribute that holds a value that is read from an input stream but whose type is unknown; the object uses a VMemoryStream to hold the binary data of unknown type. More...

#include <vbento.h>

Inheritance diagram for VBentoUnknownValue:
VBentoAttribute

List of all members.

Public Member Functions

 VBentoUnknownValue ()
 Constructs with uninitialized name and empty stream.
 VBentoUnknownValue (VBinaryIOStream &stream, Vs64 dataLength, const VString &dataType)
 Constructs by reading from stream.
virtual ~VBentoUnknownValue ()
 Destructor.
virtual VBentoAttributeclone () const
VBentoAttributeoperator= (const VBentoAttribute &)
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 VMemoryStreamgetValue () const
 Returns the attribute's value.

Static Public Member Functions

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.

Detailed Description

VBentoUnknownValue is a VBentoAttribute that holds a value that is read from an input stream but whose type is unknown; the object uses a VMemoryStream to hold the binary data of unknown type.

The data's length is known. Its data type name is known but the VBento code does not know how to map that data type name to a C++ class, and must therefore use a VBentoUnknownValue.

Definition at line 1899 of file vbento.h.


Constructor & Destructor Documentation

VBentoUnknownValue::VBentoUnknownValue ( VBinaryIOStream stream,
Vs64  dataLength,
const VString dataType 
)

Constructs by reading from stream.

Parameters:
streamthe stream to read
dataLengththe length of stream data to read
dataTypethe original data type value

Definition at line 2637 of file vbento.cpp.

References VStream::streamCopy().


Member Function Documentation

const VMemoryStream& VBentoUnknownValue::getValue ( ) const [inline]

Returns the attribute's value.

Returns:
a reference to the unknown-typed data stream

Definition at line 1915 of file vbento.h.

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

References VMemoryStream::getEOFOffset().

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

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

Parameters:
streamthe stream to write to

Implements VBentoAttribute.

Definition at line 2645 of file vbento.cpp.

References VMemoryStream::getEOFOffset(), VMemoryStream::getIOOffset(), VIOStream::seek(), VIOStream::seek0(), and VStream::streamCopy().


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.