Skip to content

shapeworks::ProjectReader

Base class for Project readers. More...

#include <ProjectReader.h>

Inherited by shapeworks::ExcelProjectReader, shapeworks::JsonProjectReader

Public Types

Name
using project::types::StringMapList StringMapList
using project::types::StringMap StringMap
using project::types::StringList StringList
using project::types::StringMultiMap StringMultiMap

Public Functions

Name
ProjectReader(Project & project)
Constructor.
virtual ~ProjectReader() =default
Destructor.
virtual bool read_project(std::string filename) =0
Read a project from a file.
virtual StringMap get_parameters(std::string name) =0
virtual StringMultiMap get_multi_parameters(std::string name) =0

Protected Functions

Name
void load_subjects(StringMapList list)
Load subjects from string map list.
void load_parameters()
void load_parameter(std::string name, StringMap map)
void load_landmark_definitions(StringMapList list)
bool contains(StringMap map, std::string key)
StringList get_keys(StringMap map)

Protected Attributes

Name
Project & project_

Detailed Description

cpp class shapeworks::ProjectReader;

Base class for Project readers.

This class serves as an abstract base class for project readers

Public Types Documentation

using StringMapList

cpp using shapeworks::ProjectReader::StringMapList = project::types::StringMapList;

using StringMap

cpp using shapeworks::ProjectReader::StringMap = project::types::StringMap;

using StringList

cpp using shapeworks::ProjectReader::StringList = project::types::StringList;

using StringMultiMap

cpp using shapeworks::ProjectReader::StringMultiMap = project::types::StringMultiMap;

Public Functions Documentation

function ProjectReader

cpp ProjectReader( Project & project )

Constructor.

function ~ProjectReader

cpp virtual ~ProjectReader() =default

Destructor.

function read_project

cpp virtual bool read_project( std::string filename ) =0

Read a project from a file.

Reimplemented by: shapeworks::ExcelProjectReader::read_project, shapeworks::JsonProjectReader::read_project

function get_parameters

cpp virtual StringMap get_parameters( std::string name ) =0

Reimplemented by: shapeworks::ExcelProjectReader::get_parameters, shapeworks::JsonProjectReader::get_parameters

function get_multi_parameters

cpp virtual StringMultiMap get_multi_parameters( std::string name ) =0

Reimplemented by: shapeworks::ExcelProjectReader::get_multi_parameters, shapeworks::JsonProjectReader::get_multi_parameters

Protected Functions Documentation

function load_subjects

cpp void load_subjects( StringMapList list )

Load subjects from string map list.

function load_parameters

cpp void load_parameters()

function load_parameter

cpp void load_parameter( std::string name, StringMap map )

function load_landmark_definitions

cpp void load_landmark_definitions( StringMapList list )

function contains

cpp bool contains( StringMap map, std::string key )

function get_keys

cpp static StringList get_keys( StringMap map )

Protected Attributes Documentation

variable project_

cpp Project & project_;


Updated on 2026-03-31 at 16:02:10 +0000