DrillPattern.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: DrillPattern
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DrillHole.h>
#if NDEVR_DRILL_HOLE
namespace NDEVR
{
    class JSONNode;
    /**--------------------------------------------------------------------------------------------------
    \brief A Model which represents a series of DrillHoles layed out in a specific pattern.
    **/
    class NDEVR_DESIGN_API DrillPattern : public Model
    {
    public:
        struct HoleLayout
        {
            NDEVR_DESIGN_API HoleLayout();
            NDEVR_DESIGN_API HoleLayout(const JSONNode& node);
            TranslatedString row_name_format;
            TranslatedString hole_name_format;
            fltp08 row_spacing;
            fltp08 hole_spacing;
            fltp08 row_skew;
            uint04 row_count;
            uint04 holes_per_row;
            bool stagger;
            NDEVR_DESIGN_API Vertex<3, fltp08> rowOffset(uint04 row) const;
            NDEVR_DESIGN_API Vertex<3, fltp08> holeOffset(uint04 hole) const;
            bool operator!=(const HoleLayout& pattern) const
            {
                return row_name_format != pattern.row_name_format
                    || hole_name_format != pattern.hole_name_format
                    || row_spacing != pattern.row_spacing
                    || hole_spacing != pattern.hole_spacing
                    || row_skew != pattern.row_skew
                    || row_count != pattern.row_count
                    || holes_per_row != pattern.holes_per_row
                    || stagger != pattern.stagger;
            }
        };
        DrillPattern();
        DrillPattern(const Model& root, fltp08 default_radius = Constant<fltp08>::Invalid);
        DrillHole addCollar(TranslatedString collar_name = TranslatedString());
        DrillHole addCollar(uint04 collar_number);
        void setupCollar(Model& collar);
        void addHolePath(const TranslatedString& collar_name, const TranslatedString& path_name, const Buffer<fltp08>& data, fltp08 radius = Constant<fltp08>::Invalid);
        void addHolePath(const TranslatedString& collar_name, const TranslatedString& path_name, const Buffer<Vertex<3, fltp08>>& data, fltp08 radius = Constant<fltp08>::Invalid);
 
        void addHolePath(const TranslatedString& row_name, const TranslatedString& collar_name, const TranslatedString& path_name, const Buffer<fltp08>& data, fltp08 radius = Constant<fltp08>::Invalid);
        void addHolePath(const TranslatedString& row_name, const TranslatedString& collar_name, const TranslatedString& path_name, const Buffer<Vertex<3, fltp08>>& data, fltp08 radius = Constant<fltp08>::Invalid);
 
        void setPathVisible(const TranslatedString& path, bool is_visible);
        Model addRow(const TranslatedString& row_name);
        Model addRow(const uint04& row_number, bool auto_offset);
        Model addHole(const uint04& row_number);
        static TranslatedString DefaultRowName(uint04 row_number, TranslatedString row_name_format = TranslatedString());
        static TranslatedString DefaultHoleName(uint04 row_number, uint04 hole_number, TranslatedString hole_name_format = TranslatedString());
 
        HoleLayout getLayout() const;
        bool hasRows() const;
        uint04 rowCount() const;
        Buffer<Model> rows() const;
        Model unusedPool();
        fltp08 defaultRadius() const;
 
        void layoutPattern(const HoleLayout& layout, Buffer<Model>& added_models, Buffer<Model>& unused_models);
 
        //Uses keywords [hole_number], [row_number], [row_name], [pattern_name]
        TranslatedString holeNamingConvension() const;
        void setHoleNamingConvension(const TranslatedString& value);
        void autoNameHoles();
 
        TranslatedString rowNamingConvension() const;
        void setRowNamingConvension(const TranslatedString& value);
        void autoNameRows();
 
        static constexpr const char* TypeName() { return "drill_pattern"; }
        static constexpr const char* RowTypeName() { return "drill_pattern_row"; }
    protected:
        fltp08 m_default_radius;
    };
}
#endif