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

VBentoPolygon is a VBentoAttribute that holds a VIPolygon value. More...

#include <vbento.h>

Inheritance diagram for VBentoIPolygon:
VBentoAttribute

List of all members.

Public Member Functions

 VBentoIPolygon ()
 Constructs with uninitialized name and the current time as value.
 VBentoIPolygon (VBinaryIOStream &stream)
 Constructs by reading from stream.
 VBentoIPolygon (const VString &name, const VIPolygon &s)
 Constructs from supplied name and value.
virtual ~VBentoIPolygon ()
 Destructor.
virtual VBentoAttributeclone () const
VBentoIPolygonoperator= (const VBentoIPolygon &rhs)
virtual bool xmlAppearsAsArray () const
 True if XML output requires this attribute to use a separate child tag for its array elements; implies override of writeToXMLTextStream.
virtual void writeToXMLTextStream (VTextIOStream &stream, bool lineWrap, int indentDepth) const
 Writes the attribute to a text stream as XML.
virtual void getValueAsXMLText (VString &) 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 VIPolygongetValue () const
 Returns the attribute's value.
void setValue (const VIPolygon &i)
 Sets the attribute's value.

Static Public Member Functions

static const VStringDATA_TYPE_ID ()
 The data type name / class ID string.
static void readPolygonFromBentoTextString (const VString &s, VIPolygon &p)

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

VBentoPolygon is a VBentoAttribute that holds a VIPolygon value.

Definition at line 1784 of file vbento.h.


Constructor & Destructor Documentation

VBentoIPolygon::VBentoIPolygon ( VBinaryIOStream stream) [inline]

Constructs by reading from stream.

Parameters:
streamthe stream to read

Definition at line 1790 of file vbento.h.


Member Function Documentation

void VBentoIPolygon::writeToXMLTextStream ( VTextIOStream stream,
bool  lineWrap,
int  indentDepth 
) const [virtual]

Writes the attribute to a text stream as XML.

Parameters:
streamthe stream to write to
lineWraptrue if each bento node should start on its own indented line
indentDepthif lineWrap is true, the indent level depth of this node

Reimplemented from VBentoAttribute.

Definition at line 1004 of file vbento.cpp.

References VBentoAttribute::getName().

const VIPolygon& VBentoIPolygon::getValue ( ) const [inline]

Returns the attribute's value.

Returns:
a reference to the value object

Definition at line 1806 of file vbento.h.

void VBentoIPolygon::setValue ( const VIPolygon i) [inline]

Sets the attribute's value.

Parameters:
ithe attribute value

Definition at line 1807 of file vbento.h.

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

virtual void VBentoIPolygon::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 1812 of file vbento.h.


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.