DesignParameter.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: DesignParameter
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Model.h>
#include <NDEVR/Geometry.h>
#include <NDEVR/String.h>
#include <NDEVR/Unit.h>
namespace NDEVR
{
    struct Unit;
    /**--------------------------------------------------------------------------------------------------
    \brief A definition of data that is logically stored in the Model heirarchy.
        Data could be a property of a Model, Geometry, Vertex, Shape, or Material.
    **/
    class NDEVR_DESIGN_API DesignParameter
    {
    public:
        enum SpecialParameter
        {
              e_undefined
            , e_design_property
            , e_geometry_property
            , e_model_property
            , e_vertex_property
            , e_offset
            , e_rotation
            , e_scale
            , e_surface_area
            , e_volume
            , e_length
            , e_grade
            , e_h_length
            , e_v_length
            , e_geo_orientation
            , e_model_index
            , e_vertex_index
            , e_deployment_bottom
            , e_parent_path
            , e_metadata
            , e_transformed_vertex_metadata
        };
    public:
        String column_name;
        String default_value;
        TranslatedString custom_display_name;
        uint04 dim_a = Constant<uint04>::Invalid;
        uint04 dim_b = Constant<uint04>::Invalid;
        SpecialParameter special_parameter;
        ConstPointer<Unit> unit;
        DesignParameter();
        explicit DesignParameter(DesignObject::DesignProperty property, uint04 sub_section = Constant<uint04>::Invalid);
        explicit DesignParameter(Geometry::GeometryProperty property, uint04 sub_section = Constant<uint04>::Invalid);
        explicit DesignParameter(Model::ModelProperty property, uint04 sub_section = Constant<uint04>::Invalid);
        explicit DesignParameter(VertexProperty property, uint04 sub_section = Constant<uint04>::Invalid);
        explicit DesignParameter(SpecialParameter property, uint04 sub_section = Constant<uint04>::Invalid);
        DesignParameter(SpecialParameter property, const String& data_label);
        DesignParameter(SpecialParameter property, const String& data_label, uint04 sub_section);
        explicit DesignParameter(const String& name);
        DesignParameter(const String& column_name, uint04 vertex_index_a, uint04 vertex_index_b);
        ConstPointer<Unit> defaultUnit() const;
        TypeInfo defaultType() const;
        String stringID() const;
        TranslatedString displayName() const;
        void setCustomDisplayName(const TranslatedString& custom_display_name);
        bool operator!=(const DesignParameter& params) const;
        bool operator==(const DesignParameter& params) const;
        bool operator<(const DesignParameter& params) const;
        bool operator>(const DesignParameter& params) const;
        bool isIgnored() const;
    protected:
        void autoSetSpecialParameter();
    };
    template<>
    class StringStream<DesignParameter>
    {
        
    };
}