HydraExpress™ C++ API Reference Guide

 
Loading...
Searching...
No Matches
rwsf::XmlBindingHandleBase Class Reference

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

#include <rwsf/xmlbinding/XmlBindingHandleBase.h>

Inheritance diagram for rwsf::XmlBindingHandleBase:
rwsf::HandleBase rwsf::XmlBindingHandle rwsf::ArrayHandle< T >

Public Member Functions

 XmlBindingHandleBase (const XmlBindingHandleBase &other)
bool isSimple () const
void marshal (rwsf::XmlWriter &writer, bool includeChildTypeAttributes, const rwsf::XmlName &, bool includeSelfTypeAttribute, bool nilValue) const
std::string typeId () const
const char * typeIdChar () const
rwsf::XmlName xmlType () const
Public Member Functions inherited from rwsf::HandleBase
bool isValid (void) const
bool operator!= (const HandleBase &second) const
bool operator== (const HandleBase &second) const

Additional Inherited Members

Protected Member Functions inherited from rwsf::HandleBase
 HandleBase (BodyBase *body)
 HandleBase (const HandleBase &second)
 HandleBase (StaticCtor)
 HandleBase (void)
virtual ~HandleBase (void)
BodyBase & body (void) const
HandleBaseoperator= (const HandleBase &second)

Detailed Description

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

Constructor & Destructor Documentation

◆ XmlBindingHandleBase()

rwsf::XmlBindingHandleBase::XmlBindingHandleBase ( const XmlBindingHandleBase & other)

Copy constructor. Constructs a new handle from handle other.

Member Function Documentation

◆ isSimple()

bool rwsf::XmlBindingHandleBase::isSimple ( ) const

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

◆ marshal()

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.

◆ typeId()

std::string rwsf::XmlBindingHandleBase::typeId ( ) const

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

◆ typeIdChar()

const char * rwsf::XmlBindingHandleBase::typeIdChar ( ) const

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

◆ xmlType()

rwsf::XmlName rwsf::XmlBindingHandleBase::xmlType ( ) const

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

Copyright © 2026 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.