MongoDB  2.7.0
Public Types | Public Member Functions | Static Public Attributes | Friends | List of all members
mongo::mutablebson::Element Class Reference

Element represents a BSON value or object in a mutable BSON Document. More...

#include <element.h>

Public Types

typedef uint32_t RepIdx
 

Public Member Functions

Status addSiblingLeft (Element e)
 Add the provided Element to the left of this Element. More...
 
Status addSiblingRight (Element e)
 Add the provided Element to the right of this Element. More...
 
Status remove ()
 'Remove' this Element by detaching it from its parent and siblings. More...
 
Status pushFront (Element e)
 If this Element is empty, add 'e' as the first child. More...
 
Status pushBack (Element e)
 If this Element is empty, add 'e' as the first child. More...
 
Status popFront ()
 Remove the leftmost child Element if it exists, otherwise return an error. More...
 
Status popBack ()
 Remove the rightmost child Element if it exists, otherwise return an error. More...
 
Status rename (const StringData &newName)
 Rename this Element to the provided name. More...
 
Element leftChild () const
 Returns either this Element's left child, or a non-ok Element if no left child exists.
 
Element rightChild () const
 Returns either this Element's right child, or a non-ok Element if no right child exists. More...
 
bool hasChildren () const
 Returns true if this element has children. More...
 
Element leftSibling (size_t distance=1) const
 Returns either this Element's sibling 'distance' elements to the left, or a non-ok Element if no such left sibling exists.
 
Element rightSibling (size_t distance=1) const
 Returns either this Element's sibling 'distance' Elements to the right, or a non-ok Element if no such right sibling exists.
 
Element parent () const
 Returns this Element's parent, or a non-ok Element if this Element has no parent (is a root).
 
Element findNthChild (size_t n) const
 Returns the nth child, if any, of this Element. More...
 
Element operator[] (size_t n) const
 
Element findFirstChildNamed (const StringData &name) const
 Returns the first child, if any, of this Element named 'name'. More...
 
Element operator[] (const StringData &name) const
 
Element findElementNamed (const StringData &name) const
 Returns the first element found named 'name', starting the search at the current Element, and walking right. More...
 
size_t countSiblingsLeft () const
 Returns the number of valid siblings to the left of this Element. More...
 
size_t countSiblingsRight () const
 Returns the number of valid siblings to the right of this Element. More...
 
size_t countChildren () const
 Return the number of children of this Element. More...
 
bool hasValue () const
 Returns true if 'getValue' can return a valid BSONElement from which a value may be extracted. More...
 
bool isNumeric () const
 Returns true if this element is a numeric type (e.g. More...
 
bool isIntegral () const
 Returns true if this element is one of the integral numeric types (e.g. More...
 
const BSONElement getValue () const
 Get the value of this element if available. More...
 
double getValueDouble () const
 Get the value from a double valued Element. More...
 
StringData getValueString () const
 Get the value from a string valued Element. More...
 
BSONObj getValueObject () const
 Get the value from an object valued Element. More...
 
BSONArray getValueArray () const
 Get the value from an object valued Element. More...
 
bool isValueUndefined () const
 Returns true if this Element is the undefined type. More...
 
OID getValueOID () const
 Get the value from an OID valued Element. More...
 
bool getValueBool () const
 Get the value from a bool valued Element. More...
 
Date_t getValueDate () const
 Get the value from a date valued Element. More...
 
bool isValueNull () const
 Returns true if this Element is the null type. More...
 
StringData getValueSymbol () const
 Get the value from a symbol valued Element. More...
 
int32_t getValueInt () const
 Get the value from an int valued Element. More...
 
OpTime getValueTimestamp () const
 Get the value from a timestamp valued Element. More...
 
int64_t getValueLong () const
 Get the value from a long valued Element. More...
 
bool isValueMinKey () const
 Returns true if this Element is the min key type. More...
 
bool isValueMaxKey () const
 Returns true if this Element is the max key type. More...
 
SafeNum getValueSafeNum () const
 Returns the numeric value as a SafeNum.
 
int compareWithElement (const ConstElement &other, bool considerFieldName=true) const
 Compare this Element with Element 'other'. More...
 
int compareWithBSONElement (const BSONElement &other, bool considerFieldName=true) const
 Compare this Element with BSONElement 'other'. More...
 
int compareWithBSONObj (const BSONObj &other, bool considerFieldName=true) const
 Compare this Element, which must be an Object or an Array, with 'other'. More...
 
void writeTo (BSONObjBuilder *builder) const
 Write this Element to the provided object builder. More...
 
void writeArrayTo (BSONArrayBuilder *builder) const
 Write this Element to the provided array builder. More...
 
Status setValueDouble (double value)
 Set the value of this Element to the given double. More...
 
Status setValueString (const StringData &value)
 Set the value of this Element to the given string. More...
 
Status setValueObject (const BSONObj &value)
 Set the value of this Element to the given object. More...
 
Status setValueArray (const BSONObj &value)
 Set the value of this Element to the given object. More...
 
Status setValueBinary (uint32_t len, mongo::BinDataType binType, const void *data)
 Set the value of this Element to the given binary data. More...
 
Status setValueUndefined ()
 Set the value of this Element to Undefined. More...
 
Status setValueOID (OID value)
 Set the value of this Element to the given OID. More...
 
Status setValueBool (bool value)
 Set the value of this Element to the given boolean. More...
 
Status setValueDate (Date_t value)
 Set the value of this Element to the given date. More...
 
Status setValueNull ()
 Set the value of this Element to Null. More...
 
Status setValueRegex (const StringData &re, const StringData &flags)
 Set the value of this Element to the given regex parameters. More...
 
Status setValueDBRef (const StringData &ns, OID oid)
 Set the value of this Element to the given db ref parameters. More...
 
Status setValueCode (const StringData &value)
 Set the value of this Element to the given code data. More...
 
Status setValueSymbol (const StringData &value)
 Set the value of this Element to the given symbol. More...
 
Status setValueCodeWithScope (const StringData &code, const BSONObj &scope)
 Set the value of this Element to the given code and scope data. More...
 
Status setValueInt (int32_t value)
 Set the value of this Element to the given integer. More...
 
Status setValueTimestamp (OpTime value)
 Set the value of this Element to the given timestamp. More...
 
Status setValueLong (int64_t value)
 Set the value of this Element to the given long integer.
 
Status setValueMinKey ()
 Set the value of this Element to MinKey. More...
 
Status setValueMaxKey ()
 Set the value of this Element to MaxKey. More...
 
Status setValueBSONElement (const BSONElement &value)
 Set the value of this element to equal the value of the provided BSONElement 'value'. More...
 
Status setValueSafeNum (const SafeNum value)
 Set the value of this Element to a numeric type appropriate to hold the given SafeNum value.
 
bool ok () const
 Returns true if this Element represents a valid part of the Document. More...
 
DocumentgetDocument ()
 Returns the Document to which this Element belongs. More...
 
const DocumentgetDocument () const
 Returns the Document to which this Element belongs. More...
 
BSONType getType () const
 Returns the BSONType of this Element. More...
 
bool isType (BSONType type) const
 Returns true if this Element is of the specified type.
 
StringData getFieldName () const
 Returns the field name of this Element. More...
 
RepIdx getIdx () const
 Returns the opaque ID for this element. More...
 
Status appendDouble (const StringData &fieldName, double value)
 Append the provided double value as a new field with the provided name. More...
 
Status appendString (const StringData &fieldName, const StringData &value)
 Append the provided string value as a new field with the provided name. More...
 
Status appendObject (const StringData &fieldName, const BSONObj &value)
 Append the provided object as a new field with the provided name. More...
 
Status appendArray (const StringData &fieldName, const BSONObj &value)
 Append the provided array object as a new field with the provided name. More...
 
Status appendBinary (const StringData &fieldName, uint32_t len, mongo::BinDataType binType, const void *data)
 Append the provided binary data as a new field with the provided name. More...
 
Status appendUndefined (const StringData &fieldName)
 Append an undefined value as a new field with the provided name. More...
 
Status appendOID (const StringData &fieldName, mongo::OID value)
 Append the provided OID as a new field with the provided name. More...
 
Status appendBool (const StringData &fieldName, bool value)
 Append the provided bool as a new field with the provided name. More...
 
Status appendDate (const StringData &fieldName, Date_t value)
 Append the provided date as a new field with the provided name. More...
 
Status appendNull (const StringData &fieldName)
 Append a null as a new field with the provided name. More...
 
Status appendRegex (const StringData &fieldName, const StringData &re, const StringData &flags)
 Append the provided regex data as a new field with the provided name. More...
 
Status appendDBRef (const StringData &fieldName, const StringData &ns, mongo::OID oid)
 Append the provided DBRef data as a new field with the provided name. More...
 
Status appendCode (const StringData &fieldName, const StringData &value)
 Append the provided code data as a new field with the iven name. More...
 
Status appendSymbol (const StringData &fieldName, const StringData &value)
 Append the provided symbol data as a new field with the provided name. More...
 
Status appendCodeWithScope (const StringData &fieldName, const StringData &code, const BSONObj &scope)
 Append the provided code and scope data as a new field with the provided name. More...
 
Status appendInt (const StringData &fieldName, int32_t value)
 Append the provided integer as a new field with the provided name. More...
 
Status appendTimestamp (const StringData &fieldName, OpTime value)
 Append the provided timestamp as a new field with the provided name. More...
 
Status appendLong (const StringData &fieldName, int64_t value)
 Append the provided long integer as a new field with the provided name. More...
 
Status appendMinKey (const StringData &fieldName)
 Append a max key as a new field with the provided name. More...
 
Status appendMaxKey (const StringData &fieldName)
 Append a min key as a new field with the provided name. More...
 
Status appendElement (const BSONElement &value)
 Append the given BSONElement. More...
 
Status appendSafeNum (const StringData &fieldName, SafeNum value)
 Append the provided number as field of the appropriate numeric type with the provided name.
 
std::string toString () const
 Convert this element to its JSON representation if ok(), otherwise return !ok() message.
 

Static Public Attributes

static const RepIdx kInvalidRepIdx = RepIdx(-1)
 
static const RepIdx kOpaqueRepIdx = RepIdx(-2)
 
static const RepIdx kMaxRepIdx = RepIdx(-3)
 

Friends

class Document
 
class ConstElement
 
bool operator== (const Element &, const Element &)
 Element comparison support. More...
 

Detailed Description

Element represents a BSON value or object in a mutable BSON Document.

The lifetime of an Element is a subset of the Document to which it belongs. Much like a BSONElement, an Element has a type, a field name, and (usually) a value. An Element may be used to read or modify the value (including changing its type), to navigate to related Elements in the Document tree, or for a number of topological changes to the Document structure. Element also offers the ability to compare its value to that of other Elements, and to serialize its value to a BSONObjBuilder or BSONArrayBuilder.

Elements have reference or iterator like semantics, and are very lightweight. You should not worry about the cost of passing an Element by value, copying an Element, or similar operations. Such operations do not mean that the logical element in the underlying Document is duplicated. Only the reference is duplicated.

The API for Element is broken into several sections:

Member Function Documentation

Status mongo::mutablebson::Element::addSiblingLeft ( Element  e)

Add the provided Element to the left of this Element.

The added Element must be 'ok', and this Element must have a parent.

Status mongo::mutablebson::Element::addSiblingRight ( Element  e)

Add the provided Element to the right of this Element.

The added Element must be 'ok', and this Element must have a parent.

Status mongo::mutablebson::Element::appendArray ( const StringData &  fieldName,
const BSONObj value 
)

Append the provided array object as a new field with the provided name.

The data in value is copied.

Status mongo::mutablebson::Element::appendBinary ( const StringData &  fieldName,
uint32_t  len,
mongo::BinDataType  binType,
const void *  data 
)

Append the provided binary data as a new field with the provided name.

Status mongo::mutablebson::Element::appendBool ( const StringData &  fieldName,
bool  value 
)

Append the provided bool as a new field with the provided name.

Status mongo::mutablebson::Element::appendCode ( const StringData &  fieldName,
const StringData &  value 
)

Append the provided code data as a new field with the iven name.

Status mongo::mutablebson::Element::appendCodeWithScope ( const StringData &  fieldName,
const StringData &  code,
const BSONObj scope 
)

Append the provided code and scope data as a new field with the provided name.

Status mongo::mutablebson::Element::appendDate ( const StringData &  fieldName,
Date_t  value 
)

Append the provided date as a new field with the provided name.

Status mongo::mutablebson::Element::appendDBRef ( const StringData &  fieldName,
const StringData &  ns,
mongo::OID  oid 
)

Append the provided DBRef data as a new field with the provided name.

Status mongo::mutablebson::Element::appendDouble ( const StringData &  fieldName,
double  value 
)

Append the provided double value as a new field with the provided name.

Status mongo::mutablebson::Element::appendElement ( const BSONElement value)

Append the given BSONElement.

The data in 'value' is copied.

Status mongo::mutablebson::Element::appendInt ( const StringData &  fieldName,
int32_t  value 
)

Append the provided integer as a new field with the provided name.

Status mongo::mutablebson::Element::appendLong ( const StringData &  fieldName,
int64_t  value 
)

Append the provided long integer as a new field with the provided name.

Status mongo::mutablebson::Element::appendMaxKey ( const StringData &  fieldName)

Append a min key as a new field with the provided name.

Status mongo::mutablebson::Element::appendMinKey ( const StringData &  fieldName)

Append a max key as a new field with the provided name.

Status mongo::mutablebson::Element::appendNull ( const StringData &  fieldName)

Append a null as a new field with the provided name.

Status mongo::mutablebson::Element::appendObject ( const StringData &  fieldName,
const BSONObj value 
)

Append the provided object as a new field with the provided name.

The data in 'value' is copied.

Status mongo::mutablebson::Element::appendOID ( const StringData &  fieldName,
mongo::OID  value 
)

Append the provided OID as a new field with the provided name.

Status mongo::mutablebson::Element::appendRegex ( const StringData &  fieldName,
const StringData &  re,
const StringData &  flags 
)

Append the provided regex data as a new field with the provided name.

Status mongo::mutablebson::Element::appendString ( const StringData &  fieldName,
const StringData &  value 
)

Append the provided string value as a new field with the provided name.

Status mongo::mutablebson::Element::appendSymbol ( const StringData &  fieldName,
const StringData &  value 
)

Append the provided symbol data as a new field with the provided name.

Status mongo::mutablebson::Element::appendTimestamp ( const StringData &  fieldName,
OpTime  value 
)

Append the provided timestamp as a new field with the provided name.

Status mongo::mutablebson::Element::appendUndefined ( const StringData &  fieldName)

Append an undefined value as a new field with the provided name.

int mongo::mutablebson::Element::compareWithBSONElement ( const BSONElement other,
bool  considerFieldName = true 
) const

Compare this Element with BSONElement 'other'.

You should not call this on the root Element of the Document because the root Element does not have a field name. Use compareWithBSONObj to handle that case.

Returns -1 if this < other according to BSONElement::woCompare Returns 0 if this == other either tautologically, or according to woCompare. Returns 1 if this > other according to BSONElement::woCompare

int mongo::mutablebson::Element::compareWithBSONObj ( const BSONObj other,
bool  considerFieldName = true 
) const

Compare this Element, which must be an Object or an Array, with 'other'.

Returns -1 if this object < other according to BSONElement::woCompare Returns 0 if this object == other either tautologically, or according to woCompare. Returns 1 if this object > other according to BSONElement::woCompare

int mongo::mutablebson::Element::compareWithElement ( const ConstElement other,
bool  considerFieldName = true 
) const

Compare this Element with Element 'other'.

The two Elements may belong to different Documents. You should not call this on the root Element of the Document because the root Element does not have a field name. Use compareWithBSONObj to handle that case.

Returns -1 if this < other according to BSONElement::woCompare Returns 0 if this == other either tautologically, or according to woCompare. Returns 1 if this > other according to BSONElement::woCompare

size_t mongo::mutablebson::Element::countChildren ( ) const

Return the number of children of this Element.

size_t mongo::mutablebson::Element::countSiblingsLeft ( ) const

Returns the number of valid siblings to the left of this Element.

size_t mongo::mutablebson::Element::countSiblingsRight ( ) const

Returns the number of valid siblings to the right of this Element.

Element mongo::mutablebson::Element::findElementNamed ( const StringData &  name) const

Returns the first element found named 'name', starting the search at the current Element, and walking right.

If no such Element exists, a non-ok Element is returned. This is not a constant time operation. This implementation is used in the specialized implementation of findElement<ElementType, FieldNameEquals>.

Element mongo::mutablebson::Element::findFirstChildNamed ( const StringData &  name) const

Returns the first child, if any, of this Element named 'name'.

If no such Element exists, a non-ok Element is returned. This is not a constant time operation. This method is also available as operator[] taking a StringData for convenience.

Element mongo::mutablebson::Element::findNthChild ( size_t  n) const

Returns the nth child, if any, of this Element.

If no such element exists, a non-ok Element is returned. This is not a constant time operation. This method is also available as operator[] taking a size_t for convenience.

Document & mongo::mutablebson::Element::getDocument ( )
inline

Returns the Document to which this Element belongs.

const Document & mongo::mutablebson::Element::getDocument ( ) const
inline

Returns the Document to which this Element belongs.

StringData mongo::mutablebson::Element::getFieldName ( ) const

Returns the field name of this Element.

Note that the value returned here is not stable across mutations, since the storage for fieldNames may be reallocated. If you need a stable version of the fieldName, you must call toString on the returned StringData.

Element::RepIdx mongo::mutablebson::Element::getIdx ( ) const
inline

Returns the opaque ID for this element.

This is unlikely to be useful to a caller and is mostly for testing.

BSONType mongo::mutablebson::Element::getType ( ) const

Returns the BSONType of this Element.

const BSONElement mongo::mutablebson::Element::getValue ( ) const

Get the value of this element if available.

Note that not all elements have a representation as a BSONElement. For elements that do have a representation, this will return it. For elements that do not this method returns an eoo BSONElement. All 'value-ish' Elements will have a BSONElement representation. 'Tree-ish' Elements may or may not have a BSONElement representation. Mutations may cause elements to change whether or not they have a value and may invalidate previously returned values.

Please note that a const BSONElement allows retrieval of a non-const BSONObj. However, the contents of the BSONElement returned here must be treated as const.

BSONArray mongo::mutablebson::Element::getValueArray ( ) const
inline

Get the value from an object valued Element.

Note that this may not always be possible!

bool mongo::mutablebson::Element::getValueBool ( ) const
inline

Get the value from a bool valued Element.

Date_t mongo::mutablebson::Element::getValueDate ( ) const
inline

Get the value from a date valued Element.

double mongo::mutablebson::Element::getValueDouble ( ) const
inline

Get the value from a double valued Element.

int32_t mongo::mutablebson::Element::getValueInt ( ) const
inline

Get the value from an int valued Element.

int64_t mongo::mutablebson::Element::getValueLong ( ) const
inline

Get the value from a long valued Element.

BSONObj mongo::mutablebson::Element::getValueObject ( ) const
inline

Get the value from an object valued Element.

Note that this may not always be possible!

OID mongo::mutablebson::Element::getValueOID ( ) const
inline

Get the value from an OID valued Element.

StringData mongo::mutablebson::Element::getValueString ( ) const
inline

Get the value from a string valued Element.

StringData mongo::mutablebson::Element::getValueSymbol ( ) const
inline

Get the value from a symbol valued Element.

OpTime mongo::mutablebson::Element::getValueTimestamp ( ) const
inline

Get the value from a timestamp valued Element.

bool mongo::mutablebson::Element::hasChildren ( ) const

Returns true if this element has children.

Always returns false if this Element is not an Object or Array.

bool mongo::mutablebson::Element::hasValue ( ) const

Returns true if 'getValue' can return a valid BSONElement from which a value may be extracted.

See the notes for 'getValue' to understand the conditions under which an Element can provide a BSONElement.

bool mongo::mutablebson::Element::isIntegral ( ) const

Returns true if this element is one of the integral numeric types (e.g.

NumberLong or NumberInt).

bool mongo::mutablebson::Element::isNumeric ( ) const

Returns true if this element is a numeric type (e.g.

NumberLong). Currently, the only numeric BSON types are NumberLong, NumberInt, and NumberDouble.

bool mongo::mutablebson::Element::isValueMaxKey ( ) const
inline

Returns true if this Element is the max key type.

bool mongo::mutablebson::Element::isValueMinKey ( ) const
inline

Returns true if this Element is the min key type.

bool mongo::mutablebson::Element::isValueNull ( ) const
inline

Returns true if this Element is the null type.

bool mongo::mutablebson::Element::isValueUndefined ( ) const
inline

Returns true if this Element is the undefined type.

bool mongo::mutablebson::Element::ok ( ) const
inline

Returns true if this Element represents a valid part of the Document.

Status mongo::mutablebson::Element::popBack ( )

Remove the rightmost child Element if it exists, otherwise return an error.

Status mongo::mutablebson::Element::popFront ( )

Remove the leftmost child Element if it exists, otherwise return an error.

Status mongo::mutablebson::Element::pushBack ( Element  e)

If this Element is empty, add 'e' as the first child.

Otherwise, add 'e' as the new right child.

Status mongo::mutablebson::Element::pushFront ( Element  e)

If this Element is empty, add 'e' as the first child.

Otherwise, add 'e' as the new left child.

Status mongo::mutablebson::Element::remove ( )

'Remove' this Element by detaching it from its parent and siblings.

The Element continues to exist and may be manipulated, but cannot be re-obtained by navigating from the root.

Status mongo::mutablebson::Element::rename ( const StringData &  newName)

Rename this Element to the provided name.

Element mongo::mutablebson::Element::rightChild ( ) const

Returns either this Element's right child, or a non-ok Element if no right child exists.

Note that obtaining the right child may require realizing all immediate child nodes of a document that is being consumed lazily.

Status mongo::mutablebson::Element::setValueArray ( const BSONObj value)

Set the value of this Element to the given object.

The data in 'value' is copied.

Status mongo::mutablebson::Element::setValueBinary ( uint32_t  len,
mongo::BinDataType  binType,
const void *  data 
)

Set the value of this Element to the given binary data.

Status mongo::mutablebson::Element::setValueBool ( bool  value)

Set the value of this Element to the given boolean.

Status mongo::mutablebson::Element::setValueBSONElement ( const BSONElement value)

Set the value of this element to equal the value of the provided BSONElement 'value'.

The name of this Element is not modified.

The contents of value are copied.

Status mongo::mutablebson::Element::setValueCode ( const StringData &  value)

Set the value of this Element to the given code data.

Status mongo::mutablebson::Element::setValueCodeWithScope ( const StringData &  code,
const BSONObj scope 
)

Set the value of this Element to the given code and scope data.

Status mongo::mutablebson::Element::setValueDate ( Date_t  value)

Set the value of this Element to the given date.

Status mongo::mutablebson::Element::setValueDBRef ( const StringData &  ns,
OID  oid 
)

Set the value of this Element to the given db ref parameters.

Status mongo::mutablebson::Element::setValueDouble ( double  value)

Set the value of this Element to the given double.

Status mongo::mutablebson::Element::setValueInt ( int32_t  value)

Set the value of this Element to the given integer.

Status mongo::mutablebson::Element::setValueMaxKey ( )

Set the value of this Element to MaxKey.

Status mongo::mutablebson::Element::setValueMinKey ( )

Set the value of this Element to MinKey.

Status mongo::mutablebson::Element::setValueNull ( )

Set the value of this Element to Null.

Status mongo::mutablebson::Element::setValueObject ( const BSONObj value)

Set the value of this Element to the given object.

The data in 'value' is copied.

Status mongo::mutablebson::Element::setValueOID ( OID  value)

Set the value of this Element to the given OID.

Status mongo::mutablebson::Element::setValueRegex ( const StringData &  re,
const StringData &  flags 
)

Set the value of this Element to the given regex parameters.

Status mongo::mutablebson::Element::setValueString ( const StringData &  value)

Set the value of this Element to the given string.

Status mongo::mutablebson::Element::setValueSymbol ( const StringData &  value)

Set the value of this Element to the given symbol.

Status mongo::mutablebson::Element::setValueTimestamp ( OpTime  value)

Set the value of this Element to the given timestamp.

Status mongo::mutablebson::Element::setValueUndefined ( )

Set the value of this Element to Undefined.

void mongo::mutablebson::Element::writeArrayTo ( BSONArrayBuilder builder) const

Write this Element to the provided array builder.

This Element must be of type mongo::Array.

void mongo::mutablebson::Element::writeTo ( BSONObjBuilder builder) const

Write this Element to the provided object builder.

Friends And Related Function Documentation

bool operator== ( const Element ,
const Element  
)
friend

Element comparison support.

Comparison is like STL iterator comparision: equal Elements refer to the same underlying data. The equality does not mean that the underlying values are equivalent. Use the Element::compareWith methods to compare the represented data.Returns true if l and r refer to the same data, false otherwise.


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