ProjectDocument Class Reference

Description

Project document class handles all data related to the opened project (sample, job, project specific settings).

It also provides signaling regarding changes in the current document data.

e.g. if project file is /home/users/development/Untitled/Untitled.pro projectName() - 'Untitled' projectDir() - '/home/users/development/Untitled projectFileName() - '/home/users/development/Untitled/Untitled.pro'

Definition at line 43 of file ProjectDocument.h.

Inheritance diagram for ProjectDocument:

Collaboration diagram for ProjectDocument:

Public Types
enum	Functionality {   None = 0x0 , Gisas = 0x1 , Offspec = 0x2 , Specular = 0x4 ,   DepthProbe = 0x8 , All = Gisas | Offspec | Specular | DepthProbe }
enum class	ReadResult { ok , warning , error }

Signals
void	functionalitiesChanged ()
	Emitted when functionality has changed. More...
void	modified ()
	Emitted for any modifications in the document. More...
void	singleInstrumentModeChanged ()
	Emitted when single instrument mode has changed. More...
void	singleSampleModeChanged ()
	Emitted when single sample mode has changed. More...

Public Member Functions
	ProjectDocument ()
void	clearModified ()
InstrumentCollection *	collectedItems () const
QString	documentVersion () const
Functionalities	functionalities () const
bool	hasData () const
bool	hasValidNameAndPath ()
InstrumentsEditController *	instrumentsEditController ()
	The edit controller for the instruments in this project document. More...
bool	isModified () const
JobModel *	jobModel () const
LinkInstrumentManager *	linkInstrumentManager ()
ReadResult	loadProjectFile (const QString &project_file_name, MessageService &messageService)
QString	projectDir () const
QString	projectFileName () const
QString	projectName () const
RealDataModel *	realDataModel () const
MultiLayerItems *	sampleItems ()
void	save (const QString &project_file_name, bool autoSave=false)
void	saveProjectData (const QString &project_file_name)
void	saveProjectFile (const QString &project_file_name, bool autoSave=false)
void	setFunctionalities (const Functionalities &f)
void	setModified ()
void	setProjectDir (const QString &text)
void	setProjectFileName (const QString &projectFileName)
void	setProjectName (const QString &text)
void	setSingleInstrumentMode (bool b)
void	setSingleSampleMode (bool b)
SimulationOptionsItem *	simulationOptionsItem ()
bool	singleInstrumentMode () const
bool	singleSampleMode () const
QString	userExportDir () const
	Returns directory name suitable for saving plots. More...
QString	validProjectDir () const

Private Member Functions
void	connectModels ()
void	disconnectModels ()
void	onModelChanged ()
ReadResult	readProject (QIODevice *device, MessageService &messageService)
void	writeTo (QIODevice *device)

Private Attributes
ApplicationModels	m_applicationModels
QString	m_currentVersion
DatafieldIOService *	m_dataService
Functionalities	m_functionalities
InstrumentsEditController	m_instrumentEditController
InstrumentCollection	m_instruments
std::unique_ptr< LinkInstrumentManager >	m_linkManager
bool	m_modified
QString	m_project_dir
QString	m_project_name
MultiLayerItems	m_sampleItems
SimulationOptionsItem	m_simulationOptionsItem
bool	m_singleInstrumentMode
bool	m_singleSampleMode

Member Enumeration Documentation

Functionality

enum ProjectDocument::Functionality

Enumerator
None
Gisas
Offspec
Specular
DepthProbe
All

Definition at line 49 of file ProjectDocument.h.

                       {
        None = 0x0,
        Gisas = 0x1,
        Offspec = 0x2,
        Specular = 0x4,
        DepthProbe = 0x8,
        All = Gisas | Offspec | Specular | DepthProbe
    };

ReadResult

enum ProjectDocument::ReadResult

strong

Enumerator
ok
warning
error

Definition at line 47 of file ProjectDocument.h.

{ ok, warning, error };

Constructor & Destructor Documentation

ProjectDocument()

ProjectDocument::ProjectDocument

(

)

Definition at line 53 of file ProjectDocument.cpp.

    : m_modified(false)
    , m_dataService(new DatafieldIOService(this))
    , m_singleInstrumentMode(false)
    , m_singleSampleMode(false)
    , m_functionalities(All)
    , m_instrumentEditController(&m_instruments)
{
    connect(&m_instrumentEditController, &InstrumentsEditController::instrumentAddedOrRemoved, this,
            &ProjectDocument::onModelChanged, Qt::UniqueConnection);
    connect(&m_instrumentEditController, &InstrumentsEditController::instrumentChanged, this,
            &ProjectDocument::onModelChanged, Qt::UniqueConnection);
 
 
    m_linkManager = std::make_unique<LinkInstrumentManager>(this);
    setObjectName("ProjectDocument");
 
    m_dataService->setApplicationModels(&m_applicationModels);
    connectModels();
}

References connectModels(), InstrumentsEditController::instrumentAddedOrRemoved(), InstrumentsEditController::instrumentChanged(), m_applicationModels, m_dataService, m_instrumentEditController, m_linkManager, onModelChanged(), and DatafieldIOService::setApplicationModels().

Here is the call graph for this function:

Member Function Documentation

clearModified()

void ProjectDocument::clearModified

(

)

Definition at line 247 of file ProjectDocument.cpp.

{
    m_modified = false;
}

References m_modified.

collectedItems()

InstrumentCollection * ProjectDocument::collectedItems

(

)

const

Definition at line 126 of file ProjectDocument.cpp.

{
    return const_cast<InstrumentCollection*>(&m_instruments);
}

References m_instruments.

Referenced by LinkInstrumentManager::canLinkDataToInstrument(), SimulationView::collectedItems(), LinkInstrumentManager::onInstrumentAddedOrRemoved(), RealDataPropertiesWidget::onInstrumentComboIndexChanged(), ProjectSettingsView::onSingleInstrumentRadioToggled(), RealDataPropertiesWidget::updateInstrumentComboEntries(), and SimulationView::writeOptionsToUI().

connectModels()

void ProjectDocument::connectModels ( )

private

Definition at line 435 of file ProjectDocument.cpp.

{
    connect(&m_applicationModels, &ApplicationModels::modelChanged, this,
            &ProjectDocument::onModelChanged, Qt::UniqueConnection);
}

References m_applicationModels, ApplicationModels::modelChanged(), and onModelChanged().

Referenced by ProjectDocument(), and loadProjectFile().

Here is the call graph for this function:

disconnectModels()

void ProjectDocument::disconnectModels ( )

private

Definition at line 429 of file ProjectDocument.cpp.

{
    disconnect(&m_applicationModels, &ApplicationModels::modelChanged, this,
               &ProjectDocument::onModelChanged);
}

References m_applicationModels, ApplicationModels::modelChanged(), and onModelChanged().

Referenced by loadProjectFile().

Here is the call graph for this function:

documentVersion()

QString ProjectDocument::documentVersion

(

)

const

Definition at line 257 of file ProjectDocument.cpp.

{
    QString result(m_currentVersion);
    if (result.isEmpty())
        result = GUI::Util::Path::getBornAgainVersionString();
    return result;
}

References GUI::Util::Path::getBornAgainVersionString(), and m_currentVersion.

Here is the call graph for this function:

functionalities()

ProjectDocument::Functionalities ProjectDocument::functionalities

(

)

const

Definition at line 295 of file ProjectDocument.cpp.

{
    return m_functionalities;
}

References m_functionalities.

Referenced by InstrumentListView::onLoadFromLibrary(), InstrumentListView::onStoreInLibrary(), RealDataSelectorWidget::updateFunctionalities(), ImportDataView::updateFunctionalityNarrowing(), InstrumentListView::updateFunctionalityNarrowing(), and ProjectSettingsView::writeFunctionalityToUI().

functionalitiesChanged

void ProjectDocument::functionalitiesChanged ( )

signal

Emitted when functionality has changed.

Referenced by setFunctionalities().

hasData()

bool ProjectDocument::hasData

(

)

const

Definition at line 252 of file ProjectDocument.cpp.

{
    return !m_dataService->dataInterfaces().isEmpty();
}

References DatafieldIOService::dataInterfaces(), and m_dataService.

Referenced by SaveService::process_queue().

Here is the call graph for this function:

hasValidNameAndPath()

bool ProjectDocument::hasValidNameAndPath

(

)

Definition at line 231 of file ProjectDocument.cpp.

{
    return (!m_project_name.isEmpty() && !m_project_dir.isEmpty());
}

References m_project_dir, and m_project_name.

Referenced by AutosaveController::assureAutoSaveDirExists(), AutosaveController::autosaveDir(), AutosaveController::autosaveName(), AutosaveController::onDocumentModified(), and ProjectSettingsView::updateInformation().

instrumentsEditController()

InstrumentsEditController * ProjectDocument::instrumentsEditController

(

)

The edit controller for the instruments in this project document.

Use this to modify instrument list or instrument data. Listen to its signals to get notification about any changes.

See also

InstrumentsEditController for more information

Definition at line 156 of file ProjectDocument.cpp.

{
    return &m_instrumentEditController;
}

References m_instrumentEditController.

Referenced by InstrumentListView::InstrumentListView(), LinkInstrumentManager::LinkInstrumentManager(), RealDataPropertiesWidget::RealDataPropertiesWidget(), LinkInstrumentManager::canLinkDataToInstrument(), InstrumentView::createWidgetsForCurrentInstrument(), InstrumentView::hideEvent(), InstrumentView::onInstrumentChangedByEditor(), InstrumentView::onInstrumentNameEdited(), and InstrumentView::showEvent().

isModified()

bool ProjectDocument::isModified

(

)

const

Definition at line 236 of file ProjectDocument.cpp.

{
    return m_modified;
}

References m_modified.

Referenced by AutosaveController::onDocumentModified(), and AutosaveController::onTimerTimeout().

jobModel()

JobModel * ProjectDocument::jobModel

(

)

const

Definition at line 141 of file ProjectDocument.cpp.

{
    return m_applicationModels.jobModel();
}

References ApplicationModels::jobModel(), and m_applicationModels.

Referenced by SessionModelView::SessionModelView(), JobView::connectJobRelated(), JobView::createSubWindows(), and SimulationView::simulate().

Here is the call graph for this function:

linkInstrumentManager()

LinkInstrumentManager * ProjectDocument::linkInstrumentManager

(

)

Definition at line 151 of file ProjectDocument.cpp.

{
    return m_linkManager.get();
}

References m_linkManager.

Referenced by RealDataPropertiesWidget::RealDataPropertiesWidget(), and RealDataPropertiesWidget::onInstrumentComboIndexChanged().

loadProjectFile()

ProjectDocument::ReadResult ProjectDocument::loadProjectFile	(	const QString &	project_file_name,
		MessageService &	messageService
	)

Definition at line 199 of file ProjectDocument.cpp.

{
    setProjectFileName(project_file_name);
 
    QFile file(projectFileName());
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text)) {
        QString message = QString("Open file error '%1'").arg(file.errorString());
        messageService.addError(this, message);
        return ReadResult::error;
    }
 
    try {
        disconnectModels();
        auto result = readProject(&file, messageService);
        file.close();
        if (result == ReadResult::error)
            return result;
 
        m_dataService->loadDataFiles(projectDir(), &messageService);
        connectModels();
 
        if (!messageService.warnings().empty())
            result = ReadResult::warning;
        return result;
    } catch (const std::exception& ex) {
        QString message = QString("Exception thrown '%1'").arg(QString(ex.what()));
        messageService.addError(this, message);
        return ReadResult::error;
    }
}

References MessageService::addError(), connectModels(), disconnectModels(), error, DatafieldIOService::loadDataFiles(), m_dataService, projectDir(), projectFileName(), readProject(), setProjectFileName(), warning, and MessageService::warnings().

Here is the call graph for this function:

modified

void ProjectDocument::modified ( )

signal

Emitted for any modifications in the document.

Referenced by ImportDataView::ImportDataView(), InstrumentListView::InstrumentListView(), ProjectSettingsView::ProjectSettingsView(), RealDataSelectorWidget::RealDataSelectorWidget(), SimulationView::SimulationView(), ProjectManager::createNewProject(), onModelChanged(), saveProjectFile(), AutosaveController::setDocument(), setFunctionalities(), setModified(), setProjectName(), setSingleInstrumentMode(), and setSingleSampleMode().

onModelChanged()

void ProjectDocument::onModelChanged ( )

private

Definition at line 310 of file ProjectDocument.cpp.

{
    m_modified = true;
    emit modified();
}

References m_modified, and modified().

Referenced by ProjectDocument(), connectModels(), and disconnectModels().

projectDir()

QString ProjectDocument::projectDir

(

)

const

Definition at line 87 of file ProjectDocument.cpp.

{
    return m_project_dir;
}

References m_project_dir.

Referenced by AutosaveController::assureAutoSaveDirExists(), loadProjectFile(), and projectFileName().

projectFileName()

QString ProjectDocument::projectFileName

(

)

const

Definition at line 113 of file ProjectDocument.cpp.

{
    if (!projectName().isEmpty())
        return projectDir() + "/" + projectName() + GUI::Project::Utils::projectFileExtension;
    return "";
}

References projectDir(), GUI::Project::Utils::projectFileExtension, and projectName().

Referenced by AutosaveController::autosaveDir(), AutosaveController::autosaveName(), loadProjectFile(), setProjectFileName(), and ProjectSettingsView::updateInformation().

Here is the call graph for this function:

projectName()

QString ProjectDocument::projectName

(

)

const

Definition at line 74 of file ProjectDocument.cpp.

{
    return m_project_name;
}

References m_project_name.

Referenced by projectFileName(), ProjectSettingsView::updateInformation(), and writeTo().

readProject()

ProjectDocument::ReadResult ProjectDocument::readProject ( QIODevice *  device, MessageService &  messageService  )

private

Definition at line 316 of file ProjectDocument.cpp.

{
    const int warningsBefore = messageService.warnings().size();
 
    QXmlStreamReader reader(device);
    try {
        while (!reader.atEnd()) {
            reader.readNext();
            if (reader.isStartElement()) {
                if (reader.name() == BornAgainTag) {
                    Streamer(&reader).assertVersion(2);
                    m_currentVersion =
                        reader.attributes().value(BornAgainVersionAttribute).toString();
 
                    if (!GUI::Util::Path::isVersionMatchMinimal(m_currentVersion,
                                                                minimal_supported_version)) {
                        QString message = QString("Can't open document version '%1', "
                                                  "minimal supported version '%2'")
                                              .arg(m_currentVersion)
                                              .arg(minimal_supported_version);
                        messageService.addError(this, message);
                        return ReadResult::error;
                    }
 
                    while (reader.readNextStartElement())
                        if (reader.name() == InfoTag)
                            reader.skipCurrentElement();
                        else if (reader.name() == SimulationOptionsTag) {
                            m_simulationOptionsItem.readContentFrom(&reader);
                            reader.skipCurrentElement();
                            GUI::Session::XML::assertExpectedTag(&reader, SimulationOptionsTag);
                        } else if (reader.name() == SamplesTag) {
                            Streamer s(&reader);
                            m_sampleItems.serialize(s);
                            // cleanup
                            if (reader.name() != SamplesTag) {
                                if (!reader.isEndElement())
                                    reader.skipCurrentElement();
                                reader.skipCurrentElement();
                            }
                            GUI::Session::XML::assertExpectedTag(&reader, SamplesTag);
                            ASSERT(reader.isEndElement());
 
                            GUI::Session::XML::assertExpectedTag(&reader, SamplesTag);
                        } else if (reader.name() == InstrumentsTag) {
                            Streamer s(&reader);
                            m_instruments.serialize(s);
                            // cleanup
                            if (reader.name() != InstrumentsTag) {
                                if (!reader.isEndElement())
                                    reader.skipCurrentElement();
                                reader.skipCurrentElement();
                            }
                            GUI::Session::XML::assertExpectedTag(&reader, InstrumentsTag);
                            ASSERT(reader.isEndElement());
 
                            GUI::Session::XML::assertExpectedTag(&reader, InstrumentsTag);
                        } else
                            m_applicationModels.readFrom(&reader, &messageService);
                }
            }
        }
 
    } catch (DeserializationException& ex) {
        reader.raiseError(ex.text());
    }
 
    if (reader.hasError()) {
        QString message = QString("Format error '%1'").arg(reader.errorString());
        messageService.addError(this, message);
        return ReadResult::error;
    }
 
    // return "ReadResult::warning" only if warnings have been issued _in here_
    return warningsBefore != messageService.warnings().size() ? ReadResult::warning
                                                              : ReadResult::ok;
}

References MessageService::addError(), GUI::Session::XML::assertExpectedTag(), Streamer::assertVersion(), error, GUI::Util::Path::isVersionMatchMinimal(), m_applicationModels, m_currentVersion, m_instruments, m_sampleItems, m_simulationOptionsItem, ok, SimulationOptionsItem::readContentFrom(), ApplicationModels::readFrom(), InstrumentCollection::serialize(), MultiLayerItems::serialize(), DeserializationException::text(), warning, and MessageService::warnings().

Referenced by loadProjectFile().

Here is the call graph for this function:

realDataModel()

RealDataModel * ProjectDocument::realDataModel

(

)

const

Definition at line 136 of file ProjectDocument.cpp.

{
    return m_applicationModels.realDataModel();
}

References m_applicationModels, and ApplicationModels::realDataModel().

Referenced by ImportDataView::ImportDataView(), SessionModelView::SessionModelView(), LinkInstrumentManager::onInstrumentAddedOrRemoved(), LinkInstrumentManager::onInstrumentChanged(), SimulationView::realDataItems(), saveProjectData(), and SimulationView::writeOptionsToUI().

Here is the call graph for this function:

sampleItems()

MultiLayerItems * ProjectDocument::sampleItems

(

)

Definition at line 131 of file ProjectDocument.cpp.

{
    return &m_sampleItems;
}

References m_sampleItems.

Referenced by SampleListView::SampleListView(), ProjectSettingsView::onSingleSampleRadioToggled(), SimulationView::sampleItems(), SampleListView::selectFirstSample(), and SimulationView::writeOptionsToUI().

save()

void ProjectDocument::save	(	const QString &	project_file_name,
		bool	autoSave = false
	)

Definition at line 161 of file ProjectDocument.cpp.

{
    saveProjectData(project_file_name);
    saveProjectFile(project_file_name, autoSave);
}

References saveProjectData(), and saveProjectFile().

Here is the call graph for this function:

saveProjectData()

void ProjectDocument::saveProjectData

(

const QString &

project_file_name

)

Definition at line 188 of file ProjectDocument.cpp.

{
    for (auto* d : realDataModel()->realDataItems())
        d->updateNonXMLDataFileNames();
 
    QElapsedTimer timer;
    timer.start();
 
    m_dataService->save(GUI::Project::Utils::projectDir(project_file_name));
}

References m_dataService, GUI::Project::Utils::projectDir(), realDataModel(), and DatafieldIOService::save().

Referenced by SaveThread::run(), and save().

Here is the call graph for this function:

saveProjectFile()

void ProjectDocument::saveProjectFile	(	const QString &	project_file_name,
		bool	autoSave = false
	)

Definition at line 167 of file ProjectDocument.cpp.

{
    QElapsedTimer timer;
    timer.start();
 
    QFile file(project_file_name);
    if (!file.open(QFile::ReadWrite | QIODevice::Truncate | QFile::Text))
        throw Error("ProjectDocument::save_project_file() -> Error. Can't open "
                    "file '"
                    + project_file_name + "' for writing.");
 
    writeTo(&file);
    file.close();
 
    if (!autoSave) {
        setProjectFileName(project_file_name);
        m_modified = false;
        emit modified();
    }
}

References Error, m_modified, modified(), setProjectFileName(), and writeTo().

Referenced by SaveService::process_queue(), and save().

Here is the call graph for this function:

setFunctionalities()

void ProjectDocument::setFunctionalities

(

const Functionalities &

f

)

Definition at line 300 of file ProjectDocument.cpp.

{
    if (m_functionalities != f) {
        m_functionalities = f;
        emit modified();
        emit functionalitiesChanged();
        setModified();
    }
}

References functionalitiesChanged(), m_functionalities, modified(), and setModified().

Referenced by ProjectSettingsView::onFunctionalityToggled().

Here is the call graph for this function:

setModified()

void ProjectDocument::setModified

(

)

Definition at line 241 of file ProjectDocument.cpp.

{
    m_modified = true;
    emit modified();
}

References m_modified, and modified().

Referenced by SampleView::SampleView(), SampleListView::createNewSample(), SampleListView::createSampleFromLibrary(), SampleListView::importSampleFromPython(), SampleListView::removeSample(), setFunctionalities(), setSingleInstrumentMode(), and setSingleSampleMode().

setProjectDir()

void ProjectDocument::setProjectDir

(

const QString &

text

)

Definition at line 99 of file ProjectDocument.cpp.

{
    m_project_dir = text;
}

References m_project_dir.

Referenced by setProjectFileName().

setProjectFileName()

void ProjectDocument::setProjectFileName

(

const QString &

projectFileName

)

Definition at line 120 of file ProjectDocument.cpp.

{
    setProjectName(GUI::Project::Utils::projectName(projectFileName));
    setProjectDir(GUI::Project::Utils::projectDir(projectFileName));
}

References GUI::Project::Utils::projectDir(), projectFileName(), GUI::Project::Utils::projectName(), setProjectDir(), and setProjectName().

Referenced by loadProjectFile(), and saveProjectFile().

Here is the call graph for this function:

setProjectName()

void ProjectDocument::setProjectName

(

const QString &

text

)

Definition at line 79 of file ProjectDocument.cpp.

{
    if (m_project_name != text) {
        m_project_name = text;
        emit modified();
    }
}

References m_project_name, and modified().

Referenced by setProjectFileName().

setSingleInstrumentMode()

void ProjectDocument::setSingleInstrumentMode

(

bool

b

)

Definition at line 270 of file ProjectDocument.cpp.

{
    if (b != m_singleInstrumentMode) {
        m_singleInstrumentMode = b;
        emit modified();
        emit singleInstrumentModeChanged();
        setModified();
    }
}

References m_singleInstrumentMode, modified(), setModified(), and singleInstrumentModeChanged().

Referenced by ProjectSettingsView::onSingleInstrumentRadioToggled().

Here is the call graph for this function:

setSingleSampleMode()

void ProjectDocument::setSingleSampleMode

(

bool

b

)

Definition at line 285 of file ProjectDocument.cpp.

{
    if (b != m_singleSampleMode) {
        m_singleSampleMode = b;
        emit modified();
        emit singleSampleModeChanged();
        setModified();
    }
}

References m_singleSampleMode, modified(), setModified(), and singleSampleModeChanged().

Referenced by ProjectSettingsView::onSingleSampleRadioToggled().

Here is the call graph for this function:

simulationOptionsItem()

SimulationOptionsItem * ProjectDocument::simulationOptionsItem

(

)

Definition at line 146 of file ProjectDocument.cpp.

{
    return &m_simulationOptionsItem;
}

References m_simulationOptionsItem.

Referenced by SimulationView::optionsItem().

singleInstrumentMode()

bool ProjectDocument::singleInstrumentMode

(

)

const

Definition at line 265 of file ProjectDocument.cpp.

{
    return m_singleInstrumentMode;
}

References m_singleInstrumentMode.

Referenced by InstrumentListView::updateFunctionalityNarrowing(), SimulationView::updateFunctionalityNarrowing(), InstrumentView::updateSingleInstrumentMode(), and ProjectSettingsView::writeOptionsToUI().

singleInstrumentModeChanged

void ProjectDocument::singleInstrumentModeChanged ( )

signal

Emitted when single instrument mode has changed.

Referenced by InstrumentView::InstrumentView(), and setSingleInstrumentMode().

singleSampleMode()

bool ProjectDocument::singleSampleMode

(

)

const

Definition at line 280 of file ProjectDocument.cpp.

{
    return m_singleSampleMode;
}

References m_singleSampleMode.

Referenced by SampleView::resetLayout(), SampleView::updateSingleSampleMode(), and ProjectSettingsView::writeOptionsToUI().

singleSampleModeChanged

void ProjectDocument::singleSampleModeChanged ( )

signal

Emitted when single sample mode has changed.

Referenced by SampleView::SampleView(), and setSingleSampleMode().

userExportDir()

QString ProjectDocument::userExportDir

(

)

const

Returns directory name suitable for saving plots.

Definition at line 106 of file ProjectDocument.cpp.

{
    if (QString dir = validProjectDir(); !dir.isEmpty())
        return dir;
    return QStandardPaths::writableLocation(QStandardPaths::HomeLocation);
}

References validProjectDir().

Here is the call graph for this function:

validProjectDir()

QString ProjectDocument::validProjectDir

(

)

const

Definition at line 92 of file ProjectDocument.cpp.

{
    if (m_project_name.isEmpty())
        return "";
    return m_project_dir;
}

References m_project_dir, and m_project_name.

Referenced by userExportDir().

writeTo()

void ProjectDocument::writeTo ( QIODevice *  device )

private

Definition at line 395 of file ProjectDocument.cpp.

{
    QXmlStreamWriter writer(device);
    writer.setAutoFormatting(true);
    writer.writeStartDocument();
    writer.writeStartElement(BornAgainTag);
    QString version_string = GUI::Util::Path::getBornAgainVersionString();
    writer.writeAttribute(BornAgainVersionAttribute, version_string);
    Streamer(&writer).writeVersion(2);
 
    writer.writeStartElement(InfoTag);
    writer.writeAttribute(InfoNameAttribute, projectName());
    writer.writeEndElement(); // InfoTag
 
    writer.writeStartElement(SimulationOptionsTag);
    m_simulationOptionsItem.writeContentTo(&writer);
    writer.writeEndElement();
 
    writer.writeStartElement(SamplesTag);
    Streamer s(&writer);
    m_sampleItems.serialize(s);
    writer.writeEndElement();
 
    writer.writeStartElement(InstrumentsTag);
    Streamer sInstruments(&writer);
    m_instruments.serialize(sInstruments);
    writer.writeEndElement();
 
    m_applicationModels.writeTo(&writer);
 
    writer.writeEndElement(); // BornAgain tag
    writer.writeEndDocument();
}

References GUI::Util::Path::getBornAgainVersionString(), m_applicationModels, m_instruments, m_sampleItems, m_simulationOptionsItem, projectName(), InstrumentCollection::serialize(), MultiLayerItems::serialize(), SimulationOptionsItem::writeContentTo(), ApplicationModels::writeTo(), and Streamer::writeVersion().

Referenced by saveProjectFile().

Here is the call graph for this function:

Member Data Documentation

m_applicationModels

ApplicationModels ProjectDocument::m_applicationModels

private

Definition at line 137 of file ProjectDocument.h.

Referenced by ProjectDocument(), connectModels(), disconnectModels(), jobModel(), readProject(), realDataModel(), and writeTo().

m_currentVersion

QString ProjectDocument::m_currentVersion

private

Definition at line 139 of file ProjectDocument.h.

Referenced by documentVersion(), and readProject().

m_dataService

DatafieldIOService* ProjectDocument::m_dataService

private

Definition at line 140 of file ProjectDocument.h.

Referenced by ProjectDocument(), hasData(), loadProjectFile(), and saveProjectData().

m_functionalities

Functionalities ProjectDocument::m_functionalities

private

Definition at line 144 of file ProjectDocument.h.

Referenced by functionalities(), and setFunctionalities().

m_instrumentEditController

InstrumentsEditController ProjectDocument::m_instrumentEditController

private

Definition at line 147 of file ProjectDocument.h.

Referenced by ProjectDocument(), and instrumentsEditController().

m_instruments

InstrumentCollection ProjectDocument::m_instruments

private

Definition at line 148 of file ProjectDocument.h.

Referenced by collectedItems(), readProject(), and writeTo().

m_linkManager

std::unique_ptr<LinkInstrumentManager> ProjectDocument::m_linkManager

private

Definition at line 141 of file ProjectDocument.h.

Referenced by ProjectDocument(), and linkInstrumentManager().

m_modified

bool ProjectDocument::m_modified

private

Definition at line 138 of file ProjectDocument.h.

Referenced by clearModified(), isModified(), onModelChanged(), saveProjectFile(), and setModified().

m_project_dir

QString ProjectDocument::m_project_dir

private

Definition at line 135 of file ProjectDocument.h.

Referenced by hasValidNameAndPath(), projectDir(), setProjectDir(), and validProjectDir().

m_project_name

QString ProjectDocument::m_project_name

private

Definition at line 136 of file ProjectDocument.h.

Referenced by hasValidNameAndPath(), projectName(), setProjectName(), and validProjectDir().

m_sampleItems

MultiLayerItems ProjectDocument::m_sampleItems

private

Definition at line 146 of file ProjectDocument.h.

Referenced by readProject(), sampleItems(), and writeTo().

m_simulationOptionsItem

SimulationOptionsItem ProjectDocument::m_simulationOptionsItem

private

Definition at line 145 of file ProjectDocument.h.

Referenced by readProject(), simulationOptionsItem(), and writeTo().

m_singleInstrumentMode

bool ProjectDocument::m_singleInstrumentMode

private

Definition at line 142 of file ProjectDocument.h.

Referenced by setSingleInstrumentMode(), and singleInstrumentMode().

m_singleSampleMode

bool ProjectDocument::m_singleSampleMode

private

Definition at line 143 of file ProjectDocument.h.

Referenced by setSingleSampleMode(), and singleSampleMode().

---

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

• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/ProjectDocument.h
• /home/build/builds/o5h8MZZm/0/mlz/bornagain/GUI/Model/Project/ProjectDocument.cpp