rwsf::XmlBindingHandleBase

rwsf::XmlBindingHandleBaserwsf::HandleBase

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

Members

body() cloneData()

isSimple() marshal()

typeId() typeIdChar()

XmlBindingHandleBase() xmlType()

#include rwsf/xmlbinding/XmlBindingHandleBase.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.

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.

XmlBindingHandleBase();

Default constructor.

XmlBindingHandleBase(const XmlBindingHandleBase & other);

Copy constructor. Constructs a new handle from handle other.

XmlBindingHandleBase(rwsf::XmlBindingBodyBase * body);

Constructs a new handle attached to the body body.

rwsf::XmlBindingHandleBase
cloneData() const;

This method provides an interface function to clone the body.

bool
isSimple() const;

Returns true if the object represents a simple type. All derived classes override this function.

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

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;

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

const char *
typeIdChar() const;

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

rwsf::XmlName
xmlType() const;

Returns the Xml:name of the object as a string. All generated classes override this function.

const rwsf::XmlBindingBodyBase &
body() const;

Reimplements method in rwsf::HandleBase

Base class documentation:

Gets a reference for the body instance, if any; otherwise, throws an rwsf::Exception exception.

© 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.