// -----------------------------------------------------------------------------
//
// -----------------------------------------------------------------------------
void readPipeline(QFilterParametersReader::Pointer paramsReader, FilterPipeline::Pointer pipeline)
{
FilterManager* filtManager = FilterManager::Instance();
QSettings* prefs = paramsReader->getPrefs();
prefs->beginGroup(DREAM3D::Settings::PipelineBuilderGroup);
bool ok = false;
int filterCount = prefs->value("Number_Filters").toInt(&ok);
prefs->endGroup();
if (false == ok) {filterCount = 0;}
for (int i = 0; i < filterCount; ++i)
{
QString gName = QString::number(i);
// Open the group to get the name of the filter then close again.
prefs->beginGroup(gName);
QString filterName = prefs->value("Filter_Name", "").toString();
prefs->endGroup();
// qDebug() << filterName;
IFilterFactory::Pointer factory = filtManager->getFactoryForFilter(filterName);
AbstractFilter::Pointer filter = factory->create();
if(NULL != filter.get())
{
filter->readFilterParameters(paramsReader.get(), i);
pipeline->pushBack(filter);
}
}
}
// -----------------------------------------------------------------------------
//
// -----------------------------------------------------------------------------
int QFilterParametersWriter::WritePipelineToFile(FilterPipeline::Pointer pipeline, const QString& filePath, const QString& name, QSettings::Format format, IObserver* obs)
{
if(NULL == pipeline.get())
{
if(NULL != obs)
{
PipelineMessage pm(QFilterParametersWriter::ClassName(), "FilterPipeline Object was NULL for writing", -1, PipelineMessage::Error);
obs->processPipelineMessage(pm);
}
return -1;
}
FilterPipeline::FilterContainerType& filters = pipeline->getFilterContainer();
QFilterParametersWriter::Pointer writer = QFilterParametersWriter::New();
// This will open the file, and write/update the initial group of settings like the name and DREAM3D Version
writer->openFile(filePath, format);
// Loop over each filter and write it's input parameters to the file
int count = filters.size();
int index = 0;
for(qint32 i = 0; i < count; ++i)
{
AbstractFilter::Pointer filter = filters.at(i);
if(NULL != filter.get())
{
index = filter->writeFilterParameters(writer.get(), index);
}
else
{
AbstractFilter::Pointer badFilter = AbstractFilter::New();
writer->openFilterGroup(badFilter.get(), i);
writer->writeValue("Unkown Filter", "ERROR: Filter instance was NULL within the PipelineFilterWidget instance. Report this error to the DREAM3D Developers");
writer->closeFilterGroup();
}
}
writer->setNumberOfFilters(index);
writer->setPipelineName(name);
writer->closeFile(); // Close the file
return 0;
}
// -----------------------------------------------------------------------------
//
// -----------------------------------------------------------------------------
int DataContainerReader::readExistingPipelineFromFile(hid_t fileId)
{
herr_t err = 0;
m_PipelineFromFile->clear();
H5FilterParametersReader::Pointer reader = H5FilterParametersReader::New();
// HDF5: Open the "Pipeline" Group
hid_t pipelineGroupId = H5Gopen(fileId, DREAM3D::StringConstants::PipelineGroupName.toLatin1().data(), H5P_DEFAULT);
reader->setPipelineGroupId(pipelineGroupId);
// Use QH5Lite to ask how many "groups" are in the "Pipeline Group"
QList<QString> groupList;
err = QH5Utilities::getGroupObjects(pipelineGroupId, H5Utilities::H5Support_GROUP, groupList);
// Loop over the items getting the "ClassName" attribute from each group
QString classNameStr = "";
for (int32_t i = 0; i < groupList.size(); i++)
{
QString ss = QString::number(i, 10);
err = QH5Lite::readStringAttribute(pipelineGroupId, ss, "ClassName", classNameStr);
if (err < 0)
{
qDebug() << "Filter Index = " << i;
}
// Instantiate a new filter using the FilterFactory based on the value of the className attribute
FilterManager* fm = FilterManager::Instance();
IFilterFactory::Pointer ff = fm->getFactoryForFilter(classNameStr);
if (NULL != ff.get())
{
AbstractFilter::Pointer filter = ff->create();
if (NULL != filter.get())
{
// Read the parameters
filter->readFilterParameters( reader.get(), i);
// Add filter to m_PipelineFromFile
m_PipelineFromFile->pushBack(filter);
}
}
}
err = H5Gclose(pipelineGroupId);
return err;
}
// -----------------------------------------------------------------------------
//
// -----------------------------------------------------------------------------
int H5FilterParametersWriter::WritePipelineToFile(FilterPipeline::Pointer pipeline, QString filePath, QString name, IObserver* obs)
{
if (NULL == pipeline.get())
{
if (NULL != obs)
{
PipelineMessage pm(H5FilterParametersWriter::ClassName(), "FilterPipeline Object was NULL for writing", -1, PipelineMessage::Error);
obs->processPipelineMessage(pm);
}
return -1;
}
QFileInfo fileInfo(filePath);
// WRITE THE PIPELINE TO THE HDF5 FILE
H5FilterParametersWriter::Pointer writer = H5FilterParametersWriter::New();
hid_t fileId = -1;
fileId = QH5Utilities::createFile(filePath);
if (fileId < 0)
{
if (NULL != obs)
{
PipelineMessage pm(H5FilterParametersWriter::ClassName(), "Output .dream3d file could not be created.", -1, PipelineMessage::Error);
obs->processPipelineMessage(pm);
}
return -1;
}
// This will make sure if we return early from this method that the HDF5 File is properly closed.
// This will also take care of making sure all groups and file ids are closed
// before this method returns.
HDF5ScopedFileSentinel scopedFileSentinel(&fileId, true);
// Write our File Version string to the Root "/" group
QH5Lite::writeStringAttribute(fileId, "/", DREAM3D::HDF5::FileVersionName, DREAM3D::HDF5::FileVersion);
QH5Lite::writeStringAttribute(fileId, "/", DREAM3D::HDF5::DREAM3DVersion, DREAM3DLib::Version::Complete() );
hid_t pipelineGroupId = QH5Utilities::createGroup(fileId, DREAM3D::StringConstants::PipelineGroupName);
scopedFileSentinel.addGroupId(&pipelineGroupId);
writer->setGroupId(pipelineGroupId);
FilterPipeline::FilterContainerType& filters = pipeline->getFilterContainer();
// Loop over each filter and write it's input parameters to the file
int count = filters.size();
int index = 0;
for (qint32 i = 0; i < count; ++i)
{
AbstractFilter::Pointer filter = filters.at(i);
if (NULL != filter.get())
{
index = filter->writeFilterParameters(writer.get(), index);
}
else
{
AbstractFilter::Pointer badFilter = AbstractFilter::New();
writer->openFilterGroup(badFilter.get(), i);
writer->writeValue("Unknown Filter", "ERROR: Filter instance was NULL within the PipelineFilterWidget instance. Report this error to the DREAM3D Developers");
writer->closeFilterGroup();
}
}
return 0;
}
// -----------------------------------------------------------------------------
//
// -----------------------------------------------------------------------------
FilterPipeline::Pointer JsonFilterParametersReader::ReadPipelineFromFile(QString filePath, IObserver* obs)
{
QFileInfo fInfo(filePath);
if (filePath.isEmpty() == true)
{
return FilterPipeline::NullPointer();
}
QFileInfo fi(filePath);
if (fi.exists() == false)
{
return FilterPipeline::NullPointer();
}
FilterManager* filtManager = FilterManager::Instance();
FilterFactory<EmptyFilter>::Pointer emptyFilterFactory = FilterFactory<EmptyFilter>::New();
filtManager->addFilterFactory("EmptyFilter", emptyFilterFactory);
JsonFilterParametersReader::Pointer reader = JsonFilterParametersReader::New();
int err = reader->openFile(filePath);
if (err < 0)
{
if (NULL != obs)
{
PipelineMessage pm(JsonFilterParametersReader::ClassName(), "File '" + fInfo.fileName() + "' could not be opened for reading.", -1, PipelineMessage::Error);
obs->processPipelineMessage(pm);
}
return FilterPipeline::NullPointer();
}
reader->openGroup(DREAM3D::Settings::PipelineBuilderGroup);
int filterCount = reader->readValue(DREAM3D::Settings::NumFilters, 0);
reader->closeGroup();
FilterPipeline::Pointer pipeline = FilterPipeline::New();
for (int i = 0; i < filterCount; ++i)
{
// Open the group to get the name of the filter then close again.
reader->openFilterGroup(NULL, i);
QString filterName = reader->readString(DREAM3D::Settings::FilterName, "");
reader->closeFilterGroup();
//qDebug() << "Group: " << gName << " FilterName: " << filterName;
if (filterName.isEmpty() == false)
{
IFilterFactory::Pointer factory = filtManager->getFactoryForFilter(filterName);
if (factory.get() != NULL)
{
AbstractFilter::Pointer filter = factory->create();
if (NULL != filter.get())
{
filter->readFilterParameters(reader.get(), i);
pipeline->pushBack(filter);
}
}
else // Could not find the filter because the specific name has not been registered. This could
// be due to a name change for the filter.
{
EmptyFilter::Pointer filter = EmptyFilter::New();
QString humanLabel = QString("UNKNOWN FILTER: ") + filterName;
filter->setHumanLabel(humanLabel);
filter->setOriginalFilterName(filterName);
pipeline->pushBack(filter);
if (NULL != obs)
{
QString ss = QObject::tr("An implementation for filter '%1' could not be located. Possible reasons include a name change of the filter, plugin not loading or a simple spelling mistake? A blank filter has been inserted in its place.").arg(filterName);
PipelineMessage pm(filterName, ss, -66066, PipelineMessage::Error);
pm.setPrefix("JsonFilterParametersReader::ReadPipelineFromFile()");
obs->processPipelineMessage(pm);
}
}
}
else
{
EmptyFilter::Pointer filter = EmptyFilter::New();
QString humanLabel = QString("MISSING FILTER: ") + filterName;
filter->setHumanLabel(humanLabel);
filter->setOriginalFilterName(filterName);
pipeline->pushBack(filter);
if (NULL != obs)
{
QString gName = QString::number(i);
QString ss = QObject::tr("A filter for index '%1' is missing in the file. Is the numbering of the filters correct in the pipeline file?").arg(gName);
PipelineMessage pm(filterName, ss, -66067, PipelineMessage::Error);
pm.setPrefix("JsonFilterParametersReader::ReadPipelineFromFile()");
obs->processPipelineMessage(pm);
}
}
}
return pipeline;
}
