Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::XmlBindingHandleBase Class Reference
[XML Binding]

Base handle for all generated type objects. More...

#include <rwsf/xmlbinding/XmlBindingHandleBase.h>

Inheritance diagram for rwsf::XmlBindingHandleBase:

List of all members.

Public Member Functions
	XmlBindingHandleBase (const XmlBindingHandleBase &other)
bool	isSimple () const
std::string	typeId () const
const char *	typeIdChar () const
rwsf::XmlName	xmlType () const
void	marshal (rwsf::XmlWriter &writer, bool includeChildTypeAttributes, const rwsf::XmlName &, bool includeSelfTypeAttribute, bool nilValue) const

---

Detailed Description

Class rwsf::XmlBindingHandleBase is the base for handling all generated type objects.

---

Constructor & Destructor Documentation

rwsf::XmlBindingHandleBase::XmlBindingHandleBase

(

const XmlBindingHandleBase &

other

)

Copy constructor. Constructs a new handle from handle other.

---

Member Function Documentation

bool rwsf::XmlBindingHandleBase::isSimple

(

)

const

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

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

Creates an XML element from this object, using writer as the destination for the XML. When includeChildTypeAttributes is true, the element includes xsi: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 marshaling of schema elements with a nillable=true attribute. For information on how to control nillable elements in your code, see Section "nillable Elements," in the XML Binding Development Guide.

Note:

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.

Reimplemented in rwsf::XmlBindingHandle.

std::string rwsf::XmlBindingHandleBase::typeId

(

)

const

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

Reimplemented in rwsf::XmlBindingHandle.

const char* rwsf::XmlBindingHandleBase::typeIdChar

(

)

const

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

Reimplemented in rwsf::XmlBindingHandle.

rwsf::XmlName rwsf::XmlBindingHandleBase::xmlType

(

)

const

Returns the name of the object as an rwsf::XmlName. All generated classes override this function.