C++ Sample : Simple Choice
In This Topic
C++ Sample : Simple Choice
| Schema Summary This sample shows an element containing a choice of simple elements. One and only one child element may be provided. Schema Details The element AccountAdminRequest contains 3 child elements, CreateAccount, DeleteAccount and ChangeAccountPassword. Only one of these elements may be specified at a time, and one MUST be specified. All 3 of the child elements are represented in the generated code as classes (as opposed to primitive), despite being based on primitive types. This is because they all contain child attributes of there own. Elements with child elements or attributes must be represented as classes in the generated code. Sample Description The sample demonstrates the element with ChangeAccountPassword element defined. |
Sample XML File
  Sample1.xml |
<?xml version="1.0" encoding="UTF-8"?>
<AccountAdminRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="..\Schema\SimpleChoice.xsd">
<CreateAccount Username="Guest" Password="Password"/>
</AccountAdminRequest>
|
Sample Code
| Read Sample |
|
#include "..\..\..\Samples\SimpleChoice\Generated\CPP\SourceCodeCPP\SimpleChoiceLib.h" #include "..\..\..\Samples\SimpleChoice\Generated\CPP\SourceCodeCPP\SimpleChoiceLib\AccountAdminRequest.h"
std::string FilePath = SAMPLE_PATH + "SimpleChoice\\Samples\\Sample1.xml";
SampleRead(FilePath);
void SampleRead(std::string FilePath)
{
// Create the request object
SimpleChoiceLib::CAccountAdminRequestPtr req = SimpleChoiceLib::CAccountAdminRequest::CreateInstance();
// Load data into the object from a file
req->FromXmlFile(FilePath.c_str());
// Because req is a choice only one of the elments in it may be valid
if (req->GetChoiceSelectedElement() == "ChangeAccountPassword")
{
// We will now delete the account
printf("Change the password for the account %s, from %s to %s\n", req->GetChangeAccountPassword()->GetUsername().c_str(), req->GetChangeAccountPassword()->GetOldPassword().c_str(), req->GetChangeAccountPassword()->GetNewPassword().c_str());
// ...
}
else if (req->GetChoiceSelectedElement() == "CreateAccount")
{
// We will now create a new account...
printf("Create New account %s with a password %s\n", req->GetCreateAccount()->GetUsername().c_str(), req->GetCreateAccount()->GetPassword().c_str());
// ...
}
else if (req->GetChoiceSelectedElement() == "DeleteAccount")
{
// We will now delete the account
printf("Delete the account %s\n", req->GetDeleteAccount()->GetUsername().c_str());
// ...
}
else
{
// An unknown element was selected...This should be coded for as
// additional options may one day be added to the schema.
printf("Unknown selected element %s\n", req->GetChoiceSelectedElement().c_str());
}
}
|
| Write Sample |
|
#include "..\..\..\Samples\SimpleChoice\Generated\CPP\SourceCodeCPP\SimpleChoiceLib.h" #include "..\..\..\Samples\SimpleChoice\Generated\CPP\SourceCodeCPP\SimpleChoiceLib\AccountAdminRequest.h"
// Create DVD object
SimpleChoiceLib::CAccountAdminRequestPtr req = SimpleChoiceLib::CAccountAdminRequest::CreateInstance();
// Now we can form a create account request
SimpleChoiceLib::CCreateAccountPtr naReq = SimpleChoiceLib::CCreateAccount::CreateInstance();
naReq->SetUsername("Guest");
naReq->SetPassword("Password");
req->SetCreateAccount(naReq);
// Now we can look at the XML from this object
printf(req->ToXml().c_str());
|
XSD Source Files
| SimpleChoice.xsd |
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:element name="AccountAdminRequest">
<xs:complexType>
<xs:choice>
<xs:element name="CreateAccount">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="Username" type="xs:string" use="required"/>
<xs:attribute name="Password" type="xs:string" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="DeleteAccount">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="Username" type="xs:string" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="ChangeAccountPassword">
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:date">
<xs:attribute name="Username" type="xs:string" use="required"/>
<xs:attribute name="OldPassword" type="xs:string" use="required"/>
<xs:attribute name="NewPassword" type="xs:string" use="required"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
|
| Schema Diagrams |
 |
Generated Files
| AccountAdminRequest.h |
/**********************************************************************************************
* Copyright (c) 2001-2023 Liquid Technologies Limited. All rights reserved.
* See www.liquid-technologies.com for product details.
*
* Please see products End User License Agreement for distribution permissions.
*
* WARNING: THIS FILE IS GENERATED
* Changes made outside of ##HAND_CODED_BLOCK_START blocks will be overwritten
*
* Generation : by Liquid XML Data Binder 19.0.14.11049
* Using Schema: SimpleChoice.xsd
**********************************************************************************************/
#ifndef _SimpleChoiceLib_SimpleChoiceLib_CAccountAdminRequest_h
#define _SimpleChoiceLib_SimpleChoiceLib_CAccountAdminRequest_h
// Include Base classes
#include "../SimpleChoiceLib/CreateAccount.h"
#include "../SimpleChoiceLib/DeleteAccount.h"
#include "../SimpleChoiceLib/ChangeAccountPassword.h"
// ##HAND_CODED_BLOCK_START ID="Additional Includes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Includes here...
// ##HAND_CODED_BLOCK_END ID="Additional Includes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Forward declarations - done like this to keep the intellisense happy
namespace SimpleChoiceLib { class CClassFactory; };
namespace SimpleChoiceLib
{
/*
* CAccountAdminRequest
*
* This class wraps the element AccountAdminRequest in the schema
*/
class SimpleChoiceLib_DLL CAccountAdminRequest : public CInstanceMonitor
, public virtual SimpleChoiceLib::CXmlCommonBase
// ##HAND_CODED_BLOCK_START ID="Additional Base Classes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional base classes here...
// ##HAND_CODED_BLOCK_END ID="Additional Base Classes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
{
public:
static SimpleChoiceLib::CAccountAdminRequestPtr CreateInstance(LPCTSTR lpctElementName=_T("AccountAdminRequest"));
protected:
CAccountAdminRequest(LPCTSTR lpctElementName=_T("AccountAdminRequest"));
virtual ~CAccountAdminRequest();
friend class SimpleChoiceLib::CClassFactory;
virtual void Init();
virtual void AccessProperty(int iPropertyIndex, bool read, LtXmlLib20::LtVariant& rValue);
virtual LtXmlLib20Data::CParentElementInfo* GetClassInfo() const;
virtual LtXmlLib20Data::CElementInfo** GetClassElementInfo() const;
virtual LtXmlLib20Data::CAttributeInfo** GetClassAttributeInfo() const;
static void CleanMetaData();
void Cleanup();
virtual void OnEvent(LtXmlLib20::CXmlObjectBase* pMsgSource, LtXmlLib20::IEventSink::MsgType eMsgType, void* pData);
void ClearChoice(LPCTSTR selectedElement);
public:
SimpleChoiceLib::CCreateAccountPtr GetCreateAccount() const;
void SetCreateAccount(SimpleChoiceLib::CCreateAccount* value);
protected:
SimpleChoiceLib::CCreateAccountPtr m_CreateAccount;
public:
SimpleChoiceLib::CDeleteAccountPtr GetDeleteAccount() const;
void SetDeleteAccount(SimpleChoiceLib::CDeleteAccount* value);
protected:
SimpleChoiceLib::CDeleteAccountPtr m_DeleteAccount;
public:
SimpleChoiceLib::CChangeAccountPasswordPtr GetChangeAccountPassword() const;
void SetChangeAccountPassword(SimpleChoiceLib::CChangeAccountPassword* value);
protected:
SimpleChoiceLib::CChangeAccountPasswordPtr m_ChangeAccountPassword;
public:
std::tstring GetChoiceSelectedElement() const;
protected:
std::tstring m_validElement;
public:
// Performs a 'deep copy' of all the data in the class (and its children)
virtual SimpleChoiceLib::CAccountAdminRequestPtr Clone() const;
virtual std::tstring GetTargetNamespace() const;
virtual std::tstring GetNamespace() const;
virtual LtXmlLib20::CXmlObjectBase* GetBase();
// Internal data for XML serialization
private:
static LtXmlLib20Data::CParentElementInfo* ms_pParentElementInfo;
static LtXmlLib20Data::CElementInfo** ms_ppElementInfo;
static LtXmlLib20Data::CAttributeInfo** ms_ppAttributeInfo;
// ##HAND_CODED_BLOCK_START ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Methods here...
// ##HAND_CODED_BLOCK_END ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
};
}; // end namespace (SimpleChoiceLib)
#endif // _SimpleChoiceLib_CAccountAdminRequest_h
|
| AccountAdminRequest.cpp |
/**********************************************************************************************
* Copyright (c) 2001-2023 Liquid Technologies Limited. All rights reserved.
* See www.liquid-technologies.com for product details.
*
* Please see products End User License Agreement for distribution permissions.
*
* WARNING: THIS FILE IS GENERATED
* Changes made outside of ##HAND_CODED_BLOCK_START blocks will be overwritten
*
* Generation : by Liquid XML Data Binder 19.0.14.11049
* Using Schema: SimpleChoice.xsd
**********************************************************************************************/
#include "StdAfx.h"
#pragma warning (push)
#pragma warning (disable:4251) // template export warning
#pragma warning (disable:4786) // long debug names
#include "../SimpleChoiceLib.h"
#include "../SimpleChoiceLib/AccountAdminRequest.h"
// ##HAND_CODED_BLOCK_START ID="Additional Includes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Includes here...
// ##HAND_CODED_BLOCK_END ID="Additional Includes"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Name : AccountAdminRequest
// Long Name : AccountAdminRequest
// Element Name : AccountAdminRequest
// Class Namespace : SimpleChoiceLib
// Namespace Alias :
// Schema Namespace :
// Mapped Class Name : CAccountAdminRequest
// Mapped Class Full Name : SimpleChoiceLib::CAccountAdminRequest
// Mapped Class File Name : CAccountAdminRequest
// IsAbstract : False
// IsElement : True
// IsComplexType : False
namespace SimpleChoiceLib
{
LtXmlLib20Data::CParentElementInfo* CAccountAdminRequest::ms_pParentElementInfo = NULL;
LtXmlLib20Data::CAttributeInfo** CAccountAdminRequest::ms_ppAttributeInfo = NULL;
LtXmlLib20Data::CElementInfo** CAccountAdminRequest::ms_ppElementInfo = NULL;
CAccountAdminRequestPtr CAccountAdminRequest::CreateInstance(LPCTSTR lpctElementName/*=_T("AccountAdminRequest")*/)
{
return new SimpleChoiceLib::CAccountAdminRequest(lpctElementName);
}
/*
* Constructor for CAccountAdminRequest
*
* The class is created with all the mandatory fields populated with the
* default data.
* All Collection objects are created.
* However any 1-n relationships (these are represented as collections) are
* empty. To comply with the schema these must be populated before the xml
* obtained from ToXml is valid against the schema SimpleChoice.xsd
*/
CAccountAdminRequest::CAccountAdminRequest(LPCTSTR lpctElementName/*=_T("AccountAdminRequest")*/)
: CInstanceMonitor(_T("CAccountAdminRequest"))
{
m_elementName = lpctElementName;
Init();
}
CAccountAdminRequest::~CAccountAdminRequest()
{
Cleanup();
}
void CAccountAdminRequest::Cleanup()
{
// unregister for any events we have asked for
// cos there'll be no one left to hear soon
}
void CAccountAdminRequest::OnEvent(LtXmlLib20::CXmlObjectBase* pMsgSource, LtXmlLib20::IEventSink::MsgType eMsgType, void* pData)
{
if (eMsgType == LtXmlLib20::IEventSink::MT_CollectionChangeEvent)
{
}
}
/*
* Initializes the class
*
* The Creates all the mandatory fields (populated with the default data)
* All Collection object are created.
* However any 1-n relationships (these are represented as collections) are
* empty. To comply with the schema these must be populated before the xml
* obtained from ToXml is valid against the schema SimpleChoice.xsd.
*/
void CAccountAdminRequest::Init()
{
Cleanup();
this->m_CreateAccount = NULL;
this->m_DeleteAccount = NULL;
this->m_ChangeAccountPassword = NULL;
m_validElement = _T("");
// ##HAND_CODED_BLOCK_START ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Init Settings...
// ##HAND_CODED_BLOCK_END ID="Additional Inits"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
}
void CAccountAdminRequest::ClearChoice(LPCTSTR lpctSelectedElement)
{
this->m_CreateAccount = NULL;
this->m_DeleteAccount = NULL;
this->m_ChangeAccountPassword = NULL;
m_validElement = lpctSelectedElement;
}
void CAccountAdminRequest::AccessProperty(int iPropertyIndex, bool bRead, LtXmlLib20::LtVariant& rValue)
{
if (bRead)
{
switch(iPropertyIndex)
{
case 1:
rValue.SetXmlObject(GetCreateAccount().Ptr());
break;
case 2:
rValue.SetXmlObject(GetDeleteAccount().Ptr());
break;
case 3:
rValue.SetXmlObject(GetChangeAccountPassword().Ptr());
break;
default:
throw LtXmlLib20::CLtException(_T("Unknown Property Index"));
};
}
else
{
switch(iPropertyIndex)
{
case 1:
SetCreateAccount(dynamic_cast<SimpleChoiceLib::CCreateAccount*>(rValue.GetXmlObject().Ptr()));
break;
case 2:
SetDeleteAccount(dynamic_cast<SimpleChoiceLib::CDeleteAccount*>(rValue.GetXmlObject().Ptr()));
break;
case 3:
SetChangeAccountPassword(dynamic_cast<SimpleChoiceLib::CChangeAccountPassword*>(rValue.GetXmlObject().Ptr()));
break;
default:
throw LtXmlLib20::CLtException(_T("Unknown Property Index"));
}
}
}
/*
* Represents an optional Element in the XML document
*
*
* This property is represented as an Element in the XML.
* It is optional, initially it is NULL.
* Only one Element within this class may be set at a time, setting this property when another element is already set will raise an exception. setting this property to NULL will allow another element to be selected
*/
SimpleChoiceLib::CCreateAccountPtr CAccountAdminRequest::GetCreateAccount() const
{
return this->m_CreateAccount;
}
void CAccountAdminRequest::SetCreateAccount(SimpleChoiceLib::CCreateAccount* value)
{
// Ensure only on element is populated at a time
ClearChoice(value == NULL?_T(""):_T("CreateAccount"));
if (value == NULL)
this->m_CreateAccount = NULL;
else
{
SetElementName(value, _T("CreateAccount"));
this->m_CreateAccount = value;
}
}
/*
* Represents an optional Element in the XML document
*
*
* This property is represented as an Element in the XML.
* It is optional, initially it is NULL.
* Only one Element within this class may be set at a time, setting this property when another element is already set will raise an exception. setting this property to NULL will allow another element to be selected
*/
SimpleChoiceLib::CDeleteAccountPtr CAccountAdminRequest::GetDeleteAccount() const
{
return this->m_DeleteAccount;
}
void CAccountAdminRequest::SetDeleteAccount(SimpleChoiceLib::CDeleteAccount* value)
{
// Ensure only on element is populated at a time
ClearChoice(value == NULL?_T(""):_T("DeleteAccount"));
if (value == NULL)
this->m_DeleteAccount = NULL;
else
{
SetElementName(value, _T("DeleteAccount"));
this->m_DeleteAccount = value;
}
}
/*
* Represents an optional Element in the XML document
*
*
* This property is represented as an Element in the XML.
* It is optional, initially it is NULL.
* Only one Element within this class may be set at a time, setting this property when another element is already set will raise an exception. setting this property to NULL will allow another element to be selected
*/
SimpleChoiceLib::CChangeAccountPasswordPtr CAccountAdminRequest::GetChangeAccountPassword() const
{
return this->m_ChangeAccountPassword;
}
void CAccountAdminRequest::SetChangeAccountPassword(SimpleChoiceLib::CChangeAccountPassword* value)
{
// Ensure only on element is populated at a time
ClearChoice(value == NULL?_T(""):_T("ChangeAccountPassword"));
if (value == NULL)
this->m_ChangeAccountPassword = NULL;
else
{
SetElementName(value, _T("ChangeAccountPassword"));
this->m_ChangeAccountPassword = value;
}
}
std::tstring CAccountAdminRequest::GetChoiceSelectedElement() const
{
return m_validElement;
}
/*
* Allows the class to be copied
* Performs a 'deep copy' of all the data in the class (and its children)
*/
SimpleChoiceLib::CAccountAdminRequestPtr CAccountAdminRequest::Clone() const
{
SimpleChoiceLib::CAccountAdminRequestPtr newObject = CreateInstance(m_elementName.c_str());
int index = 0;
newObject->m_CreateAccount = NULL;
if (m_CreateAccount != NULL)
newObject->m_CreateAccount = dynamic_cast<SimpleChoiceLib::CCreateAccount*>(m_CreateAccount->Clone().Ptr());
newObject->m_DeleteAccount = NULL;
if (m_DeleteAccount != NULL)
newObject->m_DeleteAccount = dynamic_cast<SimpleChoiceLib::CDeleteAccount*>(m_DeleteAccount->Clone().Ptr());
newObject->m_ChangeAccountPassword = NULL;
if (m_ChangeAccountPassword != NULL)
newObject->m_ChangeAccountPassword = dynamic_cast<SimpleChoiceLib::CChangeAccountPassword*>(m_ChangeAccountPassword->Clone().Ptr());
newObject->m_validElement = m_validElement;
// ##HAND_CODED_BLOCK_START ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional clone code here...
// ##HAND_CODED_BLOCK_END ID="Additional clone"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
return newObject.Ptr();
}
std::tstring CAccountAdminRequest::GetTargetNamespace() const
{
return _T("");
}
std::tstring CAccountAdminRequest::GetNamespace() const
{
return _T("");
}
LtXmlLib20::CXmlObjectBase* CAccountAdminRequest::GetBase()
{
return this;
}
void CAccountAdminRequest::CleanMetaData()
{
LtXmlLib20::CXmlGeneratedClass::CleanMetaData(ms_pParentElementInfo, ms_ppElementInfo, ms_ppAttributeInfo);
}
LtXmlLib20Data::CParentElementInfo* CAccountAdminRequest::GetClassInfo() const
{
if (ms_pParentElementInfo == NULL)
{
m_csInit.Enter();
if (ms_pParentElementInfo == NULL)
{
ms_pParentElementInfo = new LtXmlLib20Data::CParentElementInfo(
LtXmlLib20Data::XmlElementGroupType_CHOICE,
LtXmlLib20Data::XmlElementType_ELEMENT,
_T("AccountAdminRequest"),
_T(""),
true,
false,
-1,
LtXmlLib20::ItemType_none,
LtXmlLib20::CWhitespaceUtils::WhitespaceRule_None,
NULL,
false);
}
m_csInit.Leave();
}
return ms_pParentElementInfo;
}
LtXmlLib20Data::CElementInfo** CAccountAdminRequest::GetClassElementInfo() const
{
if (ms_ppElementInfo == NULL)
{
m_csInit.Enter();
if (ms_ppElementInfo == NULL)
{
ms_ppElementInfo = new LtXmlLib20Data::CElementInfo*[4];
ms_ppElementInfo[0] = new LtXmlLib20Data::CElementInfoChoiceClsOpt(_T("CreateAccount"), _T(""), 1, LtXmlLib20Data::XmlElementType_ELEMENT, (LtXmlLib20Data::pfnCreateClassDef)SimpleChoiceLib::CClassFactory::CreateClass, SimpleChoiceLib::CClassFactory::ClsName_CCreateAccount);
ms_ppElementInfo[1] = new LtXmlLib20Data::CElementInfoChoiceClsOpt(_T("DeleteAccount"), _T(""), 2, LtXmlLib20Data::XmlElementType_ELEMENT, (LtXmlLib20Data::pfnCreateClassDef)SimpleChoiceLib::CClassFactory::CreateClass, SimpleChoiceLib::CClassFactory::ClsName_CDeleteAccount);
ms_ppElementInfo[2] = new LtXmlLib20Data::CElementInfoChoiceClsOpt(_T("ChangeAccountPassword"), _T(""), 3, LtXmlLib20Data::XmlElementType_ELEMENT, (LtXmlLib20Data::pfnCreateClassDef)SimpleChoiceLib::CClassFactory::CreateClass, SimpleChoiceLib::CClassFactory::ClsName_CChangeAccountPassword);
ms_ppElementInfo[3] = NULL;
}
m_csInit.Leave();
}
return ms_ppElementInfo;
}
LtXmlLib20Data::CAttributeInfo** CAccountAdminRequest::GetClassAttributeInfo() const
{
if (ms_ppAttributeInfo == NULL)
{
m_csInit.Enter();
if (ms_ppAttributeInfo == NULL)
{
ms_ppAttributeInfo = new LtXmlLib20Data::CAttributeInfo*[1];
ms_ppAttributeInfo[0] = NULL;
}
m_csInit.Leave();
}
return ms_ppAttributeInfo;
}
// ##HAND_CODED_BLOCK_START ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
// Add Additional Methods here...
// ##HAND_CODED_BLOCK_END ID="Additional Methods"## DO NOT MODIFY ANYTHING OUTSIDE OF THESE TAGS
}; // namespace
|
| Main Menu | Samples List |