icedb::Shapes::NewShapeRequiredProperties Struct Reference

Strucure containing a list of all of the required data needed to create a new shape in the database. More...

#include <shape.hpp>

Collaboration diagram for icedb::Shapes::NewShapeRequiredProperties:

Public Member Functions
bool	isValid (std::ostream *errout=nullptr) const
bool	requiresOptionalPropertiesStruct () const

Public Attributes
bool	NC4_compat = true
uint64_t	number_of_particle_scattering_elements = 0
uint8_t	number_of_particle_constituents = 0
gsl::span< const float >	particle_scattering_element_coordinates
uint64_t	particle_scattering_element_coordinates_are_integral = 0
std::string	particle_id
	ATTRIBUTE: Unique Particle Identifier. More...

Detailed Description

Strucure containing a list of all of the required data needed to create a new shape in the database.

Definition at line 12 of file shape.hpp.

Member Function Documentation

isValid()

bool icedb::Shapes::NewShapeRequiredProperties::isValid

(

std::ostream *

errout = nullptr

)

const

Validate that all required properties are set, and that they have the correct dimensions. Writes diagnostic messages to the output stream.

Definition at line 10 of file Shapes.cpp.

References number_of_particle_constituents, number_of_particle_scattering_elements, particle_id, and particle_scattering_element_coordinates.

Referenced by main().

                                                                      {
            bool good = true;

            if (number_of_particle_scattering_elements == 0) {
                good = false;
                if (out) (*out) << "The number of scattering elements is not set." << std::endl;
            }
            if (number_of_particle_constituents == 0) {
                good = false;
                if (out) (*out) << "The number of particle constituents is not set." << std::endl;
            }
            if (!particle_id.size()) {
                good = false;
                if (out) (*out) << "Particle ID is not set." << std::endl;
            }
            
            if (this->particle_scattering_element_coordinates.empty()) {
                good = false;
                if (out) (*out) << "particle_scattering_element_coordinates is not set. "
                    "Particles need to have scattering elements." << std::endl;
            }
            else if (particle_scattering_element_coordinates.size() != (3 * number_of_particle_scattering_elements)) {
                good = false;
                if (out) (*out) << "particle_scattering_element_coordinates has "
                    "the wrong dimensions. It should have dimensions of "
                    "[number_of_particle_scattering_elements][3], yielding a total of "
                    << 3 * number_of_particle_scattering_elements << " elements. "
                    "Instead, it currently has " << particle_scattering_element_coordinates.size()
                    << " elements." << std::endl;
            }
            if (this->number_of_particle_constituents == 0) {
                good = false;
                if (out) (*out) << "number_of_particle_constituents is not set. "
                    "Particles need to have a composition." << std::endl;
            }
            

            return good;
        }

Here is the caller graph for this function:

requiresOptionalPropertiesStruct()

bool icedb::Shapes::NewShapeRequiredProperties::requiresOptionalPropertiesStruct

(

)

const

Based on the required properties, must the optional properties structure be required? i.e. Extra information is needed to properly construct the shape.

Definition at line 50 of file Shapes.cpp.

References number_of_particle_constituents.

                                                                                {
            bool req = false;
            if (this->number_of_particle_constituents > 1) req = true;
            return req;
        }

Member Data Documentation

NC4_compat

bool icedb::Shapes::NewShapeRequiredProperties::NC4_compat = true

Do we want NetCDF-4 compatability? Should always be yes.

Deprecated:

This will be removed

Definition at line 15 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply().

number_of_particle_constituents

uint8_t icedb::Shapes::NewShapeRequiredProperties::number_of_particle_constituents = 0

DIMENSION: The number of distinct constituents in the particle. If these have non-trivial ids (i.e. not 1, 2, 3, 4, ...), then define the optional attribute particle_constituent_number.

Definition at line 27 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply(), isValid(), main(), and requiresOptionalPropertiesStruct().

number_of_particle_scattering_elements

uint64_t icedb::Shapes::NewShapeRequiredProperties::number_of_particle_scattering_elements = 0

DIMENSION: The number of scattering elements. If these have non-trivial ids (i.e. not 1, 2, 3, 4, ...), then define the optional attribute particle_scattering_element_number.

Definition at line 22 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply(), isValid(), and main().

particle_id

std::string icedb::Shapes::NewShapeRequiredProperties::particle_id

ATTRIBUTE: Unique Particle Identifier.

Definition at line 48 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply(), isValid(), and main().

particle_scattering_element_coordinates

gsl::span<const float> icedb::Shapes::NewShapeRequiredProperties::particle_scattering_element_coordinates

VARIABLE: Cartesian coordinates of the center of each scattering element Written in form of x_1, y_1, z_1, x_2, y_2, z_2, ... Dimensions of [number_of_particle_scattering_elements][axis]

Definition at line 37 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply(), isValid(), and main().

particle_scattering_element_coordinates_are_integral

uint64_t icedb::Shapes::NewShapeRequiredProperties::particle_scattering_element_coordinates_are_integral = 0

Are the particle_scattering_element_coordinates integers? This allows for optimization when writing. If they are integers, then particle_scattering_element_coordinates_ints is written instead.

Definition at line 42 of file shape.hpp.

Referenced by icedb::Examples::Shapes::ShapeRequiredData::apply().

---

The documentation for this struct was generated from the following files:

• lib/icedb/shape.hpp
• lib/src/Shapes.cpp