In This Package:

XmlUserConditionCnv< DeType > Class Template Reference

This is an empty, abstract, user specific, converter for Conditions. More...

#include <XmlUserConditionCnv.h>

Inheritance diagram for XmlUserConditionCnv< DeType >:

[legend]Collaboration diagram for XmlUserConditionCnv< DeType >:[legend]List of all members.

Public Types
	INVALID_ADDRESS
	INVALID_OBJECT
	NO_MEMORY
	BAD_STORAGE_TYPE
	NO_SOURCE_OBJECT
	ICONVERSIONSVC_LAST_ERROR
	SUCCESS
	NO_INTERFACE
	VERSMISMATCH
	LAST_ERROR
enum	Status
Public Member Functions
	XmlUserConditionCnv (ISvcLocator *svc)
	Constructor for this converter.
virtual	~XmlUserConditionCnv ()
	Default destructor.
virtual StatusCode	initialize ()
	Initializes the converter - Overrides the default method in XmlGenericCnv.
virtual StatusCode	finalize ()
	Finalizes the converter.
virtual StatusCode	createObj (IOpaqueAddress *addr, DataObject *&refpObject)
	Creates the transient representation of an object.
virtual StatusCode	updateObj (IOpaqueAddress *pAddress, DataObject *pObject)
	Updates the transient object from the other representation.
virtual StatusCode	createRep (DataObject *pObject, IOpaqueAddress *&refpAddress)
	Converts the transient object to the requested representation.
virtual StatusCode	updateRep (IOpaqueAddress *pAddress, DataObject *pObject)
	Updates the converted representation of a transient object.
IXmlSvc *	xmlSvc ()
	Accessor to the IXmlSvc interface of the XmlCnvSvc service.
virtual long	repSvcType () const
	Accessor to the StorageType value.
virtual StatusCode	queryInterface (const InterfaceID &riid, void **ppvInterface)
virtual unsigned long	addRef ()
virtual unsigned long	release ()
virtual StatusCode	setDataProvider (IDataProviderSvc *svc)
virtual IDataProviderSvc *	dataProvider () const
virtual StatusCode	setConversionSvc (IConversionSvc *svc)
virtual IConversionSvc *	conversionSvc () const
virtual StatusCode	setAddressCreator (IAddressCreator *creator)
virtual IAddressCreator *	addressCreator () const
virtual const CLID &	objType () const
virtual long	i_repSvcType () const
virtual StatusCode	fillRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
virtual StatusCode	updateRepRefs (IOpaqueAddress *pAddress, DataObject *pObject)
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
Static Public Member Functions
static const CLID &	classID ()
	accessor to the type of elements that this converter converts
static long	storageType ()
	Accessor to the StorageType value.
static const InterfaceID &	interfaceID ()
Public Attributes
	INVALID_ADDRESS
	INVALID_OBJECT
	NO_MEMORY
	BAD_STORAGE_TYPE
	NO_SOURCE_OBJECT
	ICONVERSIONSVC_LAST_ERROR
Protected Member Functions
virtual StatusCode	i_createObj (xercesc::DOMElement *element, DataObject *&refpObject)
	Creates the transient representation of an object from a DOMElement.
virtual StatusCode	i_fillSpecificObj (xercesc::DOMElement *childElement, Condition *refpObject, IOpaqueAddress *address)
	This fills the current object for specific child.
virtual StatusCode	i_fillSpecificObj (xercesc::DOMElement *childElement, DeType *dataObj, IOpaqueAddress *address)
	This fills the current object for specific child.
virtual StatusCode	i_fillSpecificObj (xercesc::DOMElement *childElement, DeType *dataObj)
	This fills the current object for specific child.
virtual StatusCode	fillObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolves the references of the created transient object.
virtual StatusCode	updateObjRefs (IOpaqueAddress *pAddress, DataObject *pObject)
	Resolves the references of the just updated transient object.
virtual StatusCode	i_fillObj (xercesc::DOMElement *childElement, DataObject *refpObject, IOpaqueAddress *address)
	Fills the current object for its child element childElement.
virtual StatusCode	i_fillObj (xercesc::DOMText *childText, DataObject *pObject, IOpaqueAddress *address)
	This fills the current object for its child text node childText.
virtual StatusCode	internalCreateObj (xercesc::DOMElement *element, DataObject *&refpObject, IOpaqueAddress *address)
	This creates the transient representation of an object from the DOMElement representing it, then fills it and process it.
virtual StatusCode	i_processObj (DataObject *pObject, IOpaqueAddress *address)
	This is called after the current object was filled.
IOpaqueAddress *	createAddressForHref (std::string href, CLID clid, IOpaqueAddress *parent) const
	This parses a href attribute string and creates an address out of it Currently, two types of references are understood : regular URLs and references starting with "conddb:/".
IOpaqueAddress *	createXmlAddress (std::string location, std::string entryName, CLID clid) const
	This creates an XmlAddress using the location, entryName and clid.
IOpaqueAddress *	createCondDBAddress (std::string path, std::string entryName, unsigned long channelId, CLID clid) const
	This creates a ConddbAddress using the location, entryName, channelID and clid.
ISvcLocator *	serviceLocator () const
IMessageSvc *	msgSvc () const
IMessageSvc *	messageService () const
IDataManagerSvc *	dataManager () const
Static Protected Member Functions
static const std::string	dom2Std (const XMLCh *domString)
	builds a standard string from a XMLCh*
Protected Attributes
IXmlSvc *	m_xmlSvc
	the IXmlSvc interface of this object
Private Types
typedef XmlUserConditionCnv< DeType >	MyType
	The type of this object.
Friends
class	CnvFactory< MyType >
	Friend needed for instantiation.

---

Detailed Description

template<class DeType>
class XmlUserConditionCnv< DeType >

This is an empty, abstract, user specific, converter for Conditions.

Every actual specific convertor for Condition should inherit from this one. It basically provides the i_createObj, classID methods plus a constructor and a destructor. The only thing to do in order to implement an actual specific converter is thus to implement the second i_fillSpecificObj method.

Author:

Sebastien Ponce

Definition at line 28 of file XmlUserConditionCnv.h.

---

Member Typedef Documentation

template<class DeType>

typedef XmlUserConditionCnv<DeType> XmlUserConditionCnv< DeType >::MyType [private]

The type of this object.

Definition at line 31 of file XmlUserConditionCnv.h.

---

Constructor & Destructor Documentation

template<class DeType>

XmlUserConditionCnv< DeType >::XmlUserConditionCnv

(

ISvcLocator *

svc

)

Constructor for this converter.

Parameters:

svc

a ISvcLocator interface to find services

Definition at line 110 of file XmlUserConditionCnv.h.

  : XmlBaseConditionCnv (svc, DeType::classID()) {
} // end constructor

template<class DeType>

virtual XmlUserConditionCnv< DeType >::~XmlUserConditionCnv

(

)

[inline, virtual]

Default destructor.

Definition at line 47 of file XmlUserConditionCnv.h.

{};

---

Member Function Documentation

template<class DeType>

static const CLID& XmlUserConditionCnv< DeType >::classID

(

)

[inline, static]

accessor to the type of elements that this converter converts

Returns:

the classID for this type

Reimplemented from XmlBaseConditionCnv.

Definition at line 53 of file XmlUserConditionCnv.h.

{ return DeType::classID(); }

template<class DeType>

StatusCode XmlUserConditionCnv< DeType >::i_createObj	(	xercesc::DOMElement *	element,
		DataObject *&	refpObject
	)			[protected, virtual]

Creates the transient representation of an object from a DOMElement.

Overrides the default method in XmlGenericCnv

Parameters:

	element	the DOMElement to be used to builds the object
	refpObject	the object to be built

Returns:

status depending on the completion of the call

Reimplemented from XmlBaseConditionCnv.

Definition at line 120 of file XmlUserConditionCnv.h.

                                                                  {
  MsgStream log(msgSvc(), "XmlUserConditionCnv" );
  log << MSG::DEBUG << "entering i_createObj" << endreq;
  
  // creates an object for the node found
  refpObject = new DeType();
  
  // returns
  return StatusCode::SUCCESS;
} // end i_createObj

template<class DeType>

StatusCode XmlUserConditionCnv< DeType >::i_fillSpecificObj	(	xercesc::DOMElement *	childElement,
		Condition *	refpObject,
		IOpaqueAddress *	address
	)			[protected, virtual]

This fills the current object for specific child.

This is a very general method reimplemented from XmlBaseConditionCnv. It basically calls the other i_fillSpecificObj after casting the current object to its real type.

Parameters:

	childElement	the specific child processed here
	refpObject	the object to be filled
	address	the address for this object

Returns:

status depending on the completion of the call

Implements XmlBaseConditionCnv.

Definition at line 139 of file XmlUserConditionCnv.h.

                          {
  DeType* dataObj = dynamic_cast<DeType*> (refpObject);
  return i_fillSpecificObj (childElement, dataObj, address);
}

template<class DeType>

StatusCode XmlUserConditionCnv< DeType >::i_fillSpecificObj	(	xercesc::DOMElement *	childElement,
		DeType *	dataObj,
		IOpaqueAddress *	address
	)			[protected, virtual]

This fills the current object for specific child.

This should never be called directly but always through the other i_fillSpecificObj. This actually only exist to avoid the user to implement a dynamic cast from Condition into DeType.

Parameters:

	childElement	the specific child processed here
	dataObj	the object to be filled
	address	the address for this object

Returns:

status depending on the completion of the call

Definition at line 152 of file XmlUserConditionCnv.h.

                              {
  return i_fillSpecificObj (childElement, dataObj);
}

template<class DeType>

StatusCode XmlUserConditionCnv< DeType >::i_fillSpecificObj	(	xercesc::DOMElement *	childElement,
		DeType *	dataObj
	)			[protected, virtual]

This fills the current object for specific child.

Deprecated:

This is a deprecated function that was kept for backward compatibility. You should use the new one which has a third argument given the address of the created object

Parameters:

	childElement	the specific child processed here
	dataObj	the object to be filled

Returns:

status depending on the completion of the call

Definition at line 164 of file XmlUserConditionCnv.h.

                      {
  return StatusCode::SUCCESS;
}

virtual StatusCode XmlBaseConditionCnv::initialize

(

)

[virtual, inherited]

Initializes the converter - Overrides the default method in XmlGenericCnv.

Returns:

status depending on the completion of the call

Reimplemented from XmlGenericCnv.

virtual StatusCode XmlBaseConditionCnv::fillObjRefs	(	IOpaqueAddress *	pAddress,
		DataObject *	pObject
	)			[protected, virtual, inherited]

Resolves the references of the created transient object.

Reimplemented from Converter.

virtual StatusCode XmlBaseConditionCnv::updateObjRefs	(	IOpaqueAddress *	pAddress,
		DataObject *	pObject
	)			[protected, virtual, inherited]

Resolves the references of the just updated transient object.

Reimplemented from Converter.

virtual StatusCode XmlBaseConditionCnv::i_fillObj	(	xercesc::DOMElement *	childElement,
		DataObject *	refpObject,
		IOpaqueAddress *	address
	)			[protected, virtual, inherited]

Fills the current object for its child element childElement.

Overrides the default method in XmlGenericCnv

Parameters:

	childElement	the child processed here
	refpObject	the object to be filled
	address	the address for this object

Returns:

status depending on the completion of the call

Reimplemented from XmlGenericCnv.

virtual StatusCode XmlGenericCnv::i_fillObj	(	xercesc::DOMText *	childText,
		DataObject *	pObject,
		IOpaqueAddress *	address
	)			[protected, virtual, inherited]

This fills the current object for its child text node childText.

This will be called for each text child of the current object

Parameters:

	childText	the child processed here
	pObject	the object to be filled
	address	the address for this object

Returns:

status depending on the completion of the call

virtual StatusCode XmlGenericCnv::finalize

(

)

[virtual, inherited]

Finalizes the converter.

Returns:

status depending on the completion of the call

Reimplemented from Converter.

virtual StatusCode XmlGenericCnv::createObj	(	IOpaqueAddress *	addr,
		DataObject *&	refpObject
	)			[virtual, inherited]

Creates the transient representation of an object.

Parameters:

	addr	the address of the object representation
	refpObject	the object created

Returns:

status depending on the completion of the call

Reimplemented from Converter.

virtual StatusCode XmlGenericCnv::updateObj	(	IOpaqueAddress *	pAddress,
		DataObject *	pObject
	)			[virtual, inherited]

Updates the transient object from the other representation.

Parameters:

	pAddress	the address of the object representation
	pObject	the object updated

Returns:

status depending on the completion of the call

Reimplemented from Converter.

virtual StatusCode XmlGenericCnv::createRep	(	DataObject *	pObject,
		IOpaqueAddress *&	refpAddress
	)			[virtual, inherited]

Converts the transient object to the requested representation.

Parameters:

	refpAddress	the address of the object representation
	pObject	the object to convert

Returns:

status depending on the completion of the call

Reimplemented from Converter.

virtual StatusCode XmlGenericCnv::updateRep	(	IOpaqueAddress *	pAddress,
		DataObject *	pObject
	)			[virtual, inherited]

Updates the converted representation of a transient object.

Parameters:

	pAddress	the address of the object representation
	pObject	the object whose representation has to be updated

Returns:

status depending on the completion of the call

Reimplemented from Converter.

IXmlSvc* XmlGenericCnv::xmlSvc

(

)

[inline, inherited]

Accessor to the IXmlSvc interface of the XmlCnvSvc service.

Returns:

the IXmlSvc interface of this object

status depending on the completion of the call

Definition at line 91 of file XmlGenericCnv.h.

                    {
    if (!m_xmlSvc) m_xmlSvc = dynamic_cast<IXmlSvc*>(conversionSvc());
    return m_xmlSvc;
  }

static long XmlGenericCnv::storageType

(

)

[inline, static, inherited]

Accessor to the StorageType value.

Returns:

the storage type for this object

Definition at line 100 of file XmlGenericCnv.h.

                            {
    return XML_StorageType;
  }

virtual long XmlGenericCnv::repSvcType

(

)

const [inline, virtual, inherited]

Accessor to the StorageType value.

Returns:

the storage type for this object

Implements Converter.

Definition at line 108 of file XmlGenericCnv.h.

                                   {
    return XML_StorageType;
  }

virtual StatusCode XmlGenericCnv::internalCreateObj	(	xercesc::DOMElement *	element,
		DataObject *&	refpObject,
		IOpaqueAddress *	address
	)			[protected, virtual, inherited]

This creates the transient representation of an object from the DOMElement representing it, then fills it and process it.

This implementation actually only calls the i_* methods to do the job. Most of the converters don't need to override it but only to override/implement some of the i_* methods.

Parameters:

	element	the DOMElement to be used to builds the object
	refpObject	the object to be built
	address	the address for this object

Returns:

status depending on the completion of the call

virtual StatusCode XmlGenericCnv::i_processObj	(	DataObject *	pObject,
		IOpaqueAddress *	address
	)			[protected, virtual, inherited]

This is called after the current object was filled.

This is were some computation based on the object content could be done

Parameters:

	pObject	the object to be processed
	address	the address for this object

Returns:

status depending on the completion of the call

IOpaqueAddress* XmlGenericCnv::createAddressForHref	(	std::string	href,
		CLID	clid,
		IOpaqueAddress *	parent
	)			const [protected, inherited]

This parses a href attribute string and creates an address out of it Currently, two types of references are understood : regular URLs and references starting with "conddb:/".

The former create addresses with storage type XML_StorageType, the later addresses with storage type CONDDB_StorageType.

Parameters:

	href	the string contained in the href attribute
	clid	the clid of the address to create
	parent	the address of the dataObject that will contain the new object.

Returns:

the new Address

IOpaqueAddress* XmlGenericCnv::createXmlAddress	(	std::string	location,
		std::string	entryName,
		CLID	clid
	)			const [protected, inherited]

This creates an XmlAddress using the location, entryName and clid.

Parameters:

	location	the location string for this address
	entryName	the entryName string for this address
	clid	the clidof the address to create

Returns:

the new Address

IOpaqueAddress* XmlGenericCnv::createCondDBAddress	(	std::string	path,
		std::string	entryName,
		unsigned long	channelId,
		CLID	clid
	)			const [protected, inherited]

This creates a ConddbAddress using the location, entryName, channelID and clid.

Parameters:

	path	the path string for this address
	entryName	the entryName string for this address
	channelId	the channelID for this address
	clid	the clidof the address to create

Returns:

the new Address

static const std::string XmlGenericCnv::dom2Std

(

const XMLCh *

domString

)

[static, protected, inherited]

builds a standard string from a XMLCh*

Parameters:

domString

the XMLCh*

Returns:

a standard string with the same characters

---

Friends And Related Function Documentation

template<class DeType>

friend class CnvFactory< MyType > [friend]

Friend needed for instantiation.

Definition at line 33 of file XmlUserConditionCnv.h.

---

Member Data Documentation

IXmlSvc* XmlGenericCnv::m_xmlSvc [protected, inherited]

the IXmlSvc interface of this object

Definition at line 231 of file XmlGenericCnv.h.

---

The documentation for this class was generated from the following file:

• /home/dayabay/installs/trunk_2011_04_11_opt/NuWa-trunk/lhcb/Det/DetDescCnv/DetDescCnv/XmlUserConditionCnv.h

---