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

VBentoBool is a VBentoAttribute that holds a bool value. More...

#include <vbento.h>

Inheritance diagram for VBentoBool:
VBentoAttribute

List of all members.

Public Member Functions

 VBentoBool ()
 Constructs with uninitialized name and value.
 VBentoBool (VBinaryIOStream &stream)
 Constructs by reading from stream.
 VBentoBool (const VString &name, bool b)
 Constructs from supplied name and value.
virtual ~VBentoBool ()
 Destructor.
virtual VBentoAttributeclone () const
VBentoBooloperator= (const VBentoBool &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.
bool getValue () const
 Returns the attribute's value.
void setValue (bool b)
 Sets 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

VBentoBool is a VBentoAttribute that holds a bool value.

Definition at line 1130 of file vbento.h.


Constructor & Destructor Documentation

VBentoBool::VBentoBool ( VBinaryIOStream stream) [inline]

Constructs by reading from stream.

Parameters:
streamthe stream to read

Definition at line 1136 of file vbento.h.


Member Function Documentation

bool VBentoBool::getValue ( ) const [inline]

Returns the attribute's value.

Returns:
the value

Definition at line 1147 of file vbento.h.

void VBentoBool::setValue ( bool  b) [inline]

Sets the attribute's value.

Parameters:
bthe attribute value

Definition at line 1148 of file vbento.h.

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

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

References VBinaryIOStream::writeBool().


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

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