Unverified Commit 525bd715 authored by AgoinsUSGS's avatar AgoinsUSGS Committed by GitHub
Browse files

Merge pull request #32 from AgoinsUSGS/documentation 

Updated documentation for cnetbin2pvl
parents e3d574ed 6ea89c69

isis/src/control/apps/cnetbin2pvl/assets/image/InputNetwork.png

0 → 100644
+122 KiB
Loading image diff...

isis/src/control/apps/cnetbin2pvl/assets/image/OutputNetwork.png

0 → 100644
+276 KiB
Loading image diff...

isis/src/control/apps/cnetbin2pvl/assets/image/cnetbin2pvlGUI.png

0 → 100644
+30.3 KiB
Loading image diff...

isis/src/control/apps/cnetbin2pvl/cnetbin2pvl.xml

+54 −3
Original line number Diff line number Diff line
@@ -7,8 +7,9 @@ 


  <description>

    <p>

      This program converts an Isis3 control network file from binary into an 

    ascii pvl formatted file.

      This program converts an Isis3 control network file from binary into a human readable

      utf8 pvl formatted file. The output pvl will be written as the latest Pvl version.

      The most recent Pvl template can be found in the Control data directory under templates/controlnetworks.

    </p>

  </description>
@@ -26,6 +27,11 @@ 
    <change name="Steven Lambright" date="2011-04-05">

      Added a basic progress

    </change>

    <change name="Adam Goins" date="2018-01-24">

      Updated Description to reflect utf file format.

      Added link to current Pvl template.

      Added user example.

    </change>

  </history>



  <groups>
@@ -59,4 +65,49 @@ 
    </parameter>

    </group>

  </groups>

  <examples>

    <example>

      <brief>Converting a binary Control Network to a Pvl network.</brief>

      <description>A binary V0001 Control Network converted to the latest Pvl network.</description>

      <terminalInterface>

        <commandLine>

          from=/usgs/cpkgs/isis3/data/control/testData/unitTest_ControlNetVersioner_ProtoNetwork1_ProtoV0001.net to=PvlNetwork.pvl

        </commandLine>

        <description>

          In this example we are converting a binary V0001 network from the test data area to a Pvl network.

        </description>

      </terminalInterface>

      <inputImages>

        <image src="assets/image/InputNetwork.png" width="500" height="500">

          <brief>Input binary V0001 control network</brief>

          <description>

            This is the input network that will be ingested by cnetbin2pvl.

          </description>

          <thumbnail caption=" Input control network" src="assets/image/InputNetwork.png" width="200" height="165"/>

          <parameterName>FROM</parameterName>

        </image>

      </inputImages>

      <outputImages>

        <image src="assets/image/OutputNetwork.png" width="500" height="500">

          <brief>Output Pvl network from cnetbin2pvl</brief>

          <description>

            This is the Pvl network that results from running cnetbin2pvl.

          </description>

          <thumbnail caption="Output Pvl network that was made from the existing network." src="assets/image/OutputNetwork.png" width="200" height="165"/>

          <parameterName>TO</parameterName>

        </image>

      </outputImages>

      <guiInterfaces>

        <guiInterface>

          <image width="500" height="500" src="assets/image/cnetbin2pvlGUI.png">

            <brief>Example Gui</brief>

            <description>

              Screenshot of GUI with parameters filled to convert a binary Control Network to a Pvl network.

            </description>

            <thumbnail width="200" height="165" caption="Cnetbin2pvl -gui" src="assets/image/cnetbin2pvlGUI.png"/>

          </image>

        </guiInterface>

      </guiInterfaces>

    </example>

  </examples>

</application>

isis/src/control/objs/ControlNetVersioner/ControlNetVersioner.cpp

+8 −8
Original line number Diff line number Diff line
@@ -1372,14 +1372,14 @@ namespace Isis { 
    switch ( protoPoint.type() ) {

      case ControlPointFileEntryV0002_PointType_obsolete_Tie:

      case ControlPointFileEntryV0002_PointType_Free:

        pointType = ControlPoint::PointType::Free;

        pointType = ControlPoint::Free;

        break;

      case ControlPointFileEntryV0002_PointType_Constrained:

        pointType = ControlPoint::PointType::Constrained;

        pointType = ControlPoint::Constrained;

        break;

      case ControlPointFileEntryV0002_PointType_obsolete_Ground:

      case ControlPointFileEntryV0002_PointType_Fixed:

        pointType = ControlPoint::PointType::Fixed;

        pointType = ControlPoint::Fixed;

        break;

      default:

        QString msg = "Unable to create ControlPoint [" + toString(protoPoint.id().c_str())
@@ -1834,13 +1834,13 @@ namespace Isis { 


      ControlPointFileEntryV0002_PointType pointType;

      switch ( controlPoint->GetType() ) {

        case ControlPoint::PointType::Free:

        case ControlPoint::Free:

          pointType = ControlPointFileEntryV0002_PointType_Free;

          break;

        case ControlPoint::PointType::Constrained:

        case ControlPoint::Constrained:

          pointType = ControlPointFileEntryV0002_PointType_Constrained;

          break;

        case ControlPoint::PointType::Fixed:

        case ControlPoint::Fixed:

          pointType = ControlPointFileEntryV0002_PointType_Fixed;

          break;

        default:
@@ -1998,11 +1998,11 @@ namespace Isis { 
        protoMeasure.set_serialnumber(controlMeasure.GetCubeSerialNumber().toLatin1().data());



        switch ( controlMeasure.GetType() ) {

            case (ControlMeasure::MeasureType::Candidate):

            case (ControlMeasure::Candidate):

                protoMeasure.set_type(ControlPointFileEntryV0002_Measure_MeasureType_Candidate);

                break;



            case (ControlMeasure::MeasureType::Manual):

            case (ControlMeasure::Manual):

                protoMeasure.set_type(ControlPointFileEntryV0002_Measure_MeasureType_Manual);

                break;