shape.hpp

Go to the documentation of this file.

#pragma once
#include "fs.hpp"
#include "Table.hpp"
#include "Attribute.hpp"
#include "Group.hpp"

namespace icedb {
    namespace Shapes {

        struct NewShapeRequiredProperties {
            bool NC4_compat = true;

            // The DIMENSIONS

            uint64_t number_of_particle_scattering_elements = 0;

            uint8_t number_of_particle_constituents = 0;

            // Each particle has three axes (X, Y and Z). As these are trivial, only the
            // scale lables are written; the scale does not have an explicit dataset filled with values.
            
            // The VARIABLES

            gsl::span<const float> particle_scattering_element_coordinates;

            uint64_t particle_scattering_element_coordinates_are_integral = 0;
            

            // The ATTRIBUTES

            std::string particle_id;


            bool isValid(std::ostream *errout = nullptr) const;

            bool requiresOptionalPropertiesStruct() const;
        };
        struct NewShapeCommonOptionalProperties {
            gsl::span<const uint64_t> particle_scattering_element_number;
            gsl::span<const uint8_t> particle_constituent_number;


            gsl::span<const float> particle_scattering_element_radius;

            gsl::span<const std::string> particle_constituent_name;

            std::string particle_constituent_single_name;

            gsl::span<const float> particle_scattering_element_composition_fractional;
            gsl::span<const uint8_t> particle_scattering_element_composition_whole;

            float particle_scattering_element_spacing = -1;


            float hint_max_scattering_element_dimension = -1;

            bool isValid(gsl::not_null<const NewShapeRequiredProperties*> required, std::ostream *errout = nullptr) const;
        };

        class Shape : virtual public Groups::Group
        {
        protected:
            Shape(const std::string &uid);
        public:
            static const std::string _icedb_obj_type_shape_identifier;
            virtual ~Shape();
            static bool isShape(Groups::Group &owner, const std::string &name);
            static bool isShape(gsl::not_null<H5::Group*> group);
            bool isShape() const;
            static bool isValid(gsl::not_null<H5::Group*> group, std::ostream *out = nullptr);
            bool isValid(std::ostream *out = nullptr) const;

            typedef std::unique_ptr<Shape> Shape_Type;

            static Shape_Type openShape(Groups::Group &grpshp);
            static Shape_Type openShape(Groups::Group &owner, const std::string &name);
            static Shape_Type openShape(Groups::Group::Group_HDF_shared_ptr shape);

            static Shape_Type createShape(Groups::Group &grpshp, const std::string &uid, 
                gsl::not_null<const NewShapeRequiredProperties*> required,
                const NewShapeCommonOptionalProperties* optional = nullptr);
            static Shape_Type createShape(Groups::Group &owner, const std::string &name,
                const std::string &uid,
                gsl::not_null<const NewShapeRequiredProperties*> required,
                const NewShapeCommonOptionalProperties* optional = nullptr);
            static Shape_Type createShape(Groups::Group::Group_HDF_shared_ptr newShapeLocation,
                const std::string &uid,
                gsl::not_null<const NewShapeRequiredProperties*> required,
                const NewShapeCommonOptionalProperties* optional = nullptr);

            const std::string particle_unique_id;

            /*
            Tables::Table::Table_Type getTable_ParticleScatteringElementNumber() const;
            Tables::Table::Table_Type getTable_ParticleScatteringElementCoordinates() const;
            Tables::Table::Table_Type getTable_ParticleConstituentName() const;
            Tables::Table::Table_Type getTable_ParticleScatteringElementComposition() const;

            Tables::Table::Table_Type getTable_ParticleScatteringElementRadius() const;

            Attributes::Attribute<float> getParticleScatteringElementSpacing_m() const;

            size_t getNumScatteringElements() const;
            */
        };
    }
}