#include <XmlBaseCnv.h>

Inheritance diagram for XmlBaseCnv:

Public Member Functions
virtual	~XmlBaseCnv ()
virtual StatusCode	initialize ()
virtual StatusCode	finalize ()
virtual StatusCode	createObj (IOpaqueAddress addr, DataObject &refpObject)
ICalibXmlSvc *	getCalibXmlSvc ()
	XmlBaseCnv (ISvcLocator *svc, const CLID &clid)
Public Member Functions inherited from Converter< Ty1, Ty2 >
destination *	operator (const source &) const
destination *	operator (const source &) const
destination *	operator (const source &) const

Static Public Member Functions
static const unsigned char	storageType ()

Protected Member Functions
virtual StatusCode	internalCreateObj (const DOMElement element, DataObject &refpObject, IOpaqueAddress *address)
virtual StatusCode	i_createObj (const DOMElement element, DataObject &refpObject)
virtual StatusCode	i_processObj (DataObject pObject, IOpaqueAddress address)
	In case there is additional work to do on the created object.
virtual StatusCode	readHeader (const DOMElement *)
DOMElement *	findFirstRange (const DOMElement *docElt)
DOMElement *	findNextRange (const DOMElement *rangeElt)
	Still another one to navigate XML file and find next set of range data.
DOMElement *	findFirstDacCol (const DOMElement *docElt)
	Another one to find first dac collection element.
DOMElement *	findNextDacCol (const DOMElement *rangeElt)
	Still another one to navigate XML file and find next dac collection.
CalibData::DacCol *	processDacCol (DOMElement dacColElt, unsigned range)
CalibData::ValSig *	processValSig (DOMElement *elt, std::string valName, std::string sigName)
	Read in what will become a CalibData::ValSig.
std::vector< CalibData::ValSig > *	processValSigs (DOMElement *elt, std::string valName, std::string sigName)
	Read in what will become a vector of CalibData::ValSig.
void	setBaseInfo (CalibData::CalibBase *pObj)
	Another utility for derived classes to use.
Protected Member Functions inherited from Converter< Ty1, Ty2 >
virtual destination *	convert (const source &) const =0
virtual destination *	convert (const source &) const =0
virtual destination *	convert (const source &) const =0

Protected Attributes
ICalibXmlSvc *	m_xmlSvc
ICalibMetaCnvSvc *	m_metaSvc
int	m_serNo
ITime *	m_vstart
ITime *	m_vend

Additional Inherited Members
Public Types inherited from Converter< Ty1, Ty2 >
typedef Ty1	source
typedef Ty2	destination
typedef Ty1	source
typedef Ty2	destination
typedef Ty1	source
typedef Ty2	destination

Detailed Description

Base class for calibration converters from XML files to TCDS. All such converters need to do certain things, which are handled here.

Author: J. Bogart

Definition at line 36 of file XmlBaseCnv.h.

Constructor & Destructor Documentation

◆ ~XmlBaseCnv()

XERCES_CPP_NAMESPACE_USE XmlBaseCnv::~XmlBaseCnv ( )

virtual

Definition at line 41 of file XmlBaseCnv.cxx.

41{}

◆ XmlBaseCnv()

XmlBaseCnv::XmlBaseCnv	(	ISvcLocator *	svc,
		const CLID &	clid )

Constructor for this converter

Parameters

svc	a ISvcLocator interface to find services
clid	the type of object the converter is able to convert

Definition at line 45 of file XmlBaseCnv.cxx.

    : Converter( XML_StorageType, clid, svc )
    , m_xmlSvc( 0 )
    , m_metaSvc( 0 )
    , m_vstart( 0 )
    , m_vend( 0 ) /*,
m_nRow(10000), m_nCol(10000), m_nLayer(10000), m_nXtal(10000),
m_nFace(10000), m_nRange(10000) */
{}

Referenced by internalCreateObj(), and XmlTest1Cnv::XmlTest1Cnv().

Member Function Documentation

◆ createObj()

StatusCode XmlBaseCnv::createObj	(	IOpaqueAddress *	addr,
		DataObject *&	refpObject )

virtual

Create the transient representation of an object, given an opaque address. This and the following update method comprise the core functionality of calibration converters.

Definition at line 82 of file XmlBaseCnv.cxx.

                                                                                {
 
  // creates a msg stream for debug purposes
  MsgStream log( msgSvc(), "XmlBaseCnv" );
 
  if ( 0 == addr ) { return StatusCode::FAILURE; }
 
  // first do the things we always need:
  //   First string parameter of opaque address is file ident
  //   Parse file into DOM representation
  const std::string* par = addr->par();
 
  std::string par0 = par[0];
 
  // Ignore trailing white space.
  facilities::Util::trimTrailing( &par0 );
 
  // Just in case there are environment variables in the file specification
  //  int nSub =
  facilities::Util::expandEnvVar( &par0 );
 
  //  XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument* doc =
  DOMDocument* doc = m_xmlSvc->parse( par0.c_str() );
 
  if ( doc == 0 )
  {
    log << MSG::FATAL << "Unable to parse document " << par[0] << " aka " << par0 << endmsg;
    return StatusCode::FAILURE;
  }
  else
  {
    log << MSG::INFO << "successfully parsed document " << par[0] << " aka " << par0 << endmsg;
  }
 
  // Could conceivably write some code here to handle generic
  // parts of document.  Or, alternatively, add services to
  // CalibXmlCnvSvc for converters to invoke to do this.
 
  // Then do some fancy footwork in internalCreateObj to get the
  // appropriate specific converter invoked to interpret the DOM
  // correctly and make a new object of the correct kind.
 
  return internalCreateObj( doc->getDocumentElement(), refpObject, addr );
}

◆ finalize()

StatusCode XmlBaseCnv::finalize ( )

virtual

Definition at line 78 of file XmlBaseCnv.cxx.

78{ return Converter::finalize(); }

◆ findFirstDacCol()

DOMElement * XmlBaseCnv::findFirstDacCol ( const DOMElement * docElt )

protected

Another one to find first dac collection element.

Definition at line 221 of file XmlBaseCnv.cxx.

                                                                  {
  return xmlBase::Dom::findFirstChildByName( docElt, "dac" );
}

◆ findFirstRange()

DOMElement * XmlBaseCnv::findFirstRange ( const DOMElement * docElt )

inlineprotected

Find first range element. Derived classes which need it must define their own implementation.

Definition at line 104 of file XmlBaseCnv.h.

104{ return 0; }

◆ findNextDacCol()

DOMElement * XmlBaseCnv::findNextDacCol ( const DOMElement * rangeElt )

protected

Still another one to navigate XML file and find next dac collection.

Definition at line 225 of file XmlBaseCnv.cxx.

                                                                 {
  DOMElement* next = xmlBase::Dom::getSiblingElement( dacElt );
  if ( xmlBase::Dom::checkTagName( next, "dac" ) ) return next;
  else return 0;
}

◆ findNextRange()

DOMElement * XmlBaseCnv::findNextRange ( const DOMElement * rangeElt )

inlineprotected

Still another one to navigate XML file and find next set of range data.

Definition at line 107 of file XmlBaseCnv.h.

107{ return 0; }

◆ getCalibXmlSvc()

ICalibXmlSvc * XmlBaseCnv::getCalibXmlSvc ( )

inline

Definition at line 52 of file XmlBaseCnv.h.

52{ return m_xmlSvc; }

◆ i_createObj()

StatusCode XmlBaseCnv::i_createObj	(	const DOMElement *	element,
		DataObject *&	refpObject )

protectedvirtual

This creates the transient representation of an object from the DOM_Element representing it. This actually does the "new" operation and deals with the attributes of the node. This base class implementation does nothing; it should not normally be called because it doesn't correspond to any TCDS class. Instead, i_createObj of some derived class will be called.

Parameters

element	the DOM_Element (typically root element of document) to be used to builds the object
refpObject	the object to be built

Returns: status depending on the completion of the call

Reimplemented in XmlTest1Cnv.

Definition at line 193 of file XmlBaseCnv.cxx.

                                                                    {
  return StatusCode::FAILURE;
}

Referenced by internalCreateObj().

◆ i_processObj()

StatusCode XmlBaseCnv::i_processObj	(	DataObject *	pObject,
		IOpaqueAddress *	address )

protectedvirtual

In case there is additional work to do on the created object.

Definition at line 187 of file XmlBaseCnv.cxx.

                                                         {
  return StatusCode::SUCCESS;
}

Referenced by internalCreateObj().

◆ initialize()

StatusCode XmlBaseCnv::initialize ( )

virtual

Definition at line 55 of file XmlBaseCnv.cxx.

                                  {
  StatusCode status = Converter::initialize();
 
  IDataProviderSvc* dp;
 
  // I guess the service names are assigned in jobOptions?
 
  serviceLocator()->getService( "CalibDataSvc", IID_IDataProviderSvc, (IInterface*&)dp );
  setDataProvider( dp );
 
  // Locate the Xml Conversion Service
  serviceLocator()->getService( "CalibXmlCnvSvc", IID_ICalibXmlSvc, (IInterface*&)m_xmlSvc );
 
  // Locate meta conversion service
  // Will anything need to be changed here to accommodate possibility
  // of two concrete implementations of ICalibMetaCnvSvc?  Would
  // have different storage types.  Could specify type desired
  // as job option.  Ditto for name of class?
  serviceLocator()->getService( "CalibMySQLCnvSvc", IID_ICalibMetaCnvSvc,
                                (IInterface*&)m_metaSvc );
  return status;
}

◆ internalCreateObj()

StatusCode XmlBaseCnv::internalCreateObj	(	const DOMElement *	docElt,
		DataObject *&	refpObject,
		IOpaqueAddress *	address )

protectedvirtual

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 of the "right" converter to do the job; so the very first thing it does is get a pointer to the appropriate derived converter. Converters typically don't need to override this method but only to override/implement some of the i_* methods.

Parameters

element	the DOMElement (typically the root element of the document) to be used to build the object
refpObject	the object to be built
address	the opaque address for this object

Returns: status depending on the completion of the call

In a backhanded way, invoke the right specific converter for the type of the object to be created

Parameters

elt	Document elt from XML document (input)
refpObject

Definition at line 132 of file XmlBaseCnv.cxx.

                                                                    {
  // creates a msg stream for debug purposes
  MsgStream log( msgSvc(), "XmlBaseCnv" );
 
  // We're the default if we can't find anything better
  XmlBaseCnv* converter = this;
 
  CLID classId = address->clID();
 
  IConverter* conv = this->conversionSvc()->converter( classId );
 
  if ( 0 == conv )
  {
    log << MSG::WARNING << "No proper converter found for classID " << classId
        << ", the default converter"
        << " will be used. " << endmsg;
  }
  else
  {
    converter = dynamic_cast<XmlBaseCnv*>( conv );
    if ( 0 == converter )
    {
      log << MSG::ERROR << "The converter found for classID " << classId
          << " was not a descendent of XmlBaseCnv as it should be "
          << "( was of type " << typeid( *converter ).name() << "). "
          << "The default converter will be used" << endmsg;
      converter = this;
    }
  }
 
  unsigned int serNo = *( address->ipar() );
  m_serNo            = serNo;
  /* maqm comment for remove getValidInterval()
   StatusCode sc = m_metaSvc->getValidInterval(serNo,
                                                &m_vstart,
                                                &m_vend );
 
 
    // creates an object for the node found
 
 
     if (sc.isSuccess()) sc = converter->i_createObj (docElt, refpObject);
   */
  StatusCode sc = converter->i_createObj( docElt, refpObject );
  if ( sc.isFailure() ) { return sc; }
 
  // ends up the object construction
  sc = converter->i_processObj( refpObject, address );
  if ( sc.isSuccess() )
  { log << MSG::DEBUG << "Successfully created calib. object " << endmsg; }
  return sc;
}

Referenced by createObj().

◆ processDacCol()

CalibData::DacCol * XmlBaseCnv::processDacCol	(	DOMElement *	dacColElt,
		unsigned *	range )

protected

Definition at line 231 of file XmlBaseCnv.cxx.

                                                                                   {
 
  using xmlBase::Dom;
  // maqm comment  using idents::CalXtalId;
 
  std::string att = Dom::getAttribute( dacColElt, "range" );
  /* maqm comment
    if (att.compare(std::string("LEX8")) == 0) *range = CalXtalId::LEX8;
    if (att.compare(std::string("LEX1")) == 0) *range = CalXtalId::LEX1;
    if (att.compare(std::string("HEX8")) == 0) *range = CalXtalId::HEX8;
    if (att.compare(std::string("HEX1")) == 0) *range = CalXtalId::HEX1;
  */
  //  *range = Dom::getIntAttribute(dacColElt, "range");
  std::vector<int> vals;
 
  Dom::getIntsAttribute( dacColElt, "values", vals );
 
  CalibData::DacCol* pDacCol = new CalibData::DacCol( &vals );
  return pDacCol;
}

◆ processValSig()

CalibData::ValSig * XmlBaseCnv::processValSig	(	DOMElement *	elt,
		std::string	valName,
		std::string	sigName )

protected

Read in what will become a CalibData::ValSig.

Definition at line 269 of file XmlBaseCnv.cxx.

                                                                  {
  if ( elt == 0 ) return 0;
  CalibData::ValSig* pValSig = new CalibData::ValSig;
  pValSig->m_val             = xmlBase::Dom::getDoubleAttribute( elt, valName );
  pValSig->m_sig             = xmlBase::Dom::getDoubleAttribute( elt, sigName );
  return pValSig;
}

◆ processValSigs()

std::vector< CalibData::ValSig > * XmlBaseCnv::processValSigs	(	DOMElement *	elt,
		std::string	valName,
		std::string	sigName )

protected

Read in what will become a vector of CalibData::ValSig.

Definition at line 279 of file XmlBaseCnv.cxx.

                                                                                  {
 
  // creates a msg stream for debug purposes
  MsgStream log( msgSvc(), "XmlBaseCnv" );
 
  if ( elt == 0 ) return 0;
  std::vector<float> vals;
  std::vector<float> sigs;
 
  xmlBase::Dom::getFloatsAttribute( elt, valName, vals );
  xmlBase::Dom::getFloatsAttribute( elt, sigName, sigs );
  if ( vals.size() != sigs.size() )
  {
    log << MSG::ERROR << "#values <> #sigmas " << endmsg;
    return 0;
  }
  unsigned                        n        = vals.size();
  std::vector<CalibData::ValSig>* pValSigs = new std::vector<CalibData::ValSig>( n );
  for ( unsigned i = 0; i < n; i++ )
  {
    ( *pValSigs )[i].m_val = vals[i];
    ( *pValSigs )[i].m_sig = sigs[i];
  }
  return pValSigs;
}

◆ readHeader()

StatusCode XmlBaseCnv::readHeader ( const DOMElement * )

protectedvirtual

Definition at line 208 of file XmlBaseCnv.cxx.

208{ return StatusCode::SUCCESS; }

◆ setBaseInfo()

void XmlBaseCnv::setBaseInfo ( CalibData::CalibBase * pObj )

protected

Another utility for derived classes to use.

Another convenience for derived classes: sets information belonging to the calibration base class, namely validity interval and serial number.

Definition at line 216 of file XmlBaseCnv.cxx.

                                                       {
  pObj->setValidity( *m_vstart, *m_vend );
  pObj->setSerNo( m_serNo );
}

◆ storageType()

const unsigned char XmlBaseCnv::storageType ( )

static

Definition at line 210 of file XmlBaseCnv.cxx.

210{ return XML_StorageType; }

Member Data Documentation

◆ m_metaSvc

ICalibMetaCnvSvc* XmlBaseCnv::m_metaSvc

protected

Definition at line 136 of file XmlBaseCnv.h.

Referenced by initialize(), and XmlBaseCnv().

◆ m_serNo

int XmlBaseCnv::m_serNo

protected

Definition at line 138 of file XmlBaseCnv.h.

Referenced by XmlTest1Cnv::i_createObj(), internalCreateObj(), and setBaseInfo().

◆ m_vend

ITime* XmlBaseCnv::m_vend

protected

Definition at line 140 of file XmlBaseCnv.h.

Referenced by XmlTest1Cnv::i_createObj(), setBaseInfo(), and XmlBaseCnv().

◆ m_vstart

ITime* XmlBaseCnv::m_vstart

protected

Definition at line 139 of file XmlBaseCnv.h.

Referenced by XmlTest1Cnv::i_createObj(), setBaseInfo(), and XmlBaseCnv().

◆ m_xmlSvc

ICalibXmlSvc* XmlBaseCnv::m_xmlSvc

protected

Definition at line 135 of file XmlBaseCnv.h.

Referenced by createObj(), getCalibXmlSvc(), initialize(), and XmlBaseCnv().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~XmlBaseCnv()

◆ XmlBaseCnv()

Member Function Documentation

◆ createObj()

◆ finalize()

◆ findFirstDacCol()

◆ findFirstRange()

◆ findNextDacCol()

◆ findNextRange()

◆ getCalibXmlSvc()

◆ i_createObj()

◆ i_processObj()

◆ initialize()

◆ internalCreateObj()

◆ processDacCol()

◆ processValSig()

◆ processValSigs()

◆ readHeader()

◆ setBaseInfo()

◆ storageType()

Member Data Documentation

◆ m_metaSvc

◆ m_serNo

◆ m_vend

◆ m_vstart

◆ m_xmlSvc