Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::XmlBindingHandle Class Reference
[XML Binding]

Base class for all generated XmlBinding objects. More...

#include <rwsf/xmlbinding/XmlBindingHandle.h>

Inheritance diagram for rwsf::XmlBindingHandle:

List of all members.

Public Member Functions
	XmlBindingHandle ()
	XmlBindingHandle (const XmlBindingHandle &other)
bool	isMarshalXsiTypeSet () const
void	setMarshalXsiType (bool setValue)
bool	getXsiNil () const
void	setXsiNil (bool XsiNil)
bool	isXsiNilSet () const
void	setXsiNilSet (bool setValue)
std::string	getXsiSchemaLocation () const
void	setXsiSchemaLocation (const std::string &loc)
bool	isXsiSchemaLocationSet () const
void	setXsiSchemaLocationSet (bool setValue)
std::string	getXsiNoNamespaceSchemaLocation () const
void	setXsiNoNamespaceSchemaLocation (const std::string &loc)
bool	isXsiNoNamespaceSchemaLocationSet () const
void	setXsiNoNamespaceSchemaLocationSet (bool setValue)
bool	equals (const rwsf::XmlBindingHandle &second) const
bool	operator== (const rwsf::XmlBindingHandle &second) const
bool	operator!= (const rwsf::XmlBindingHandle &second) const
std::string	xsiType () const
const char *	xsiTypeChar () const
std::string	typeId () const
const char *	typeIdChar () const
bool	isA (const rwsf::XmlBindingHandle &other) const
XmlBindingHandle	clone () const
bool	isHandleValid () const
void	marshal (rwsf::XmlWriter &writer, bool includeChildTypeAttributes, const rwsf::XmlName &, bool includeSelfTypeAttribute, bool nilValue) const

---

Detailed Description

Base class for all generated XmlBinding objects This is a generic interface for generated objects as XML typed data. Generated types are an extension of this interface and typically passed as the generated type. Users should not be creating instances of the rwsf::XmlBindingHandle class directly.

---

Constructor & Destructor Documentation

rwsf::XmlBindingHandle::XmlBindingHandle

(

)

Default constructor.

rwsf::XmlBindingHandle::XmlBindingHandle

(

const XmlBindingHandle &

other

)

Copy constructor. Constructs a new handle from handle other.

---

Member Function Documentation

XmlBindingHandle rwsf::XmlBindingHandle::clone

(

)

const

This method creates a deep copy of the object, meaning that it creates a new instance of the body and a new handle that points to this new body. All generated classes override this method.

bool rwsf::XmlBindingHandle::equals

(

const rwsf::XmlBindingHandle &

second

)

const

Returns false if either handle is not valid. Otherwise proxies the call to the code-generated equality methods for the underlining implementation.

See also:

isHandleValid()

bool rwsf::XmlBindingHandle::getXsiNil

(

)

const

Returns the value of the xsi:nil attribute as an instance of bool. The nil attribute indicates whether the given type is nillable.

std::string rwsf::XmlBindingHandle::getXsiNoNamespaceSchemaLocation

(

)

const

Returns the value of the xsi:noNamespaceSchemaLocation attribute as an instance of std::string.

std::string rwsf::XmlBindingHandle::getXsiSchemaLocation

(

)

const

Returns the value of the xsi:schemaLocation attribute as an instance of std::string.

bool rwsf::XmlBindingHandle::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 rwsf::XmlBindingHandle::isHandleValid

(

)

const

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

bool rwsf::XmlBindingHandle::isMarshalXsiTypeSet

(

)

const

Returns true if the object contains a marshallable value for the xsi:type attribute, otherwise returns false. When this function returns true, the marshal methods marshal the xsi:type attribute.

bool rwsf::XmlBindingHandle::isXsiNilSet

(

)

const

Returns true if the object contains a marshallable value for the xsi:nil attribute, otherwise returns false. When this function returns true, the marshal methods marshal the xsi:nil attribute.

bool rwsf::XmlBindingHandle::isXsiNoNamespaceSchemaLocationSet

(

)

const

Returns true if the object contains a marshallable value for the xsi:noNamespaceSchemaLocation attribute, otherwise returns false. When this function returns true, the marshal methods marshal the xsi:noNamespaceSchemaLocation attribute.

bool rwsf::XmlBindingHandle::isXsiSchemaLocationSet

(

)

const

Returns true if the object contains a marshallable value for the xsi:schemaLocation attribute, otherwise returns false.

void rwsf::XmlBindingHandle::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 HydraExpress XML Binding Development Guide.

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

Reimplemented from rwsf::XmlBindingHandleBase.

bool rwsf::XmlBindingHandle::operator!=

(

const rwsf::XmlBindingHandle &

second

)

const [inline]

Negates the operation call to equals().

bool rwsf::XmlBindingHandle::operator==

(

const rwsf::XmlBindingHandle &

second

)

const [inline]

Proxies the operation to equals().

void rwsf::XmlBindingHandle::setMarshalXsiType

(

bool

setValue

)

Sets whether the object contains a marshallable value for the xsi:type attribute. Note that calling this function with false does not clear the value of the attribute. The xsi:type attribute is marshaled only when the type is a derived type, or this member function flag is explicitly set.

void rwsf::XmlBindingHandle::setXsiNil

(

bool

XsiNil

)

Sets the value of the xsi:nil attribute to the bool provided. After this function is called, the object contains a marshallable value for the xsi:nil attribute.

void rwsf::XmlBindingHandle::setXsiNilSet

(

bool

setValue

)

Sets whether the object contains a marshallable value for the xsi:nil attribute.

Note:

Calling this function with false does not change the value of the internal xsi:nil attribute.

void rwsf::XmlBindingHandle::setXsiNoNamespaceSchemaLocation

(

const std::string &

loc

)

Sets the value of the xsi:noNamespaceSchemaLocation attribute to the std::string provided. After this function is called, the object contains a marshallable value for the xsi:noNamespaceSchemaLocation attribute.

void rwsf::XmlBindingHandle::setXsiNoNamespaceSchemaLocationSet

(

bool

setValue

)

Sets whether the object contains a marshallable value for the xsi:noNamespaceSchemaLocation attribute.

Note:

Calling this function with false does not change the value of the internal xsi:noNamespaceSchemaLocation attribute.

void rwsf::XmlBindingHandle::setXsiSchemaLocation

(

const std::string &

loc

)

Sets the value of the xsi:schemaLocation attribute to the std::string provided. After this function is called, the object contains a marshallable value for the xsi:schemaLocation attribute.

void rwsf::XmlBindingHandle::setXsiSchemaLocationSet

(

bool

setValue

)

Sets whether the object contains a marshallable value for the xsi:schemaLocation attribute.

Note:

Calling this function with false does not change the value of the internal xsi:schemaLocation attribute.

std::string rwsf::XmlBindingHandle::typeId

(

)

const

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

Reimplemented from rwsf::XmlBindingHandleBase.

const char* rwsf::XmlBindingHandle::typeIdChar

(

)

const

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

Reimplemented from rwsf::XmlBindingHandleBase.

std::string rwsf::XmlBindingHandle::xsiType

(

)

const

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

const char* rwsf::XmlBindingHandle::xsiTypeChar

(

)

const

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