kuon::KuonXmlCfg Class Reference

KuonXmlCfg Kuon XML configuration class. More...

#include <kuonXmlCfg.h>

Inheritance diagram for kuon::KuonXmlCfg:

Public Member Functions
	KuonXmlCfg ()
	Default constructor.
virtual	~KuonXmlCfg ()
	Destructor.
virtual int	loadFile (const std::string &strXmlFileName=KuonEtcCfg)
	Load XML file into DOM. More...
virtual int	loadFile (KuonDesc &desc, const std::string &strXmlFileName=KuonEtcCfg)
	Load XML file into DOM and set the Kuon description. More...
virtual int	saveFile (const std::string &strXmlFileName=KuonEtcCfg)
	Save DOM to XML file. More...
virtual int	saveFile (const KuonDesc &desc, const std::string &strXmlFileName=KuonEtcCfg)
	Set DOM from Kuon description and save XML file. More...
virtual int	createTemplateFile (const std::string &strXmlFileName=KuonEtcCfg)
	Create a template Kuon XML configuration file. root element. More...
virtual int	setKuonDescFromDOM (KuonDesc &desc)
	Set Kuon description for DOM. More...
virtual int	setDOMFromKuonDesc (const KuonDesc &desc)
	Set the DOM from the Kuon description. More...

Protected Member Functions
virtual int	setKuonBaseDescFromDOM (TiXmlElement *pElemMaj, KuonDescBase *pDesc)
	Set Kuon robotic base platform description for DOM. More...

Protected Attributes
std::string	m_strMajElemBase
	robotic base major element name
std::string	m_strAttrProdId
	product id attribute name
std::string	m_strElemProdName
	product name element name
std::string	m_strElemProdBrief
	product brief element name
std::string	m_strElemProdHwVer
	product hardware version element name
std::string	m_strElemProdFrontTire
	front tire radius element name
std::string	m_strElemProdRearTire
	rear tire radius element name

Detailed Description

KuonXmlCfg Kuon XML configuration class.

Definition at line 76 of file kuonXmlCfg.h.

Member Function Documentation

int KuonXmlCfg::createTemplateFile ( const std::string &  strXmlFileName = KuonEtcCfg )

virtual

Create a template Kuon XML configuration file. root element.

Any current DOM is not accessed nor altered.

Parameters

strXmlFileName

XML file path name.

Definition at line 72 of file kuonXmlCfg.cxx.

References kuon::KUON_ECODE_XML, and kuon::KUON_OK.

Referenced by saveFile().

{
  FILE       *fp;

  if( strXmlFileName.empty() )
  {
    setErrorMsg("No file name.");
    LOGERROR("%s", m_bufErrMsg);
    return -KUON_ECODE_XML;
  }

  m_strXmlFileName = strXmlFileName;

  // open file
  if( (fp = fopen(m_strXmlFileName.c_str(), "w+")) == NULL )
  {
    setErrorMsg("%s: %s(errno=%d).",
        m_strXmlFileName.c_str(), strerror(errno), errno);
    LOGERROR("%s", m_bufErrMsg);
    return -KUON_ECODE_XML;
  }

  makeXmlHead();
  makeXmlTail();

  //
  // XML head.
  //
  fprintf(fp, "  <!-- RoadNarrows Kuon Top-Level Configuration -->\n");
  fprintf(fp, "%s", m_strXmlHead.c_str());

  //
  // Robotic base major element.
  //
  fprintf(fp, "  <!-- Kuon robotic mobile platform -->\n");
  fprintf(fp, "  <%s product_id=\"PRODID\">\n", m_strMajElemBase.c_str());

  fprintf(fp, "    <%s>PRODNAME</%s>\n",
      m_strElemProdName.c_str(), m_strElemProdName.c_str());

  fprintf(fp, "    <%s>\n    PRODBRIEF\n    </%s>\n",
      m_strElemProdBrief.c_str(), m_strElemProdBrief.c_str());

  fprintf(fp, "    <%s>PRODHWVER</%s>\n",
      m_strElemProdHwVer.c_str(), m_strElemProdHwVer.c_str());

  fprintf(fp, "    <%s>FRONTTIRE</%s>\n",
      m_strElemProdFrontTire.c_str(), m_strElemProdFrontTire.c_str());

  fprintf(fp, "    <%s>REARTIRE</%s>\n",
      m_strElemProdRearTire.c_str(), m_strElemProdRearTire.c_str());

  fprintf(fp, "  </%s>\n\n", m_strMajElemBase.c_str());


  //
  // XML tail
  //
  fprintf(fp, "%s", m_strXmlTail.c_str());

  fclose(fp);

  LOGDIAG3("Created file %s.", m_strXmlFileName.c_str());

  return KUON_OK;
}

virtual int kuon::KuonXmlCfg::loadFile ( const std::string &  strXmlFileName = KuonEtcCfg )

inlinevirtual

Load XML file into DOM.

Parameters

strXmlFileName

XML file path name.

Definition at line 113 of file kuonXmlCfg.h.

References kuon::KUON_ECODE_XML, and kuon::KUON_OK.

    {
      int   rc;

      rc = Xml::loadFile(strXmlFileName);

      return rc < 0? -KUON_ECODE_XML: KUON_OK;
    }

virtual int kuon::KuonXmlCfg::loadFile ( KuonDesc &  desc, const std::string &  strXmlFileName = KuonEtcCfg  )

inlinevirtual

Load XML file into DOM and set the Kuon description.

Parameters

desc

Definition at line 130 of file kuonXmlCfg.h.

References kuon::KUON_ECODE_XML, kuon::KUON_OK, and setKuonDescFromDOM().

    {
      int   rc;

      if( (rc = Xml::loadFile(strXmlFileName)) == OK )
      {
        rc = setKuonDescFromDOM(desc);
      }

      return rc < 0? -KUON_ECODE_XML: KUON_OK;
    }

virtual int kuon::KuonXmlCfg::saveFile ( const std::string &  strXmlFileName = KuonEtcCfg )

inlinevirtual

Save DOM to XML file.

Parameters

strXmlFileName

XML file path name.

Definition at line 150 of file kuonXmlCfg.h.

References kuon::KUON_ECODE_XML, and kuon::KUON_OK.

    {
      int   rc;

      rc = Xml::saveFile(strXmlFileName);

      return rc < 0? -KUON_ECODE_XML: KUON_OK;
    }

virtual int kuon::KuonXmlCfg::saveFile ( const KuonDesc &  desc, const std::string &  strXmlFileName = KuonEtcCfg  )

inlinevirtual

Set DOM from Kuon description and save XML file.

Parameters

desc

Definition at line 167 of file kuonXmlCfg.h.

References createTemplateFile(), kuon::KUON_ECODE_XML, kuon::KUON_OK, setDOMFromKuonDesc(), and setKuonDescFromDOM().

    {
      int   rc;

      if( (rc = setDOMFromKuonDesc(desc)) == KUON_OK )
      {
        rc = Xml::saveFile(strXmlFileName);
      }

      return rc < 0? -KUON_ECODE_XML: KUON_OK;
    }

int KuonXmlCfg::setDOMFromKuonDesc ( const KuonDesc &  desc )

virtual

Set the DOM from the Kuon description.

Parameters

desc

Definition at line 184 of file kuonXmlCfg.cxx.

References kuon::KUON_ECODE_GEN.

Referenced by saveFile().

{
  // TODO
  return -KUON_ECODE_GEN;
}

int KuonXmlCfg::setKuonBaseDescFromDOM ( TiXmlElement *  pElemMaj, KuonDescBase *  pDesc  )

protectedvirtual

Set Kuon robotic base platform description for DOM.

Parameters

pElemMaj	Pointer to major DOM base description element.
pDesc	Point to Kuon robotic base description.

Definition at line 190 of file kuonXmlCfg.cxx.

References kuon::KUON_ECODE_XML, and kuon::KUON_OK.

{
  TiXmlElement *pElem;
  const char   *sValue;
  string        str;
  int           eProdId;
  string        strProdName;
  string        strProdBrief;
  string        strHwVer;
  double        fFrontTire = 0.0;
  double        fRearTire  = 0.0;
  int           rc;

  if( (rc = strToInt(elemAttr(pElemMaj, m_strAttrProdId), eProdId)) < 0 )
  {
    setErrorMsg("%s: No %s attribute of <%s> found or value not an integer.",
      m_strXmlFileName.c_str(),
      m_strAttrProdId.c_str(),
      m_strMajElemBase.c_str());
    LOGERROR("%s", m_bufErrMsg);
    return -KUON_ECODE_XML;
  }

  // child elements
  for(pElem = pElemMaj->FirstChildElement();
      pElem != NULL;
      pElem = pElem->NextSiblingElement())
  {
    if( (sValue = pElem->Value()) == NULL )
    {
      continue;
    }

    // product name
    else if( !strcasecmp(sValue, m_strElemProdName.c_str()) )
    {
      strProdName = elemText(pElem);
    }

    // product brief
    else if( !strcasecmp(sValue, m_strElemProdBrief.c_str()) )
    {
      strProdBrief = elemText(pElem);
    }

    // product hardware version
    else if( !strcasecmp(sValue, m_strElemProdHwVer.c_str()) )
    {
      strHwVer = elemText(pElem);
    }

    // front tires radius
    else if( !strcasecmp(sValue, m_strElemProdFrontTire.c_str()) )
    {
      str = elemText(pElem);
      if( !str.empty() )
      {
        if( (rc = strToDouble(str, fFrontTire)) < 0 )
        {
          setErrorMsg("%s: Element <%s> text \"%s\" not an number.",
            m_strXmlFileName.c_str(), m_strElemProdFrontTire.c_str(),
            str.c_str());
          LOGERROR("%s", m_bufErrMsg);
          return -KUON_ECODE_XML;
        }
      }
    }

    // rear tires radius
    else if( !strcasecmp(sValue, m_strElemProdRearTire.c_str()) )
    {
      str = elemText(pElem);
      if( !str.empty() )
      {
        if( (rc = strToDouble(str, fRearTire)) < 0 )
        {
          setErrorMsg("%s: Element <%s> text \"%s\" not an number.",
            m_strXmlFileName.c_str(), m_strElemProdRearTire.c_str(),
            str.c_str());
          LOGERROR("%s", m_bufErrMsg);
          return -KUON_ECODE_XML;
        }
      }
    }
  }

  pDesc->setDesc(eProdId, strProdName, strProdBrief, strHwVer,
                  fFrontTire, fRearTire);

  LOGDIAG3("%s: Kuon robotic base description set.",
      m_strXmlFileName.c_str());

  return KUON_OK;
}

int KuonXmlCfg::setKuonDescFromDOM ( KuonDesc &  desc )

virtual

Set Kuon description for DOM.

Parameters

desc

Definition at line 139 of file kuonXmlCfg.cxx.

References kuon::KuonDesc::getBaseDesc(), kuon::KUON_ECODE_XML, kuon::KUON_OK, and kuon::KuonDescBase::resetDesc().

Referenced by loadFile(), and saveFile().

{
  KuonDescBase *pDescBase;
  TiXmlElement *pElem;
  const char   *sValue;
  const char   *sAttr;
  const char   *sText;
  int           n;
  int           rc;

  //
  // Subsection descriptions.
  //
  pDescBase  = desc.getBaseDesc();

  pDescBase->resetDesc();

  if( m_pElemRoot == NULL )
  {
    setErrorMsg("Missing DOM and/or <%s> root element missing.",
       m_strRootElemName.c_str());
    LOGERROR("%s", m_bufErrMsg);
    return -KUON_ECODE_XML;
  }

  // search secion elements
  for(pElem = m_pElemRoot->FirstChildElement();
      pElem != NULL;
      pElem = pElem->NextSiblingElement())
  {
    if( (sValue = pElem->Value()) == NULL )
    {
      continue;
    }

    // robotic base description
    if( !strcasecmp(sValue, m_strMajElemBase.c_str()) )
    {
      setKuonBaseDescFromDOM(pElem, pDescBase);
    }
  }

  return KUON_OK;
}

---

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

• include/Kuon/kuonXmlCfg.h
• sw/libkuon/kuonXmlCfg.cxx