From 0e4eefaee15013e07333608479fe83e4b28f7930 Mon Sep 17 00:00:00 2001 From: cherneysp Date: Fri, 19 Aug 2022 13:24:31 -0500 Subject: [PATCH 01/44] Update config.yml Allow more time for tomcat to finish startup --- .circleci/config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index d70d6b96..2000b669 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -64,7 +64,7 @@ jobs: name: Start Tomcat and verify deployment command: | sudo /opt/tomcat/bin/catalina.sh start - sleep 5 + sleep 10 if [[ `sudo grep "startup in" /opt/tomcat/logs/catalina.out | wc -l` -ne "1" ]]; then exit 1; fi if [[ `wget -O - http://carmacloud:8080 | grep "CARMAcloud Login" | wc -l` -ne "1" ]]; then exit 2; fi if [[ `wget -O - --post-data="uname=ccadmin&pword=admin_testpw" http://carmacloud:8080/api/auth/login | grep "token" | wc -l` -ne "1" ]]; then exit 3; fi From bad9579bc988dea4aa82ba6b087d2d5c3b425c57 Mon Sep 17 00:00:00 2001 From: cherneysp Date: Fri, 19 Aug 2022 13:45:09 -0500 Subject: [PATCH 02/44] Delete TcmReqServlet.java Incorrect location of file --- TcmReqServlet.java | 337 --------------------------------------------- 1 file changed, 337 deletions(-) delete mode 100644 TcmReqServlet.java diff --git a/TcmReqServlet.java b/TcmReqServlet.java deleted file mode 100644 index fe6f0373..00000000 --- a/TcmReqServlet.java +++ /dev/null @@ -1,337 +0,0 @@ -/* - * To change this license header, choose License Headers in Project Properties. - * To change this template file, choose Tools | Templates - * and open the template in the editor. - */ -package cc.ws; - -import cc.ctrl.TrafCtrl; -import cc.ctrl.CtrlGeo; -import cc.ctrl.TcBounds; -import cc.ctrl.TcmReqParser2; -import cc.ctrl.TcmReq; -import cc.ctrl.TcmReqParser; -import cc.ctrl.TrafCtrlEnums; -import cc.ctrl.proc.ProcCtrl; -import cc.geosrv.Mercator; -import cc.util.FileUtil; -import cc.util.Geo; -import cc.util.Text; -import java.io.BufferedInputStream; -import java.io.BufferedWriter; -import java.io.ByteArrayInputStream; -import java.io.DataInputStream; -import java.io.IOException; -import java.io.OutputStreamWriter; -import java.net.HttpURLConnection; -import java.net.URL; -import java.nio.channels.Channels; -import java.nio.charset.StandardCharsets; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.ArrayDeque; -import java.util.ArrayList; -import java.util.Collections; -import java.util.concurrent.ExecutorService; -import java.util.concurrent.Executors; -import javax.servlet.ServletConfig; -import javax.servlet.ServletException; -import javax.servlet.http.HttpServlet; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import org.apache.logging.log4j.LogManager; -import org.apache.logging.log4j.Logger; - - -/** - * - * @author aaron.cherney - */ -public class TcmReqServlet extends HttpServlet implements Runnable -{ - protected static final Logger LOGGER = LogManager.getRootLogger(); - - private int m_nExplodeDistForXml = 0; - private final ArrayDeque REPLYBUFS = new ArrayDeque(); - private final ExecutorService THREADPOOL = Executors.newFixedThreadPool(53); - private static int[] IGNORE_CTRLS; - static - { - IGNORE_CTRLS = new int[]{TrafCtrlEnums.getCtrl("pavement"), TrafCtrlEnums.getCtrl("debug")}; - java.util.Arrays.sort(IGNORE_CTRLS); - } - - - @Override - public void init(ServletConfig oConfig) - { - String sExplodeDistForXml = oConfig.getInitParameter("xmldist"); - if (sExplodeDistForXml != null) - { - int nExplode = Integer.parseInt(sExplodeDistForXml); - if (nExplode == 0) - return; - if (nExplode < ProcCtrl.g_dExplodeStep * 100) - nExplode = (int)(ProcCtrl.g_dExplodeStep * 100); - m_nExplodeDistForXml = nExplode; - } - } - - @Override - public void destroy() - { - THREADPOOL.shutdown(); - } - - - @Override - public void doPost(HttpServletRequest oReq, HttpServletResponse oRes) - throws ServletException, IOException - { - try - { - long lNow = System.currentTimeMillis(); - - StringBuilder sReq = new StringBuilder(); - try (BufferedInputStream oIn = new BufferedInputStream(oReq.getInputStream())) - { - int nByte; - while ((nByte = oIn.read()) >= 0) - sReq.append((char)nByte); - } - - TcmReqParser oReqParser; - if (sReq.indexOf("") >= 0) - oReqParser = new TcmReqParser(); - else - oReqParser = new TcmReqParser2(); - - TcmReq oTcmReq = oReqParser.parseRequest(new ByteArrayInputStream(sReq.toString().getBytes(StandardCharsets.UTF_8))); - Text.removeCtrlChars(sReq); // pack chars into one line - sReq.insert(0, "TCR "); - LOGGER.debug(sReq); - - ArrayList oResCtrls = new ArrayList(); - ArrayList oCtrls = new ArrayList(); - ArrayList oTiles = new ArrayList(); - TrafCtrl oTrafCtrlSearch = new TrafCtrl(); - oTrafCtrlSearch.m_yId = new byte[16]; - TileIds oTileIdsSearch = new TileIds(); - byte[] yIdBuf = new byte[16]; - int nMsgTot = 0; - for (TcBounds oBounds : oTcmReq.m_oBounds) - { - double[] dTcMercBounds = new double[]{Double.MAX_VALUE, Double.MAX_VALUE, -Double.MAX_VALUE, -Double.MAX_VALUE}; - double[] dCorners = new double[oBounds.m_nCorners.length]; - for (int nIndex = 0; nIndex < oBounds.m_nCorners.length;) - { - double dX = Mercator.lonToMeters(Geo.fromIntDeg(oBounds.m_nCorners[nIndex])); - dCorners[nIndex++] = dX; - double dY = Mercator.latToMeters(Geo.fromIntDeg(oBounds.m_nCorners[nIndex])); - dCorners[nIndex++] = dY; - if (dX < dTcMercBounds[0]) - dTcMercBounds[0] = dX; - if (dY < dTcMercBounds[1]) - dTcMercBounds[1] = dY; - if (dX > dTcMercBounds[2]) - dTcMercBounds[2] = dX; - if (dY > dTcMercBounds[3]) - dTcMercBounds[3] = dY; - } - Geo.untwist(dCorners); - for (int n = 0; n < dCorners.length; n += 2) - System.out.print(String.format("[%2.7f,%2.7f],", Mercator.xToLon(dCorners[n]), Mercator.yToLat(dCorners[n + 1]))); - System.out.println(); - Mercator oM = Mercator.getInstance(); - int[] nTiles = new int[2]; - int[] nTileIndices = new int[4]; - oM.metersToTile(dTcMercBounds[0], dTcMercBounds[3], CtrlTiles.g_nZoom, nTiles); // determine the tiles the bounds intersect - nTileIndices[0] = nTiles[0]; - nTileIndices[1] = nTiles[1]; - oM.metersToTile(dTcMercBounds[2], dTcMercBounds[1], CtrlTiles.g_nZoom, nTiles); - nTileIndices[2] = nTiles[0]; - nTileIndices[3] = nTiles[1]; - for (int nTileX = nTileIndices[0]; nTileX <= nTileIndices[2]; nTileX++) // for each tile - { - for (int nTileY = nTileIndices[1]; nTileY <= nTileIndices[3]; nTileY++) - { - Path oIndexFile = Paths.get(String.format(CtrlTiles.g_sTdFileFormat, nTileX, CtrlTiles.g_nZoom, nTileX, nTileY) + ".ndx"); - if (!Files.exists(oIndexFile)) // check if the index file exists - continue; - - oTileIdsSearch.setIndices(nTileX, nTileY); - int nIndex = Collections.binarySearch(oTiles, oTileIdsSearch); - if (nIndex < 0) // if the tile index file has not been loaded - { - TileIds oTile = new TileIds(nTileX, nTileY); - nIndex = ~nIndex; - oTiles.add(nIndex, oTile); - try (DataInputStream oIn = new DataInputStream(new BufferedInputStream(FileUtil.newInputStream(oIndexFile)))) // read the index file to find which controls are in the tile - { - while (oIn.available() > 0) - { - int nType = oIn.readInt(); - oIn.read(yIdBuf); - long lStart = oIn.readLong(); - long lEnd = oIn.readLong(); - if (oBounds.m_lOldest <= lStart && lEnd > lNow && java.util.Arrays.binarySearch(IGNORE_CTRLS, nType) < 0) // skip out controls and control types to ignore - { - byte[] yId = new byte[16]; - System.arraycopy(yIdBuf, 0, yId, 0, 16); - int nSearchIndex = Collections.binarySearch(oTile, yId, TrafCtrl.ID_COMP); - if (nSearchIndex < 0) // only add ids once - oTile.add(~nSearchIndex, yId); - } - } - } - } - - TileIds oTile = oTiles.get(nIndex); - for (byte[] yId : oTile) - { - System.arraycopy(yId, 0, oTrafCtrlSearch.m_yId, 0, yId.length); - int nSearchIndex = Collections.binarySearch(oCtrls, oTrafCtrlSearch); - if (nSearchIndex < 0) // only load controls once - { - String sFile = CtrlTiles.g_sCtrlDir + TrafCtrl.getId(yId) + ".bin"; - TrafCtrl oCtrl; - try (DataInputStream oIn = new DataInputStream(FileUtil.newInputStream(Paths.get(sFile)))) - { - oCtrl = new TrafCtrl(oIn, false); - } - try (DataInputStream oIn = new DataInputStream(FileUtil.newInputStream(Paths.get(sFile)))) - { - oCtrl.m_oFullGeo = new CtrlGeo(oIn, CtrlTiles.g_nZoom); - } - nSearchIndex = ~nSearchIndex; - oCtrls.add(nSearchIndex, oCtrl); - } - - TrafCtrl oCtrl = oCtrls.get(nSearchIndex); - nSearchIndex = Collections.binarySearch(oResCtrls, oTrafCtrlSearch); - if (nSearchIndex < 0) - { - if (!Geo.boundingBoxesIntersect(dTcMercBounds, oCtrl.m_oFullGeo.m_dBB)) - continue; - - if (!Geo.polylineInside(dCorners, oCtrl.m_oFullGeo.m_dC) && !Geo.polylineInside(dCorners, oCtrl.m_oFullGeo.m_dNT) && !Geo.polylineInside(dCorners, oCtrl.m_oFullGeo.m_dPT)) - continue; - - System.out.println(TrafCtrl.getId(oCtrl.m_yId)); - oResCtrls.add(~nSearchIndex, oCtrl); - oCtrl.preparePoints(m_nExplodeDistForXml); - nMsgTot += (oCtrl.size() / 256 + 1); - } - } - } - } - } - - - int nMsgCount = 1; - for (TrafCtrl oCtrl : oResCtrls) - { - int nParts = oCtrl.size() / 256 + 1; - StringBuilder sBuf = new StringBuilder(); - for (int nIndex = 0; nIndex < nParts; nIndex++) - { - if (nIndex == 0) - oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, true, 0); - else - oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, false, nIndex * 256 - 1); - ++nMsgCount; - synchronized (REPLYBUFS) - { - REPLYBUFS.push(sBuf); - THREADPOOL.execute(this); - } - try (BufferedWriter oOut = new BufferedWriter(Channels.newWriter(Files.newByteChannel(Paths.get(String.format("/dev/shm/testreqreply%d.xml", nMsgCount - 1)), FileUtil.WRITE, FileUtil.FILEPERS), "UTF-8"))) - { - oOut.append(sBuf); - } - } - } - } - catch (Exception oEx) - { - oEx.printStackTrace(); - } - } - - @Override - public void run() - { - StringBuilder sBuf = null; - synchronized (REPLYBUFS) - { - if (!REPLYBUFS.isEmpty()) - sBuf = REPLYBUFS.removeFirst(); - } - if (sBuf == null) - return; - - try - { -// Thread.sleep(10000); - HttpURLConnection oHttpClient = (HttpURLConnection)new URL("http://tcmreplyhost:10001/tcmreply").openConnection(); - oHttpClient.setDoOutput(true); - oHttpClient.setRequestMethod("POST"); - oHttpClient.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); - oHttpClient.setFixedLengthStreamingMode(sBuf.length()); - - oHttpClient.connect(); // send post request - - try (OutputStreamWriter oOut = new OutputStreamWriter(oHttpClient.getOutputStream())) - { - oOut.append(sBuf); - } - Text.removeCtrlChars(sBuf); // pack chars into one line - sBuf.insert(0, ' '); // build log msg in reverse order - sBuf.insert(0, oHttpClient.getResponseCode()); - sBuf.insert(0, "TCM "); - LOGGER.debug(sBuf); - oHttpClient.disconnect(); - } - catch (Exception oEx) - { - oEx.printStackTrace(); - } - } - - - private class TileIds extends ArrayList implements Comparable - { - int m_nX; - int m_nY; - - - TileIds() - { - } - - - TileIds(int nX, int nY) - { - setIndices(nX, nY); - } - - - void setIndices(int nX, int nY) - { - m_nX = nX; - m_nY = nY; - } - - - @Override - public int compareTo(TileIds o) - { - int nReturn = Integer.compare(m_nX, o.m_nX); - if (nReturn == 0) - nReturn = Integer.compare(m_nY, o.m_nY); - - return nReturn; - } - } -} From 383dc8f94e8c4605e7b1c6335f8deaefe4abe37b Mon Sep 17 00:00:00 2001 From: cherneysp Date: Fri, 19 Aug 2022 13:45:31 -0500 Subject: [PATCH 03/44] Delete TrafCtrl.java Incorrect location of file --- TrafCtrl.java | 768 -------------------------------------------------- 1 file changed, 768 deletions(-) delete mode 100644 TrafCtrl.java diff --git a/TrafCtrl.java b/TrafCtrl.java deleted file mode 100644 index 7264d622..00000000 --- a/TrafCtrl.java +++ /dev/null @@ -1,768 +0,0 @@ -package cc.ctrl; - -import cc.ctrl.proc.ProcCtrl; -import cc.geosrv.Mercator; -import cc.util.Arrays; -import cc.util.FileUtil; -import cc.util.Geo; -import cc.util.MathUtil; -import java.io.BufferedWriter; -import java.io.InputStream; -import java.io.DataOutputStream; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.text.SimpleDateFormat; -import java.util.ArrayList; -import java.util.Date; -import com.github.aelstad.keccakj.fips202.Shake256; -import cc.util.Text; -import java.io.DataInputStream; -import java.io.IOException; -import java.nio.channels.Channels; -import java.util.Collections; -import java.util.Comparator; -import java.util.Iterator; - - -public class TrafCtrl extends ArrayList implements Comparable -{ - String m_sVersion = "0.1"; - public byte[] m_yId; - long m_lUpdated; - public final ArrayList m_nVTypes = new ArrayList(); - - public long m_lStart; // defaults to max range - public long m_lEnd = Long.MAX_VALUE; - int m_nDoW = 127; // every day of week - ArrayList m_nBetween = new ArrayList(); - int m_nOffset = Integer.MIN_VALUE; // flag for null - int m_nPeriod; - int m_nSpan; - - public boolean m_bRegulatory = true; - public int m_nControlType; - public byte[] m_yControlValue; - - String m_sProj = "epsg:3785"; // spherical mercator for map tiles - String m_sDatum = "WGS84"; - long m_lTime; - public int m_nLon; - public int m_nLat; - int m_nAlt; - int m_nHeading; - public int m_nWidth; - public String m_sLabel; - public CtrlGeo m_oFullGeo = null; - public static Comparator ID_COMP = (byte[] y1, byte[] y2) -> - { - int nReturn = 0; - for (int nIndex = 0; nIndex < y1.length; nIndex++) - { - nReturn = Byte.compare(y1[nIndex], y2[nIndex]); - if (nReturn != 0) - return nReturn; - } - - return nReturn; - }; - - - public TrafCtrl() - { - super(); - m_bRegulatory = true; - m_sLabel = ""; - if (m_nVTypes.isEmpty()) - { - for (int nIndex = 3; nIndex < TrafCtrlEnums.VTYPES.length - 2; nIndex++) - m_nVTypes.add(nIndex); // exclude pedestrians, rail, and unknown - - Collections.sort(m_nVTypes); - } - } - - - public TrafCtrl(String sControlType, int nControlValue, long lTime, TrafCtrl oCtrl, String sLabel, boolean bReg, byte ySrc) - { - this(sControlType, nControlValue, null, lTime, 0, oCtrl, sLabel, bReg, ySrc); - } - - - public TrafCtrl(String sControlType, int nControlValue, ArrayList nVTypes, long lTime, long lStart, TrafCtrl oCtrl, String sLabel, boolean bReg, byte ySrc) - { - this(); - m_nControlType = TrafCtrlEnums.getCtrl(sControlType); - if (nControlValue == Integer.MIN_VALUE) - m_yControlValue = new byte[0]; - else - m_yControlValue = MathUtil.intToBytes(nControlValue, new byte[4]); - m_lTime = lTime; - m_lStart = lStart; - m_nLon = oCtrl.m_nLon; - m_nLat = oCtrl.m_nLat; - m_nHeading = oCtrl.m_nHeading; - m_sLabel = sLabel; - m_bRegulatory = bReg; - m_nWidth = oCtrl.m_nWidth; - for (TrafCtrlPt oPt : oCtrl) - add(new TrafCtrlPt(oPt.m_nX, oPt.m_nY, oPt.m_nZ, oPt.m_nW)); - - if (nVTypes != null) - { - m_nVTypes.clear(); - Collections.sort(nVTypes); - for (Integer nVtype : nVTypes) - m_nVTypes.add(nVtype); - - } - - generateId(ySrc); - } - - - public TrafCtrl(String sControlType, String sControlValue, long lTime, TrafCtrl oCtrl, String sLabel, boolean bReg, byte ySrc) - { - this(sControlType, TrafCtrlEnums.getCtrlVal(sControlType, sControlValue), lTime, oCtrl, sLabel, bReg, ySrc); - } - - public TrafCtrl(String sControlType, int nControlValue, ArrayList nVtypes, long lTime, long lStart, double[] dLineArcs, String sLabel, boolean bReg, byte ySrc) - { - this(sControlType, lTime, dLineArcs); - m_sLabel = sLabel; - m_bRegulatory = bReg; - m_lStart = lStart; - if (nControlValue == Integer.MIN_VALUE) - m_yControlValue = new byte[0]; - else - m_yControlValue = MathUtil.intToBytes(nControlValue, new byte[4]); - - if (nVtypes != null) - { - m_nVTypes.clear(); - Collections.sort(nVtypes); - for (Integer nVtype : nVtypes) - m_nVTypes.add(nVtype); - } - - generateId(ySrc); - } - - public TrafCtrl(String sControlType, int nControlValue, long lTime, double[] dLineArcs, String sLabel, boolean bReg, byte ySrc) - { - this(sControlType, nControlValue, null, lTime, 0, dLineArcs, sLabel, bReg, ySrc); - } - - - public TrafCtrl(String sControlType, byte[] yControlValue, long lTime, double[] dLineArcs, byte ySrc) - { - this(sControlType, lTime, dLineArcs); - m_yControlValue = new byte[yControlValue.length]; - System.arraycopy(yControlValue, 0, m_yControlValue, 0, m_yControlValue.length); - - generateId(ySrc); - } - - - public TrafCtrl(String sControlType, long lTime, double[] dLineArcs) - { - this(); - m_nControlType = TrafCtrlEnums.getCtrl(sControlType); - m_lTime = lTime; - m_nLon = Geo.toIntDeg(Mercator.xToLon(MathUtil.round(dLineArcs[5], 2))); - m_nLat = Geo.toIntDeg(Mercator.yToLat(MathUtil.round(dLineArcs[6], 2))); - m_nWidth = Mercator.mToCm(dLineArcs[7]); - int[] nPrevPt = new int[]{Mercator.mToCm(dLineArcs[5]), Mercator.mToCm(dLineArcs[6]), m_nWidth}; - double dHdg = Geo.heading(nPrevPt[0], nPrevPt[1], dLineArcs[8], dLineArcs[9]); - dHdg = Math.toDegrees(dHdg); - m_nHeading = (int)(dHdg * 10 + 0.5); - Iterator oIt = Arrays.iterator(dLineArcs, new double[3], 5, 3); - while (oIt.hasNext()) - { - double[] dPt = oIt.next(); - int nX = Mercator.mToCm(dPt[0]); - int nY = Mercator.mToCm(dPt[1]); - int nW = Mercator.mToCm(dPt[2]); - int nXd = nX - nPrevPt[0]; - int nYd = nY - nPrevPt[1]; - int nWd = nW - nPrevPt[2]; - TrafCtrlPt oTemp = new TrafCtrlPt(nXd, nYd, nWd); - add(oTemp); - nPrevPt[0] = nX; - nPrevPt[1] = nY; - nPrevPt[2] = nW; - } - } - - - public TrafCtrl(String sControlType, String sControlValue, long lTime, double[] dLineArcs, String sLabel, boolean bReg, byte ySrc) - { - this(sControlType, TrafCtrlEnums.getCtrlVal(sControlType, sControlValue), lTime, dLineArcs, sLabel, bReg, ySrc); - } - - - public TrafCtrl(DataInputStream oIn, boolean bConcat) - throws Exception - { - m_sVersion = oIn.readUTF(); - m_yId = new byte[16]; - oIn.read(m_yId); // might need read loop - m_lUpdated = oIn.readLong(); - - int nCount = oIn.readInt(); - m_nVTypes.ensureCapacity(nCount); - while (nCount-- > 0) - m_nVTypes.add(oIn.readInt()); - Collections.sort(m_nVTypes); - - m_lStart = oIn.readLong(); - m_lEnd = oIn.readLong(); - m_nDoW = oIn.readInt(); - nCount = oIn.readInt(); - m_nBetween.ensureCapacity(nCount); - while (nCount-- > 0) - m_nBetween.add(new int[]{oIn.readInt(), oIn.readInt()}); - - m_nOffset = oIn.readInt(); - m_nPeriod = oIn.readInt(); - m_nSpan = oIn.readInt(); - - m_bRegulatory = oIn.readBoolean(); - m_nControlType = oIn.readInt(); - - m_yControlValue = new byte[oIn.readInt()]; - oIn.read(m_yControlValue); - - - m_sProj = oIn.readUTF(); - m_sDatum = oIn.readUTF(); - m_lTime = oIn.readLong(); - m_nLon = oIn.readInt(); - m_nLat = oIn.readInt(); - m_nAlt = oIn.readInt(); - m_nWidth = oIn.readInt(); - m_nHeading = oIn.readInt(); - m_sLabel = oIn.readUTF(); - - nCount = oIn.readInt(); - ensureCapacity(nCount); - while (nCount-- > 0) - add(new TrafCtrlPt(oIn)); - - if (bConcat) - { - oIn.skip(16); // skip length and average width, both doubles - for (int nIndex = 0; nIndex < 3; nIndex++) // there are 3 sets of points: center, nt, pt - { - int nLen = oIn.readInt(); // read array length - oIn.skip(8); // skip start x and start y, both ints - oIn.skip(nLen * 2 - 2); // skip the rest of the point which are deltas written as bytes - } - } - } - - - private void generateId(byte ySrc) - { - if (m_yId != null) - return; - - Shake256 oMd = new Shake256(); - try - ( - DataOutputStream oAbsorb = new DataOutputStream(oMd.getAbsorbStream()); - InputStream oSqueeze = oMd.getSqueezeStream(); - ) - { - oAbsorb.writeLong(m_lUpdated); - for (Integer nVal : m_nVTypes) - oAbsorb.writeByte(nVal); // unbox and force to byte - - oAbsorb.writeLong(m_lStart); // include required schedule parameters - oAbsorb.writeLong(m_lEnd); - oAbsorb.writeByte(m_nDoW); - - for (int[] nBegDur : m_nBetween) // auto-skip empty array - { - oAbsorb.writeShort(nBegDur[0]); - oAbsorb.writeShort(nBegDur[1]); - } - - if (m_nOffset >= 0) // skip null schedule repeat parameters - { - oAbsorb.writeShort(m_nOffset); - oAbsorb.writeShort(m_nPeriod); - oAbsorb.writeShort(m_nSpan); - } - - oAbsorb.writeBoolean(m_bRegulatory); - oAbsorb.writeByte(m_nControlType); - oAbsorb.write(m_yControlValue); - - oAbsorb.writeLong(m_lTime); - oAbsorb.writeInt(m_nLon); - oAbsorb.writeInt(m_nLat); - oAbsorb.writeInt(m_nAlt); - oAbsorb.writeInt(m_nWidth); - oAbsorb.writeShort(m_nHeading); - - for (TrafCtrlPt oPt : this) // include path points - { - oAbsorb.writeInt(oPt.m_nX); - oAbsorb.writeInt(oPt.m_nY); - - if (oPt.m_nW >= 0) - oAbsorb.writeInt(oPt.m_nW); - - if (oPt.m_nZ >= 0) - oAbsorb.writeInt(oPt.m_nZ); - } - - byte[] yId = new byte[15]; - oSqueeze.read(yId); - m_yId = new byte[16]; - m_yId[0] = ySrc; - System.arraycopy(yId, 0, m_yId, 1, yId.length); - } - catch (Exception oEx) - { - } - } - - - public void write(String sPath, double dExplodeStep, int nZoom, byte ySrc) - throws Exception - { - generateId(ySrc); // need id to build file path - StringBuilder sBuf = new StringBuilder(sPath); - if (sPath.endsWith("/")) - sBuf.setLength(sBuf.length() - 1); // remove trailing path separator - - int nOffset = 0; - int nCount = 3; - while (nCount-- > 0) - { - sBuf.append("/"); - Text.toHexString(m_yId, nOffset, nOffset + 4, sBuf); - nOffset += 4; - } - - sBuf.append("/"); // finish path with filename - Text.toHexString(m_yId, nOffset, nOffset + 4, sBuf); - - writeBin(sBuf, dExplodeStep, nZoom); - writeJson(sBuf); - } - - - protected void writeBin(StringBuilder sBuf, double dExplodeStep, int nZoom) - throws Exception - { - sBuf.append(".bin"); - Path oPath = Paths.get(sBuf.toString()); - Files.createDirectories(oPath.getParent(), FileUtil.DIRPERS); - try (DataOutputStream oOut = new DataOutputStream(FileUtil.newOutputStream(oPath))) - { - oOut.writeUTF(m_sVersion); - oOut.write(m_yId); - oOut.writeLong(m_lUpdated); - - oOut.writeInt(m_nVTypes.size()); - for (Integer nVal : m_nVTypes) - oOut.writeInt(nVal); - - oOut.writeLong(m_lStart); - oOut.writeLong(m_lEnd); - oOut.writeInt(m_nDoW); - oOut.writeInt(m_nBetween.size()); - for (int[] nBegDur : m_nBetween) - { - oOut.write(nBegDur[0]); - oOut.write(nBegDur[1]); - } - oOut.writeInt(m_nOffset); - oOut.writeInt(m_nPeriod); - oOut.writeInt(m_nSpan); - - oOut.writeBoolean(m_bRegulatory); - oOut.writeInt(m_nControlType); - oOut.writeInt(m_yControlValue.length); - oOut.write(m_yControlValue); - - oOut.writeUTF(m_sProj); - oOut.writeUTF(m_sDatum); - oOut.writeLong(m_lTime); - oOut.writeInt(m_nLon); - oOut.writeInt(m_nLat); - oOut.writeInt(m_nAlt); - oOut.writeInt(m_nWidth); - oOut.writeInt(m_nHeading); - oOut.writeUTF(m_sLabel == null ? "" : m_sLabel); - - oOut.writeInt(size()); - for (TrafCtrlPt oPt : this) - oPt.writeBin(oOut); - - - if (m_oFullGeo == null) - m_oFullGeo = new CtrlGeo(this, dExplodeStep, nZoom); - for (int nIndex = 0; nIndex < m_oFullGeo.m_dBB.length; nIndex++) - oOut.writeInt((int)(MathUtil.round(m_oFullGeo.m_dBB[nIndex] * 100.0, 0))); - oOut.writeDouble(m_oFullGeo.m_dLength); - oOut.writeDouble(m_oFullGeo.m_dAverageWidth); - CtrlGeo.writePts(oOut, m_oFullGeo.m_dC); // center line - CtrlGeo.writePts(oOut, m_oFullGeo.m_dNT); // negative tangent line - CtrlGeo.writePts(oOut, m_oFullGeo.m_dPT); // positive tangent line - -// if (Math.abs(m_oFullGeo.m_nTileIndices[2] - m_oFullGeo.m_nTileIndices[0]) > 10 || -// Math.abs(m_oFullGeo.m_nTileIndices[3] - m_oFullGeo.m_nTileIndices[1]) > 10) -// throw new Exception("Ctrl spans too many tiles"); -// for (int nX = m_oFullGeo.m_nTileIndices[0]; nX <= m_oFullGeo.m_nTileIndices[2]; nX++) -// { -// for (int nY = m_oFullGeo.m_nTileIndices[1]; nY <= m_oFullGeo.m_nTileIndices[3]; nY++) -// { -// Path oFile = Paths.get(String.format("", nX, nZoom, nX, nY)); -// Files.createDirectories(oFile.getParent(), FileUtil.DIRPERS); -// try (DataOutputStream oIndexFile = new DataOutputStream(new BufferedOutputStream(FileUtil.newOutputStream(oFile, FileUtil.APPENDTO, FileUtil.FILEPERS)))) -// { -// oIndexFile.write(m_yId); -// oIndexFile.writeInt(m_nControlType); -// } -// } -// } - } - } - - - public void writeIndex(DataOutputStream oOut) - throws IOException - { - oOut.writeInt(m_nControlType); - oOut.write(m_yId); - oOut.writeLong(m_lStart); - oOut.writeLong(m_lEnd); - } - - - protected void writeJson(StringBuilder sBuf) - throws Exception - { - sBuf.append(".json"); - Path oPath = Paths.get(sBuf.toString()); - Files.createDirectories(oPath.getParent(), FileUtil.DIRPERS); - - sBuf.setLength(0); // reset JSON output buffer - sBuf.append("{\n"); // open ctrl object - sBuf.append("\t\"version\":\"").append(m_sVersion).append("\",\n"); - - sBuf.append("\t\"id\":\""); - Text.toHexString(m_yId, 0, m_yId.length, sBuf); - sBuf.append("\",\n"); - - SimpleDateFormat oFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); - sBuf.append("\t\"updated\":\"").append(oFormat.format(new Date(m_lUpdated))).append("\",\n"); - - sBuf.append("\t\"vtypes\":\n\t["); // start vtype array - m_nVTypes.forEach((nVType) -> {sBuf.append("\n\t\t\"").append(TrafCtrlEnums.VTYPES[nVType]).append("\",");}); - sBuf.setLength(sBuf.length() - 1); // remove trailing comma - sBuf.append("\n\t],\n"); // end vtype array - - sBuf.append("\t\"schedule\":\n\t{\n"); // start schedule object - sBuf.append("\t\t\"start\":\"").append(oFormat.format(new Date(m_lStart))).append("\",\n"); - sBuf.append("\t\t\"end\":\"").append(oFormat.format(new Date(m_lEnd))).append("\",\n"); - sBuf.append("\t\t\"dow\":\""); - int nCount = 0; - int nDoW = m_nDoW; // bit-shift day-of-week characters - while (nDoW != 0) - { - if ((nDoW & 1) > 0) - sBuf.append(TrafCtrlEnums.DAYCHARS[nCount]); - - ++nCount; - nDoW >>= 1; - } - sBuf.append("\",\n"); // end day-of-week - - if (!m_nBetween.isEmpty()) // skip empty schedule between parameters - { - sBuf.append("\t\t\"between\":\n\t\t["); // start between array - for (int[] nBegDur : m_nBetween) - { - sBuf.append("\n\t\t\t{\"begin\":").append(nBegDur[0]); - sBuf.append(", \"duration\":").append(nBegDur[1]).append("},"); - } - sBuf.setLength(sBuf.length() - 1); // remove trailing comma - sBuf.append("\n\t\t],\n"); // end between array - } - - if (m_nOffset >= 0) // skip empty schedule repeat parameters - { - sBuf.append("\t\t\"repeat\":\n\t\t\t{\n"); // start schedule repeat object - sBuf.append("\t\t\t\"offset\":").append(m_nOffset).append("\n"); - sBuf.append("\t\t\t\"period\":").append(m_nPeriod).append("\n"); - sBuf.append("\t\t\t\"span\":").append(m_nSpan).append("\n"); - sBuf.append("\t\t},\n"); // end schedule repeat object - } - sBuf.setLength(sBuf.length() - 2); // remove comma and newline - sBuf.append("\n\t},\n"); // end schedule object - - sBuf.append("\t\"regulatory\":").append(m_bRegulatory).append(",\n"); - String[] sCtrl = TrafCtrlEnums.CTRLS[m_nControlType]; - sBuf.append("\t\"controltype\":\"").append(sCtrl[0]).append("\",\n"); - if (m_yControlValue.length > 0) // ignore null values - sBuf.append("\t\"controlvalue\":\"").append(MathUtil.bytesToInt(m_yControlValue)).append("\",\n"); -// sBuf.append("\t\"controlvalue\":\"").append(sCtrl[m_nControlValue]).append("\",\n"); - - sBuf.append("\t\"proj\":\"").append(m_sProj).append("\",\n"); - sBuf.append("\t\"datum\":\"").append(m_sDatum).append("\",\n"); - sBuf.append("\t\"label\":\"").append(m_sLabel).append("\",\n"); - sBuf.append("\t\"time\":\"").append(oFormat.format(new Date(m_lTime))).append("\",\n"); - - sBuf.append("\t\"lon\":").append(m_nLon).append(",\n"); - sBuf.append("\t\"lat\":").append(m_nLat).append(",\n"); - sBuf.append("\t\"alt\":").append(m_nAlt).append(",\n"); - sBuf.append("\t\"heading\":").append(m_nHeading).append(",\n"); - sBuf.append("\t\"points\":\n\t["); // start point array - for (TrafCtrlPt oPt : this) // include path points - { - sBuf.append("\n\t\t"); - oPt.writeJson(sBuf); - sBuf.append(","); - } - sBuf.setLength(sBuf.length() - 1); // remove trailing comma - sBuf.append("\n\t]\n"); // end point array - sBuf.append("}\n"); // close ctrl object - - try (BufferedWriter oOut = new BufferedWriter(Channels.newWriter(Files.newByteChannel(oPath, FileUtil.WRITE, FileUtil.FILEPERS), "UTF-8"))) - { - for (nCount = 0; nCount < sBuf.length(); nCount++) - oOut.write(sBuf.charAt(nCount)); - } - } - - - public void getXml(StringBuilder sBuf, String sReqId, int nReqSeq, int nMsgNum, int nMsgTot, String sVersion, boolean bIncludeParams, int nPtsIndex) - throws IOException - { - sBuf.setLength(0); -// if (sVersion.compareTo("1.0") != 0) -// { -// sBuf.append("invalid version"); -// return; -// } - sBuf.append("\n").append("\n"); - sBuf.append("\t\n"); - sBuf.append("\t\t").append(sReqId).append("\n"); - sBuf.append("\t\t").append(nReqSeq).append("\n"); - sBuf.append("\t\t").append(nMsgTot).append("\n"); - sBuf.append("\t\t").append(nMsgNum).append("\n"); - sBuf.append("\t\t"); - Text.toHexString(m_yId, 0, m_yId.length, sBuf); - sBuf.append("\n"); - sBuf.append("\t\t").append(m_lUpdated / 1000 / 60).append("\n"); // convert to epoch minutes - - sBuf.append("\t\t\n"); - if (m_sLabel != null && !m_sLabel.isEmpty()) - { - sBuf.append("\t\t\t\n"); - } - else - { - sBuf.append("\t\t\t\n"); - } - - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\t\t"); - Text.toHexString(m_yId, 0, m_yId.length, sBuf); - sBuf.append("\n"); - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\n"); - - if (bIncludeParams) - { - sBuf.append("\t\t\n"); - sBuf.append("\t\t\t\n"); - for (int nIndex = 0; nIndex < m_nVTypes.size(); nIndex++) - sBuf.append("\t\t\t\t<").append(TrafCtrlEnums.VTYPES[m_nVTypes.get(nIndex)]).append("/>\n"); - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\t\t").append(m_lStart / 1000 / 60).append("\n"); // convert to epoch minutes - sBuf.append("\t\t\t\t").append(m_lEnd / 1000 / 60).append("\n"); // convert to epoch minutes - sBuf.append("\t\t\t\t"); - int nDoW = m_nDoW; // bit-shift day-of-week characters - for (int nDay = 0; nDay < 7; nDay++) - { - if ((nDoW & 1) > 0) - sBuf.append('1'); - else - sBuf.append('0'); - nDoW >>= 1; - } - - sBuf.append("\n"); - - if (!m_nBetween.isEmpty()) - { - sBuf.append("\t\t\t\t\n"); - for (int[] nBegDur : m_nBetween) - { - sBuf.append("\t\t\t\t\t\n"); - sBuf.append("\t\t\t\t\t\t").append(nBegDur[0]).append("\n"); - sBuf.append("\t\t\t\t\t\t").append(nBegDur[1]).append("\n"); - sBuf.append("\t\t\t\t\t\n"); - - } - sBuf.append("\t\t\t\t\n"); - } - - if (m_nOffset >= 0) - { - sBuf.append("\t\t\t\t\n"); - sBuf.append("\t\t\t\t\t").append(m_nOffset).append("\n"); - sBuf.append("\t\t\t\t\t").append(m_nPeriod).append("\n"); - sBuf.append("\t\t\t\t\t").append(m_nSpan).append("\n"); - sBuf.append("\t\t\t\t\n"); - } - - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\t<").append(m_bRegulatory).append("/>\n"); - sBuf.append("\t\t\t\n"); - ArrayList sVals = new ArrayList(4); - TrafCtrlEnums.getCtrlValString(m_nControlType, m_yControlValue, sVals); - String sTag = sVals.get(0); - sBuf.append("\t\t\t\t<").append(sTag); - if (sVals.size() == 1) // null value so empty tag - sBuf.append("/>"); - else - { - if (TrafCtrlEnums.CTRLS[m_nControlType].length == 1) - sBuf.append(">").append(sVals.get(1)).append(""); - else // enumerated value that needs to be an empty tag, not a value - { - if (sVals.size() == 2) - sBuf.append("><").append(sVals.get(1)).append("/>"); - if (sVals.size() == 4) - sBuf.append("><").append(sVals.get(1)).append("/><").append(sVals.get(3)).append("/>"); - } - } - sBuf.append("\n"); - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\n"); - } - sBuf.append("\t\t\n"); - - sBuf.append("\t\t\t").append(m_sProj).append("\n"); - sBuf.append("\t\t\t").append(m_sDatum).append("\n"); - sBuf.append("\t\t\t").append(m_lTime / 1000 / 60).append("\n"); // convert to EpochMins - sBuf.append("\t\t\t").append(m_nLon).append("\n"); - sBuf.append("\t\t\t").append(m_nLat).append("\n"); - sBuf.append("\t\t\t").append(m_nAlt).append("\n"); - sBuf.append("\t\t\t").append(m_nWidth).append("\n"); - sBuf.append("\t\t\t").append(m_nHeading).append("\n"); - sBuf.append("\t\t\t\n"); - int nEnd = Math.min(size(), (nPtsIndex / 256 + 1) * 256); - for (int nIndex = nPtsIndex; nIndex < nEnd; nIndex++) - { - sBuf.append("\t\t\t\t"); - get(nIndex).writeXml(sBuf); - } - sBuf.append("\t\t\t\n"); - sBuf.append("\t\t\n"); - sBuf.append("\t\n"); - sBuf.append(""); - } - - - public static String getId(byte[] yId) - { - StringBuilder sBuf = new StringBuilder(16); - int nOffset = 0; - int nCount = 4; - while (nCount-- > 0) - { - sBuf.append("/"); - Text.toHexString(yId, nOffset, nOffset + 4, sBuf); - nOffset += 4; - } - return sBuf.toString(); - } - - - public static void getId(byte[] yId, StringBuilder sBuf) - { - sBuf.setLength(0); - int nOffset = 0; - int nCount = 4; - while (nCount-- > 0) - { - sBuf.append("/"); - Text.toHexString(yId, nOffset, nOffset + 4, sBuf); - nOffset += 4; - } - } - - - public double[] toMercatorPoints() - { - double[] dRet = Arrays.newDoubleArray(size() * 2 + 4); - dRet = Arrays.add(dRet, new double[]{Double.MAX_VALUE, Double.MAX_VALUE, -Double.MAX_VALUE, -Double.MAX_VALUE}); - int nPrevX = Mercator.lonToCm(Geo.fromIntDeg(m_nLon)); - int nPrevY = Mercator.latToCm(Geo.fromIntDeg(m_nLat)); - for (TrafCtrlPt oPt : this) - { - int nCurX = nPrevX + oPt.m_nX; - int nCurY = nPrevY + oPt.m_nY; - dRet = Arrays.addAndUpdate(dRet, nCurX / 100.0, nCurY / 100.0); - nPrevX = nCurX; - nPrevY = nCurY; - } - - return dRet; - } - - - public void preparePoints(int nExplodeDist) - { - if (nExplodeDist == 0) - return; - double[] dC = m_oFullGeo.m_dC; - double[] dNT = m_oFullGeo.m_dNT; - int nLimit = Arrays.size(dC); - ArrayList oNewPts = new ArrayList(); - int[] nPrevPt = new int[]{Mercator.lonToCm(Geo.fromIntDeg(m_nLon)), Mercator.latToCm(Geo.fromIntDeg(m_nLat)), m_nWidth}; - int nStep = (int)(nExplodeDist / (ProcCtrl.g_dExplodeStep * 100)) * 2; - for (int nIndex = 1; nIndex < nLimit; nIndex += nStep) - { - int nX = Mercator.mToCm(dC[nIndex]); - int nY = Mercator.mToCm(dC[nIndex + 1]); - int nW = Mercator.mToCm(Geo.distance(dC[nIndex], dC[nIndex + 1], dNT[nIndex], dNT[nIndex + 1]) * 2); - int nXd = nX - nPrevPt[0]; - int nYd = nY - nPrevPt[1]; - int nWd = nW - nPrevPt[2]; - TrafCtrlPt oTemp = new TrafCtrlPt(nXd, nYd, nWd); - oNewPts.add(oTemp); - nPrevPt[0] = nX; - nPrevPt[1] = nY; - nPrevPt[2] = nW; - } - - int nX = Mercator.mToCm(dC[nLimit - 2]); - int nY = Mercator.mToCm(dC[nLimit - 1]); - int nW = Mercator.mToCm(Geo.distance(dC[nLimit - 2], dC[nLimit - 1], dNT[nLimit - 2], dNT[nLimit - 1]) * 2); - int nXd = nX - nPrevPt[0]; - int nYd = nY - nPrevPt[1]; - int nWd = nW - nPrevPt[2]; - if (nXd != 0 || nYd != 0 || nWd != 0) - oNewPts.add(new TrafCtrlPt(nXd, nYd, nWd)); - - clear(); - addAll(oNewPts); - } - - - @Override - public int compareTo(TrafCtrl o) - { - return TrafCtrl.ID_COMP.compare(m_yId, o.m_yId); - } -} From fb245c46a84780f8c5eaef78381ae5b842a9ca0e Mon Sep 17 00:00:00 2001 From: cherneysp Date: Fri, 19 Aug 2022 13:45:44 -0500 Subject: [PATCH 04/44] Delete TrafCtrlEnums.java Incorrect location of file --- TrafCtrlEnums.java | 192 --------------------------------------------- 1 file changed, 192 deletions(-) delete mode 100644 TrafCtrlEnums.java diff --git a/TrafCtrlEnums.java b/TrafCtrlEnums.java deleted file mode 100644 index 469129f0..00000000 --- a/TrafCtrlEnums.java +++ /dev/null @@ -1,192 +0,0 @@ -package cc.ctrl; - -import cc.util.MathUtil; -import cc.util.Text; -import java.util.ArrayList; - - -public abstract class TrafCtrlEnums -{ - public static final String[][] CTRLS = new String[][] - { - {"signal"}, - {"stop"}, - {"yield"}, - {"notowing"}, - {"restricted"}, - {"closed", "open", "notopen", "taperleft", "taperright", "openleft", "openright"}, - {"chains", "no", "permitted", "required"}, - {"direction", "forward", "reverse"}, - {"lataffinity", "left", "right"}, - {"latperm", "none", "permitted", "passing-only", "emergency-only"}, - {"parking", "no", "parallel", "angled"}, - {"minspeed"}, - {"maxspeed"}, - {"minhdwy"}, - {"maxvehmass"}, - {"maxvehheight"}, - {"maxvehwidth"}, - {"maxvehlength"}, - {"maxaxles"}, - {"minvehocc"}, - {"pavement"}, - {"debug"}, - {"maxplatoonsize"}, - {"minplatoonhdwy"} - }; - - - public static final String[][] UNITS = new String[][] - { - new String[0], // signal - new String[0], // stop - new String[0], // yield - new String[0], //notowing - new String[0], //restricted - new String[0], //closed", "open", "closed", "taperleft", "taperright", "openleft", "openright - new String[0], //chains", "no", "permitted", "required - new String[0], //direction", "forward", "reverse - new String[0], //lataffinity", "left", "right - new String[0], //latperm", "none", "permitted", "passing-only", "emergency-only - new String[0], //parking", "no", "parallel", "angled - new String[]{"dm/s", "mph", "kph"}, //minspeed - new String[]{"dm/s", "mph", "kph"}, //maxspeed - new String[]{"sec", "sec", "sec"}, //minhdwy - new String[]{"kg", "lb", "kg"}, //maxvehmass - new String[]{"dm", "ft", "m"}, //maxvehheight - new String[]{"dm", "ft", "m"}, //maxvehwidth - new String[]{"dm", "ft", "m"}, //maxvehlength - new String[0], //maxaxles - new String[0], //minvehocc - new String[0], //pavement - new String[0], //debug" - new String[0], //maxplatoonsize - new String[]{"dm", "ft", "m"} - }; - - public static final char[] DAYCHARS = new char[] - { - 'S', 'M', 'T', 'W', 'R', 'F', 'A' - }; - - - public static final String[] DAYS = new String[] - { - "sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday" - }; - - public static final String[] VTYPES = new String[] - { - "pedestrian", - "bicycle", - "micromobile", - "motorcycle", - "passenger-car", - "light-truck-van", - "bus", - "two-axle-six-tire-single-unit-truck", - "three-axle-single-unit-truck", - "four-or-more-axle-single-unit-truck", - "four-or-fewer-axle-single-trailer-truck", - "five-axle-single-trailer-truck", - "six-or-more-axle-single-trailer-truck", - "five-or-fewer-axle-multi-trailer-truck", - "six-axle-multi-trailer-truck", - "seven-or-more-axle-multi-trailer-truck", - "rail", - "unclassified" - }; - - - public static final String[][] VTYPEGROUPS = new String[][] - { - new String[]{"no motor", "pedestrian", "bicycle"}, - new String[]{"motor bikes", "micromobile", "motorcycle"}, - new String[]{"small vehicles", "passenger-car", "light-truck-van"}, - new String[]{"large vehicles", "bus", "two-axle-six-tire-single-unit-truck", "three-axle-single-unit-truck", "four-or-more-axle-single-unit-truck", "four-or-fewer-axle-single-trailer-truck", "five-axle-single-trailer-truck", "six-or-more-axle-single-trailer-truck", "five-or-fewer-axle-multi-trailer-truck", "six-axle-multi-trailer-truck", "seven-or-more-axle-multi-trailer-truck"}, - new String[]{"other", "rail", "unclassified"} - }; - - - private TrafCtrlEnums() - { - } - - - public static int getVtype(String sVType) - { - int nIndex = VTYPES.length; - while (nIndex-- > 0) - { - if (sVType.compareTo(VTYPES[nIndex]) == 0) - return nIndex; - } - return Integer.MIN_VALUE; - } - - - public static int getCtrl(String sCtrl) - { - int nIndex = CTRLS.length; - while (nIndex-- > 0) - { - if (sCtrl.compareTo(CTRLS[nIndex][0]) == 0) - return nIndex; - } - return Integer.MIN_VALUE; - } - - - public static int getCtrlVal(String sCtrl, String sVal) - { - int nIndex = getCtrl(sCtrl); - if (nIndex >= 0) - { - String[] sVals = CTRLS[nIndex]; - nIndex = sVals.length; - while (nIndex-- > 1) // first value (index 0) is ctrl type - { - if (sVal.compareTo(sVals[nIndex]) == 0) - return nIndex; - } - } - return Integer.MIN_VALUE; - } - - - public static void getCtrlValString(String sCtrl, byte[] yVal, ArrayList sVals) - { - getCtrlValString(getCtrl(sCtrl), yVal, sVals); - } - - - public static void getCtrlValString(int nCtrl, byte[] yVal, ArrayList sVals) - { - sVals.add(CTRLS[nCtrl][0]); // ctrl name - if (nCtrl == getCtrl("signal")) - { - sVals.add(Text.toHexString(yVal)); - return; - } - if (CTRLS[nCtrl].length == 1) // not enumerated type - { - if (yVal.length > 0) // negative values aren't valid - sVals.add(Integer.toString(MathUtil.bytesToInt(yVal))); - return; - } - - int nLatPerm = getCtrl("latperm"); - if (nCtrl == nLatPerm) - { - sVals.add(CTRLS[nCtrl][((yVal[2] & 0xff) << 8) | (yVal[3] & 0xff)]); // outer -// sVals.add(CTRLS[nCtrl][(nVal & 0xffff)]); - sVals.add(CTRLS[nCtrl][0]); - sVals.add(CTRLS[nCtrl][((yVal[0] & 0xff) << 8) | (yVal[1] & 0xff)]); // inner -// sVals.add(CTRLS[nCtrl][((nVal >> 16) & 0xffff)]); - } - else - { - sVals.add(CTRLS[nCtrl][MathUtil.bytesToInt(yVal)]); - } - } -} From 8e82a4c018dcd6c39a1b1bb953050dfdf93f4d47 Mon Sep 17 00:00:00 2001 From: cherneysp Date: Fri, 19 Aug 2022 13:48:50 -0500 Subject: [PATCH 05/44] Update ihp.js Bug fix to avoid controls generated using the IHP2 simulation interface having the same start and end times in TCMs --- web/script/ihp.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/script/ihp.js b/web/script/ihp.js index 0f39463c..3c362a5e 100644 --- a/web/script/ihp.js +++ b/web/script/ihp.js @@ -913,9 +913,9 @@ function checkDoubleInputs(sIds) for (let sKey of sIds.values()) { let dVal = $('#' + sKey).val(); - if (!/^-?[0-9]+([.][0-9]+)?$/.test(dVal)) + if (!/^-?[0-9]+([.][0-9]+)?$/.test(dVal) || (sKey === 'time_interval' && dVal < 60)) { - let oPopuptext = $('Invalid parameter'); + let oPopuptext = $(`Invalid parameter${sKey === 'time_interval' && dVal < 60 ? ': must be >= 60' : ''}`); $('#' + sKey).parent().addClass('popup').append(oPopuptext); $('#' + sKey).focus(); setTimeout(function() From ec8950ed3e549ad2a59db50d59c1e2565111e7f7 Mon Sep 17 00:00:00 2001 From: cherneyasp Date: Fri, 19 Aug 2022 13:54:40 -0500 Subject: [PATCH 06/44] Added parameter to TCRs that allow Traffic Controls to be combined into a single response that is a list of TCMs. Added parameter to TCRs that allow the response port to be specified --- src/cc/ctrl/TcmReqParser.java | 21 ++++----- src/cc/ctrl/TrafCtrl.java | 19 +++++--- src/cc/ws/TcmReqServlet.java | 82 ++++++++++++++++++++++++++--------- 3 files changed, 85 insertions(+), 37 deletions(-) diff --git a/src/cc/ctrl/TcmReqParser.java b/src/cc/ctrl/TcmReqParser.java index e85012f3..32d55246 100644 --- a/src/cc/ctrl/TcmReqParser.java +++ b/src/cc/ctrl/TcmReqParser.java @@ -5,10 +5,7 @@ */ package cc.ctrl; -import java.io.ByteArrayInputStream; import java.io.InputStream; -import java.nio.file.Files; -import java.nio.file.Paths; import java.util.ArrayList; import javax.xml.parsers.SAXParserFactory; import org.xml.sax.Attributes; @@ -30,6 +27,8 @@ public class TcmReqParser extends DefaultHandler2 protected int[] m_nYs = new int[3]; protected int m_nXCount = 0; protected int m_nYCount = 0; + public int m_nPort = 10001; + public boolean m_bList = false; public TcmReqParser() { super(); @@ -51,6 +50,13 @@ public void startElement(String sUri, String sLocalName, { switch (sQname) { + case "TrafficControlRequest": + { + String sVal; + m_nPort = (sVal = iAtt.getValue("port")) != null ? Integer.parseInt(sVal) : m_nPort; + m_bList = (sVal = iAtt.getValue("list")) != null ? Boolean.parseBoolean(sVal) : m_bList; + break; + } case "tcrV01": { m_oReq.m_sVersion = "1.0"; @@ -155,13 +161,4 @@ public TcmReq parseRequest(InputStream oIn) return m_oReq; } - - - public static void main(String[] sArgs) - throws Exception - { - System.out.println(String.valueOf(false)); -// TcmReq oReq = new TcmReqParser().parseRequest(Files.newInputStream(Paths.get("C:/Users/aaron.cherney/Documents/CarmaCloud/traf_ctrl/request.xml"))); -// System.out.println(); - } } diff --git a/src/cc/ctrl/TrafCtrl.java b/src/cc/ctrl/TrafCtrl.java index 84bd1b14..3002f596 100644 --- a/src/cc/ctrl/TrafCtrl.java +++ b/src/cc/ctrl/TrafCtrl.java @@ -518,16 +518,20 @@ protected void writeJson(StringBuilder sBuf) } - public void getXml(StringBuilder sBuf, String sReqId, int nReqSeq, int nMsgNum, int nMsgTot, String sVersion, boolean bIncludeParams, int nPtsIndex) + public void getXml(StringBuilder sBuf, String sReqId, int nReqSeq, int nMsgNum, int nMsgTot, String sVersion, boolean bIncludeParams, int nPtsIndex, boolean bRemoveWidth, boolean bList) throws IOException { - sBuf.setLength(0); + if (!bList) + { + sBuf.setLength(0); + sBuf.append(""); + } // if (sVersion.compareTo("1.0") != 0) // { // sBuf.append("invalid version"); // return; // } - sBuf.append("").append(""); + sBuf.append(""); sBuf.append(""); sBuf.append("").append(sReqId).append(""); sBuf.append("").append(nReqSeq).append(""); @@ -634,13 +638,18 @@ public void getXml(StringBuilder sBuf, String sReqId, int nReqSeq, int nMsgNum, sBuf.append("").append(m_nLon).append(""); sBuf.append("").append(m_nLat).append(""); sBuf.append("").append(m_nAlt).append(""); - sBuf.append("").append(m_nWidth).append(""); + if (bRemoveWidth) + sBuf.append("").append(m_nWidth).append(""); sBuf.append("").append(m_nHeading).append(""); sBuf.append(""); int nEnd = Math.min(size(), (nPtsIndex / 256 + 1) * 256); + if (bList) + { + nPtsIndex = 0; + nEnd = size(); + } for (int nIndex = nPtsIndex; nIndex < nEnd; nIndex++) { - sBuf.append(""); get(nIndex).writeXml(sBuf); } sBuf.append(""); diff --git a/src/cc/ws/TcmReqServlet.java b/src/cc/ws/TcmReqServlet.java index 9c896ec6..a7611c14 100644 --- a/src/cc/ws/TcmReqServlet.java +++ b/src/cc/ws/TcmReqServlet.java @@ -17,8 +17,10 @@ import cc.util.FileUtil; import cc.util.Geo; import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; import java.io.BufferedWriter; import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; import java.io.DataInputStream; import java.io.IOException; import java.io.OutputStreamWriter; @@ -30,6 +32,7 @@ import java.nio.file.Paths; import java.util.ArrayList; import java.util.Collections; +import java.util.zip.GZIPOutputStream; import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; @@ -209,48 +212,87 @@ public void run() } int nMsgCount = 1; - StringBuilder sBuf = new StringBuilder(2048); - for (TrafCtrl oCtrl : oResCtrls) + if (oReqParser.m_bList) + nMsgTot = oResCtrls.size(); + + StringBuilder sBuf = new StringBuilder(nMsgTot * 2048); + + for (int nCtrlIndex = 0; nCtrlIndex < oResCtrls.size(); nCtrlIndex++) { + TrafCtrl oCtrl = oResCtrls.get(nCtrlIndex); int nParts = oCtrl.size() / 256 + 1; + if (oReqParser.m_bList) + nParts = 1; for (int nIndex = 0; nIndex < nParts; nIndex++) { - sBuf.setLength(0); if (nIndex == 0) - oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, true, 0); + oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, true, 0, m_bRemoveWidth, oReqParser.m_bList); else - oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, false, nIndex * 256 - 1); + oCtrl.getXml(sBuf, oTcmReq.m_sReqId, oTcmReq.m_nReqSeq, nMsgCount, nMsgTot, oTcmReq.m_sVersion, false, nIndex * 256 - 1, m_bRemoveWidth, oReqParser.m_bList); ++nMsgCount; - if (m_bRemoveWidth) + + if (!oReqParser.m_bList) { - int nStart = sBuf.indexOf(""); - int nEnd = sBuf.indexOf("", nStart) + "".length(); - sBuf.delete(nStart, nEnd); - } + HttpURLConnection oHttpClient = (HttpURLConnection)new URL(String.format("http://tcmreplyhost:%d/tcmreply", oReqParser.m_nPort)).openConnection(); + oHttpClient.setFixedLengthStreamingMode(sBuf.length()); + oHttpClient.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); + oHttpClient.setDoOutput(true); + oHttpClient.setRequestMethod("POST"); + oHttpClient.setConnectTimeout(1000); - HttpURLConnection oHttpClient = (HttpURLConnection)new URL("http://tcmreplyhost:10001/tcmreply").openConnection(); - oHttpClient.setDoOutput(true); - oHttpClient.setRequestMethod("POST"); - oHttpClient.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); - oHttpClient.setFixedLengthStreamingMode(sBuf.length()); + try + { + oHttpClient.connect(); // send post request + try (BufferedWriter oOut = new BufferedWriter(new OutputStreamWriter(oHttpClient.getOutputStream()))) + { + oOut.append(sBuf); + } + + oHttpClient.disconnect(); + } + catch (Exception oEx) + { + oEx.printStackTrace(); + } + LOGGER.debug(sBuf); + } + } + } + + if (oReqParser.m_bList) + { + HttpURLConnection oHttpClient = (HttpURLConnection)new URL(String.format("http://tcmreplyhost:%d/tcmreply", oReqParser.m_nPort)).openConnection(); + oHttpClient.setRequestProperty("Content-Encoding", "gzip"); + oHttpClient.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); + oHttpClient.setDoOutput(true); + oHttpClient.setRequestMethod("POST"); + oHttpClient.setConnectTimeout(1000); + try (ByteArrayOutputStream oBaos = new ByteArrayOutputStream(sBuf.length())) + { + try (BufferedWriter oOut = new BufferedWriter(new OutputStreamWriter(new GZIPOutputStream(oBaos)))) + { + oOut.append("").append(sBuf).append(""); + } + oHttpClient.setFixedLengthStreamingMode(oBaos.size()); try { oHttpClient.connect(); // send post request - - try (BufferedWriter oOut = new BufferedWriter(new OutputStreamWriter(oHttpClient.getOutputStream()))) + try (BufferedOutputStream oOut = new BufferedOutputStream(oHttpClient.getOutputStream())) { - oOut.append(sBuf); + oOut.write(oBaos.toByteArray()); } - + oHttpClient.disconnect(); } catch (Exception oEx) { oEx.printStackTrace(); } - LOGGER.debug(sBuf); } + sBuf.insert(0, ""); + sBuf.append(""); + LOGGER.debug(sBuf); } } catch (Exception oEx) From 02f0b61226ef9456b9545b8648b166531170e252 Mon Sep 17 00:00:00 2001 From: cherneyasp Date: Fri, 9 Sep 2022 10:06:54 -0500 Subject: [PATCH 07/44] Fixed incorrect logic for removing refwidth --- src/cc/ctrl/TrafCtrl.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/cc/ctrl/TrafCtrl.java b/src/cc/ctrl/TrafCtrl.java index 3002f596..daaec021 100644 --- a/src/cc/ctrl/TrafCtrl.java +++ b/src/cc/ctrl/TrafCtrl.java @@ -638,7 +638,7 @@ public void getXml(StringBuilder sBuf, String sReqId, int nReqSeq, int nMsgNum, sBuf.append("").append(m_nLon).append(""); sBuf.append("").append(m_nLat).append(""); sBuf.append("").append(m_nAlt).append(""); - if (bRemoveWidth) + if (!bRemoveWidth) sBuf.append("").append(m_nWidth).append(""); sBuf.append("").append(m_nHeading).append(""); sBuf.append(""); From c5b3d4a4e9e1037dc85200a1378c5d4845940336 Mon Sep 17 00:00:00 2001 From: SaikrishnaBairamoni Date: Mon, 19 Sep 2022 12:04:16 -0400 Subject: [PATCH 08/44] add PR and ISSUE template --- docs/ISSUE_TEMPLATE.md | 29 +++++++++++++++++++++++ docs/PULL_REQUEST_TEMPLATE.md | 44 +++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 docs/ISSUE_TEMPLATE.md create mode 100644 docs/PULL_REQUEST_TEMPLATE.md diff --git a/docs/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..0eb32fc6 --- /dev/null +++ b/docs/ISSUE_TEMPLATE.md @@ -0,0 +1,29 @@ +### Types of Issue + + + +- [ ] Anomaly report (something appears to not work correctly) +- [ ] Enhancement request (describe the enhancement being requested) +- [ ] Other (please ensure the description clarifies why the issue doesn’t fall into either of the above categories) + +### Descriptive summary + + + +### Carma streets version where this issue was discovered + + + +### Expected behavior + +### Actual behavior + + +### Steps to reproduce the actual behavior + +1. Do this +1. Then do this... + +### Related work + + diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..5bc2cf42 --- /dev/null +++ b/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ + + +# PR Details +## Description + + + +## Related Issue + + + + + + +## Motivation and Context + + + +## How Has This Been Tested? + + + + + +## Types of changes + + + +- [ ] Defect fix (non-breaking change that fixes an issue) +- [ ] New feature (non-breaking change that adds functionality) +- [ ] Breaking change (fix or feature that cause existing functionality to change) + +## Checklist: + + + + +- [ ] I have added any new packages to the sonar-scanner.properties file +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +[CARMA Contributing Guide](https://github.com/usdot-fhwa-stol/carma-platform/blob/develop/Contributing.md) +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. From bc6d85f0e08452aa2ea80ee03c77988f84ed7e6e Mon Sep 17 00:00:00 2001 From: Saikrishna Bairamoni <84093461+SaikrishnaBairamoni@users.noreply.github.com> Date: Fri, 14 Oct 2022 13:54:04 -0400 Subject: [PATCH 09/44] Add Doxygen files and GH Action workflow for pushing to usdot-fhwa-stol/documentation (#35) Add Doxygen files and GH Action workflow for pushing to usdot-fhwa-stol/documentation Co-authored-by: Cody Garver --- .github/workflows/main.yml | 59 + Doxyfile | 2508 ++++++++++++++++++++++++++++++++++++ 2 files changed, 2567 insertions(+) create mode 100644 .github/workflows/main.yml create mode 100644 Doxyfile diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..fc2134e6 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,59 @@ +# Copyright (C) 2018-2022 LEIDOS. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may not +# use this file except in compliance with the License. You may obtain a copy of +# the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations under +# the License. + +# Configuration file for GitHub Actions +# CI will report failure if any executed command returns and error status +# Operations performed are as follows +# Build source code Documentation +# Run Doxygen Action +# Deploy documentation static webpage to gh-pages + +name: Doxygen Action + +# Controls when the action will run. Triggers the workflow on push or pull Request events but only for the develop branch +on: + push: + branches: [ develop ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Install graphvix to support Graph visualization and representing structural information as diagrams of abstract graphs and networks + - name: Install graphviz + run: sudo apt install graphviz && sudo dot -c + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + # Doxygen action for documentation of carma-platform source code by using mattnotmitt github actions workflow + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@v1.9.4 + with: + # Path to Doxyfile + doxyfile-path: "./Doxyfile" # default is ./Doxyfile + # Working directory + working-directory: "." # default is . + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} + external_repository: usdot-fhwa-stol/documentation + publish_branch: gh-pages + # default: gh-pages + publish_dir: ./docs/html/ + destination_dir: ${{ github.event.repository.name }} diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 00000000..e6a481db --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2508 @@ +# Doxyfile 1.9.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Carma-cloud" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = "v4.2.0" + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = CARMAcloud provides some of the infrastructure components for CARMA. It enables users to define geofences, rules of practice, replay storms to test weather-related rules of practice, as well as monitor CARMA-enabled vehicles and the messages and controls exchanged with them. + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./docs/ + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = */test/* \ + */.md/* +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = YES + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = ./docs/mainpage.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = YES + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doxygen-awesome-css/doxygen-awesome.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only.css \ + doxygen-awesome-css/doxygen-awesome-sidebar-only-darkmode-toggle.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /