rwsf::XmlBindingHandle

rwsf::XmlBindingHandlerwsf::XmlBindingHandleBase

• Local Index
• Header File
• Description
• Public Constructors
• Public Member Functions

Members

clone() isA() isHandleValid()

isMarshalXsiTypeSet() isValid() marshal()

typeId() typeIdChar() XmlBindingHandle()

xsiType() xsiTypeChar()

#include rwsf/xmlbinding/XmlBindingHandle.h

The methods in this class call the corresponding methods in rwsf::XmlBindingBody. Please see that description for details.

rwsf::XmlBindingHandle implements the handle/body idiom in conjunction with rwsf::XmlBindingBody. An instance of this class is a handle to a private, reference-counted body. When a handle is copy-constructed, the new handle attaches to the same body as the original. When one handle is assigned to another handle, the handle on the left side detaches from its current body and attaches to the body pointed to by the handle on the right side. Logical operators return truth values based on whether the handles being compared point to the same body instance.

Note

Handle methods that just call the corresponding method on the body are described only in the body class. For instance, if the handle class includes a method invoke() that calls the body's corresponding method doInvoke(), that method is documented only in the body class.

XmlBindingHandle();

Default constructor.

XmlBindingHandle(const XmlBindingHandle & other);

Copy constructor. Constructs a new handle from handle other.

XmlBindingHandle(rwsf::XmlBindingBody * body);

Constructs a new handle attached to the body body.

XmlBindingHandle
clone() const;

Provides a deep copy when desired. Calls the body's doClone() method.

bool
isA(const rwsf::XmlBindingHandle & other) const;

Returns true if the xsi:type of this handle's associated body is either the same as, or derived from, the xsi:type type passed to the convenience method as other.xsiType(); otherwise returns false.

bool
isHandleValid() const;

Returns false if this handle points to a null body. Throws rwsf::ExternalException.

bool
isMarshalXsiTypeSet() const;

Returns the type ID of the object as a string. All generated classes override this function.

bool
isValid() const;

Reimplements method in rwsf::HandleBase

Base class documentation:

Returns true if this handle points to a valid body instance, and false otherwise.

void
marshal(rwsf::XmlWriter & writer,
    bool includeChildTypeAttributes,
    const rwsf::XmlName &,
    bool includeSelfTypeAttribute,
    bool nilValue) const;

Reimplements method in rwsf::XmlBindingHandleBase

Base class documentation:

Virtual void. In the generated classes, creates an XML element from this object, using writer as the destination for the XML. When includeChildTypeAttributes is true, the element includes type attributes on each contained element. The elementName argument sets the name of the XML element. When includeSelfTypeAttribute is true, the element itself contains a type attribute.

The nilValue parameter controls the marshalling of schema elements with a nillable=true attribute. The nilValue parameter is set by the generated code when calling this method to create correct marshalling behavior. For information on how to control nillable elements in your code, see the Section 8.5.6, "nillable Elements," in the HydraExpress XML Binding Development Guide.

Note that this method does not marshal the XML element directly. Rather, it calls a generated external marshaling class, passing all of its input parameters and a reference to this.

Throws a rwsf::Exception message "marshal called on an instance of XmlBindingBody."

std::string
typeId() const;

Reimplements method in rwsf::XmlBindingHandleBase

Base class documentation:

Returns the type ID of the object as a string. All generated classes override this function.

const char *
typeIdChar() const;

Reimplements method in rwsf::XmlBindingHandleBase

Base class documentation:

Returns the type ID of the object as a character array. All erated classes override this function.

Implementation documentation:

Returns the type ID of the object as a character array. All erated classes override this function.

std::string
xsiType() const;

Returns the xsi:type of the object as a string. All generated classes override this function.

const char *
xsiTypeChar() const;

Returns the xsi:type of the object as a character array. All generated classes override this function.

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.