/src/bag/api/bag_layer.cpp

Source

#include "bag_layer.h"
#include "bag_metadata.h"
#include "bag_private.h"
#include "bag_trackinglist.h"

#include <array>

namespace BAG {

//! Constructor.
/*!
\param dataset
    The BAG Dataset this layer belongs to.
\param descriptor
    The descriptor of this layer.
*/
Layer::Layer(
    Dataset& dataset,
    LayerDescriptor& descriptor)
    : m_pBagDataset(dataset.shared_from_this())
    , m_pLayerDescriptor(descriptor.shared_from_this())
{
}

//! Retrieve the BAG Dataset this layer belongs to.
/*!
\return
    The BAG Dataset this layer belongs to.
*/
std::weak_ptr<Dataset> Layer::getDataset() & noexcept
{
    return m_pBagDataset;
}

//! Retrieve the BAG Dataset this layer belongs to.
/*!
\return
    The BAG Dataset this layer belongs to.
*/
std::weak_ptr<const Dataset> Layer::getDataset() const & noexcept
{
    return m_pBagDataset;
}

//! Determine the type of data stored in the specified layer type.
/*!
\return
    The type of data stored in the specified layer type.
*/
DataType Layer::getDataType(LayerType layerType) noexcept
{
    switch (layerType)
    {
    case Elevation:  //[[fallthrough]];
    case Uncertainty:  //[[fallthrough]];
    case Hypothesis_Strength:  //[[fallthrough]];
    case Shoal_Elevation:  //[[fallthrough]];
    case Std_Dev:  //[[fallthrough]];
    case Average_Elevation:  //[[fallthrough]];
    case Nominal_Elevation:
        return DT_FLOAT32;
    case Num_Hypotheses:  //[[fallthrough]];
    case Num_Soundings:
        return DT_UINT32;
    case Surface_Correction:
    case Georef_Metadata:  //[[fallthrough]];
        return DT_COMPOUND;
    default:
        return DT_UNKNOWN_DATA_TYPE;
    }
}

//! Retrieve the layer's descriptor.
/*!
\return
    The layer's descriptor.
    Will never be nullptr.
*/
std::shared_ptr<LayerDescriptor> Layer::getDescriptor() & noexcept
{
    return m_pLayerDescriptor;
}

//! Retrieve the layer's descriptor.
/*!
\return
    The layer's descriptor.
    Will never be nullptr.
*/
std::shared_ptr<const LayerDescriptor> Layer::getDescriptor() const & noexcept
{
    return m_pLayerDescriptor;
}

//! Retrieve the size of the specified data type.
/*!
\param
    The type of data.

\return
    The size of the specified data type.
*/
uint8_t Layer::getElementSize(DataType type)
{
    switch (type)
    {
    case DT_FLOAT32:
        return sizeof(float);
    case DT_UINT32:
        return sizeof(uint32_t);
    case DT_UINT8:
        return sizeof(uint8_t);
    case DT_UINT16:
        return sizeof(uint16_t);
    case DT_UINT64:
        return sizeof(uint64_t);
    case DT_BOOLEAN:
        return sizeof(bool);
    case DT_STRING:
        return sizeof(char*);
    case DT_COMPOUND:  //[[fallthrough]]
    case DT_UNKNOWN_DATA_TYPE:  //[[fallthrough]]
    default:
        throw UnsupportedElementSize{};
    }
}

//! Retrieve the HDF5 path of the specified layer.
/*!
\param layerType
    The type of layer.
\param groupType
    The type of group.
    NODE or ELEVATION.

\return
    The HDF5 path to the specified layer and group types.
*/
std::string Layer::getInternalPath(
    LayerType layerType,
    GroupType groupType)
{
    if (groupType == NODE)
        return NODE_GROUP_PATH;

    if (groupType == ELEVATION)
        return ELEVATION_SOLUTION_GROUP_PATH;

    if (groupType != UNKNOWN_GROUP_TYPE)
        throw UnsupportedGroupType{};

    switch (layerType)
    {
    case Elevation:
        return ELEVATION_PATH;
    case Uncertainty:
        return UNCERTAINTY_PATH;
    case Hypothesis_Strength:
        return HYPOTHESIS_STRENGTH_PATH;
    case Num_Hypotheses:
        return NUM_HYPOTHESES_PATH;
    case Shoal_Elevation:
        return SHOAL_ELEVATION_PATH;
    case Std_Dev:
        return STANDARD_DEV_PATH;
    case Num_Soundings:
        return NUM_SOUNDINGS_PATH;
    case Average_Elevation:
        return AVERAGE_PATH;
    case Nominal_Elevation:
        return NOMINAL_ELEVATION_PATH;
    case Surface_Correction:
        return VERT_DATUM_CORR_PATH;
    case Georef_Metadata:  // [[fallthrough]];
    case UNKNOWN_LAYER_TYPE:  // [[fallthrough]];
    default:
        throw UnsupportedLayerType{};
    }
}

//! Read a section of data from this layer.
/*!
    Read data from this layer starting at rowStart, columnStart, and continue
    until rowEnd, columnEnd (inclusive).

\param rowStart
    The starting row.
\param columnStart
    The starting column.
\param rowEnd
    The ending row (inclusive).
\param columnEnd
    The ending column (inclusive).

\return
    The section of data specified by the rows and columns.
*/
UInt8Array Layer::read(
    uint32_t rowStart,
    uint32_t columnStart,
    uint32_t rowEnd,
    uint32_t columnEnd) const
{
    if (rowStart > rowEnd || columnStart > columnEnd)
        throw InvalidReadSize{};

    if (m_pBagDataset.expired())
        throw DatasetNotFound{};

    uint32_t numRows = 0, numColumns = 0;
    std::tie(numRows, numColumns) = m_pLayerDescriptor->getDims();

    if (columnEnd >= numColumns || rowEnd >= numRows)
        throw InvalidReadSize{};

    return this->readProxy(rowStart, columnStart, rowEnd, columnEnd);
}

//! Write a section of data to this layer.
/*!
    Write data to this layer starting at rowStart, columnStart, and continue
    until rowEnd, columnEnd (inclusive).

    After writing the data, write the attributes.

\param rowStart
    The starting row.
\param columnStart
    The starting column.
\param rowEnd
    The ending row (inclusive).
\param columnEnd
    The ending column (inclusive).
\param buffer
    The data to be written.
    It must contain at least (rowEnd - rowStart + 1) * (columnEnd - columnStart + 1) elements!
*/
void Layer::write(
    uint32_t rowStart,
    uint32_t columnStart,
    uint32_t rowEnd,
    uint32_t columnEnd,
    const uint8_t* buffer)
{
    if (m_pBagDataset.expired())
        throw DatasetNotFound{};

    if (rowStart > rowEnd || columnStart > columnEnd)
        throw InvalidWriteSize{};

    if (!buffer)
        throw InvalidBuffer{};

    this->writeProxy(rowStart, columnStart, rowEnd, columnEnd, buffer);
    this->writeAttributesProxy();
}

//! Write the attributes this layer contains to disk.
void Layer::writeAttributes() const
{
    if (m_pBagDataset.expired())
        throw DatasetNotFound{};

    this->writeAttributesProxy();
}

}  // namespace BAG


Coverage Report

Created: 2026-08-13 07:18

Line	Count	Source
1
2		#include "bag_layer.h"
3		#include "bag_metadata.h"
4		#include "bag_private.h"
5		#include "bag_trackinglist.h"
6
7		#include <array>
8
9		namespace BAG {
10
11		//! Constructor.
12		/*!
13		\param dataset
14		The BAG Dataset this layer belongs to.
15		\param descriptor
16		The descriptor of this layer.
17		*/
18		Layer::Layer(
19		Dataset& dataset,
20		LayerDescriptor& descriptor)
21	275	: m_pBagDataset(dataset.shared_from_this())
22	275	, m_pLayerDescriptor(descriptor.shared_from_this())
23	275	{
24	275	}
25
26		//! Retrieve the BAG Dataset this layer belongs to.
27		/*!
28		\return
29		The BAG Dataset this layer belongs to.
30		*/
31		std::weak_ptr<Dataset> Layer::getDataset() & noexcept
32	0	{
33	0	return m_pBagDataset;
34	0	}
35
36		//! Retrieve the BAG Dataset this layer belongs to.
37		/*!
38		\return
39		The BAG Dataset this layer belongs to.
40		*/
41		std::weak_ptr<const Dataset> Layer::getDataset() const & noexcept
42	0	{
43	0	return m_pBagDataset;
44	0	}
45
46		//! Determine the type of data stored in the specified layer type.
47		/*!
48		\return
49		The type of data stored in the specified layer type.
50		*/
51		DataType Layer::getDataType(LayerType layerType) noexcept
52	175	{
53	175	switch (layerType)
54	175	{
55	134	case Elevation: //[[fallthrough]];
56	161	case Uncertainty: //[[fallthrough]];
57	161	case Hypothesis_Strength: //[[fallthrough]];
58	161	case Shoal_Elevation: //[[fallthrough]];
59	161	case Std_Dev: //[[fallthrough]];
60	161	case Average_Elevation: //[[fallthrough]];
61	175	case Nominal_Elevation:
62	175	return DT_FLOAT32;
63	0	case Num_Hypotheses: //[[fallthrough]];
64	0	case Num_Soundings:
65	0	return DT_UINT32;
66	0	case Surface_Correction:
67	0	case Georef_Metadata: //[[fallthrough]];
68	0	return DT_COMPOUND;
69	0	default:
70	0	return DT_UNKNOWN_DATA_TYPE;
71	175	}
72	175	}
73
74		//! Retrieve the layer's descriptor.
75		/*!
76		\return
77		The layer's descriptor.
78		Will never be nullptr.
79		*/
80		std::shared_ptr<LayerDescriptor> Layer::getDescriptor() & noexcept
81	305	{
82	305	return m_pLayerDescriptor;
83	305	}
84
85		//! Retrieve the layer's descriptor.
86		/*!
87		\return
88		The layer's descriptor.
89		Will never be nullptr.
90		*/
91		std::shared_ptr<const LayerDescriptor> Layer::getDescriptor() const & noexcept
92	54	{
93	54	return m_pLayerDescriptor;
94	54	}
95
96		//! Retrieve the size of the specified data type.
97		/*!
98		\param
99		The type of data.
100
101		\return
102		The size of the specified data type.
103		*/
104		uint8_t Layer::getElementSize(DataType type)
105	4.08k	{
106	4.08k	switch (type)
107	4.08k	{
108	1.41k	case DT_FLOAT32:
109	1.41k	return sizeof(float);
110	271	case DT_UINT32:
111	271	return sizeof(uint32_t);
112	0	case DT_UINT8:
113	0	return sizeof(uint8_t);
114	63	case DT_UINT16:
115	63	return sizeof(uint16_t);
116	0	case DT_UINT64:
117	0	return sizeof(uint64_t);
118	901	case DT_BOOLEAN:
119	901	return sizeof(bool);
120	1.43k	case DT_STRING:
121	1.43k	return sizeof(char*);
122	1	case DT_COMPOUND: //[[fallthrough]]
123	1	case DT_UNKNOWN_DATA_TYPE: //[[fallthrough]]
124	3	default:
125	3	throw UnsupportedElementSize{};
126	4.08k	}
127	4.08k	}
128
129		//! Retrieve the HDF5 path of the specified layer.
130		/*!
131		\param layerType
132		The type of layer.
133		\param groupType
134		The type of group.
135		NODE or ELEVATION.
136
137		\return
138		The HDF5 path to the specified layer and group types.
139		*/
140		std::string Layer::getInternalPath(
141		LayerType layerType,
142		GroupType groupType)
143	2.57k	{
144	2.57k	if (groupType == NODE)
145	0	return NODE_GROUP_PATH;
146
147	2.57k	if (groupType == ELEVATION)
148	0	return ELEVATION_SOLUTION_GROUP_PATH;
149
150	2.57k	if (groupType != UNKNOWN_GROUP_TYPE)
151	0	throw UnsupportedGroupType{};
152
153	2.57k	switch (layerType)
154	2.57k	{
155	391	case Elevation:
156	391	return ELEVATION_PATH;
157	284	case Uncertainty:
158	284	return UNCERTAINTY_PATH;
159	257	case Hypothesis_Strength:
160	257	return HYPOTHESIS_STRENGTH_PATH;
161	257	case Num_Hypotheses:
162	257	return NUM_HYPOTHESES_PATH;
163	257	case Shoal_Elevation:
164	257	return SHOAL_ELEVATION_PATH;
165	257	case Std_Dev:
166	257	return STANDARD_DEV_PATH;
167	257	case Num_Soundings:
168	257	return NUM_SOUNDINGS_PATH;
169	257	case Average_Elevation:
170	257	return AVERAGE_PATH;
171	271	case Nominal_Elevation:
172	271	return NOMINAL_ELEVATION_PATH;
173	84	case Surface_Correction:
174	84	return VERT_DATUM_CORR_PATH;
175	0	case Georef_Metadata: // [[fallthrough]];
176	0	case UNKNOWN_LAYER_TYPE: // [[fallthrough]];
177	0	default:
178	0	throw UnsupportedLayerType{};
179	2.57k	}
180	2.57k	}
181
182		//! Read a section of data from this layer.
183		/*!
184		Read data from this layer starting at rowStart, columnStart, and continue
185		until rowEnd, columnEnd (inclusive).
186
187		\param rowStart
188		The starting row.
189		\param columnStart
190		The starting column.
191		\param rowEnd
192		The ending row (inclusive).
193		\param columnEnd
194		The ending column (inclusive).
195
196		\return
197		The section of data specified by the rows and columns.
198		*/
199		UInt8Array Layer::read(
200		uint32_t rowStart,
201		uint32_t columnStart,
202		uint32_t rowEnd,
203		uint32_t columnEnd) const
204	0	{
205	0	if (rowStart > rowEnd \|\| columnStart > columnEnd)
206	0	throw InvalidReadSize{};
207
208	0	if (m_pBagDataset.expired())
209	0	throw DatasetNotFound{};
210
211	0	uint32_t numRows = 0, numColumns = 0;
212	0	std::tie(numRows, numColumns) = m_pLayerDescriptor->getDims();
213
214	0	if (columnEnd >= numColumns \|\| rowEnd >= numRows)
215	0	throw InvalidReadSize{};
216
217	0	return this->readProxy(rowStart, columnStart, rowEnd, columnEnd);
218	0	}
219
220		//! Write a section of data to this layer.
221		/*!
222		Write data to this layer starting at rowStart, columnStart, and continue
223		until rowEnd, columnEnd (inclusive).
224
225		After writing the data, write the attributes.
226
227		\param rowStart
228		The starting row.
229		\param columnStart
230		The starting column.
231		\param rowEnd
232		The ending row (inclusive).
233		\param columnEnd
234		The ending column (inclusive).
235		\param buffer
236		The data to be written.
237		It must contain at least (rowEnd - rowStart + 1) * (columnEnd - columnStart + 1) elements!
238		*/
239		void Layer::write(
240		uint32_t rowStart,
241		uint32_t columnStart,
242		uint32_t rowEnd,
243		uint32_t columnEnd,
244		const uint8_t* buffer)
245	0	{
246	0	if (m_pBagDataset.expired())
247	0	throw DatasetNotFound{};
248
249	0	if (rowStart > rowEnd \|\| columnStart > columnEnd)
250	0	throw InvalidWriteSize{};
251
252	0	if (!buffer)
253	0	throw InvalidBuffer{};
254
255	0	this->writeProxy(rowStart, columnStart, rowEnd, columnEnd, buffer);
256	0	this->writeAttributesProxy();
257	0	}
258
259		//! Write the attributes this layer contains to disk.
260		void Layer::writeAttributes() const
261	0	{
262	0	if (m_pBagDataset.expired())
263	0	throw DatasetNotFound{};
264
265	0	this->writeAttributesProxy();
266	0	}
267
268		} // namespace BAG
269