mitk::Forms::ScreenshotQuestion Class Reference

#include <mitkScreenshotQuestion.h>

Inheritance diagram for mitk::Forms::ScreenshotQuestion:

Collaboration diagram for mitk::Forms::ScreenshotQuestion:

Public Member Functions
	~ScreenshotQuestion () override
std::string	GetType () const override
	Return the type of a question as string, e.g. "Multiple choice" or "Drop-down". More...
Question *	CreateAnother () const override
	Create a new instance of the derived question class type. More...
void	FromJSON (const nlohmann::ordered_json &j) override
	Deserialize from JSON. More...
void	ToJSON (nlohmann::ordered_json &j) const override
	Serialize to JSON. More...
std::vector< std::string >	GetResponsesAsStrings () const override
	Return the question's response(s) as strings. More...
void	ClearResponses () override
	Clear the/all response(s). More...
bool	IsComplete () const override
	Check if a question is considered to be answered completely. More...
bool	HasFileResponses () const override
	Query whether the responses given to this question are file paths. More...
std::vector< fs::path >	SubmitFileResponses (const fs::path &basePath) const override
	Attach response files to submission. More...
void	AddScreenshot (const fs::path &path)
void	RemoveScreenshot (const fs::path &path)
Public Member Functions inherited from mitk::Forms::Question
	Question ()
virtual	~Question ()
std::string	GetQuestionText () const
	Get the literal question. More...
void	SetQuestionText (const std::string &question)
	Set the literal question. More...
bool	IsRequired () const
	Check whether a response to this question is required to complete a form. More...
void	SetRequired (bool required=true)
	Set whether a resonse to this question is required to complete a form. More...
virtual std::string	GetRequiredText () const
	Get the text that should be displayed to clearly mark a question as required. More...

Detailed Description

Definition at line 23 of file mitkScreenshotQuestion.h.

Constructor & Destructor Documentation

~ScreenshotQuestion()

mitk::Forms::ScreenshotQuestion::~ScreenshotQuestion ( )

override

Member Function Documentation

AddScreenshot()

void mitk::Forms::ScreenshotQuestion::AddScreenshot

(

const fs::path &

path

)

ClearResponses()

void mitk::Forms::ScreenshotQuestion::ClearResponses ( )

overridevirtual

Clear the/all response(s).

Implements mitk::Forms::Question.

CreateAnother()

Question* mitk::Forms::ScreenshotQuestion::CreateAnother ( ) const

overridevirtual

Create a new instance of the derived question class type.

This method is mainly used by IQuestionFactory to create new instances from registered prototype instances based on a type string.

Question* RhetoricalQuestion::CreateAnother() const
{
  return new RhetoricalQuestion;
}

See also

GetType()

Implements mitk::Forms::Question.

FromJSON()

void mitk::Forms::ScreenshotQuestion::FromJSON ( const nlohmann::ordered_json &  j )

overridevirtual

Deserialize from JSON.

Polymorphism and the use of base class pointers make it necessary to implement serialization through member functions. Using the pure native approach of the "JSON for Modern C++" library via free functions would lead to partially serialized instances of derived classes.

The actual implementation can and should still be located in a corresponding from_json() free function but we also need the indirection through this member function.

void RhetoricalQuestion::FromJSON(const nlohmann::ordered_json& j)
{
  from_json(j, *this);
}

See also

from_json(const nlohmann::ordered_json& j, Question& q)

Implements mitk::Forms::Question.

GetResponsesAsStrings()

std::vector<std::string> mitk::Forms::ScreenshotQuestion::GetResponsesAsStrings ( ) const

overridevirtual

Return the question's response(s) as strings.

This is the single common generic interface for retrieving responses from all types of questions. It is typically used to store responses in text-based formats like CSV.

It is implemented as vector since certain types of questions like a checkboxes question may support multiple responses. Otherwise, return a vector with a single element.

std::vector<std::string> RhetoricalQuestion::GetResponsesAsStrings() const
{
  return { m_Response };
}

Implements mitk::Forms::Question.

GetType()

std::string mitk::Forms::ScreenshotQuestion::GetType ( ) const

overridevirtual

Return the type of a question as string, e.g. "Multiple choice" or "Drop-down".

This method is essential for the deserialization of questions into their correct type, resp. derived class. The type string is used by IQuestionFactory to look up a registered prototype instance of a certain type to create another instance of it.

The type string does not have to match the class name or follow any other convention except for it must be unique amongst all question types. Prefer natural language like in the examples above in case it is used in a user interface to display a question's type.

std::string RhetoricalQuestion::GetType() const
{
  return "Rhetorical";
}

See also

CreateAnother()

Implements mitk::Forms::Question.

HasFileResponses()

bool mitk::Forms::ScreenshotQuestion::HasFileResponses ( ) const

overridevirtual

Query whether the responses given to this question are file paths.

Always returns false - override this method only if necessary. Typically used during submission to determine if any files should be attached.

See also

SubmitFileResponses()

Reimplemented from mitk::Forms::Question.

IsComplete()

bool mitk::Forms::ScreenshotQuestion::IsComplete ( ) const

overridevirtual

Check if a question is considered to be answered completely.

This method is typically called when IsRequired() returns true to determine whether the requirements are fulfilled.

Implements mitk::Forms::Question.

RemoveScreenshot()

void mitk::Forms::ScreenshotQuestion::RemoveScreenshot

(

const fs::path &

path

)

SubmitFileResponses()

std::vector<fs::path> mitk::Forms::ScreenshotQuestion::SubmitFileResponses ( const fs::path &  basePath ) const

overridevirtual

Attach response files to submission.

This method is supposed to be called during submission only if HasFileResponses() returns true. The given base path should then be used to copy any files. The returned paths should be relative to the base path and are used for submission instead of the return value of GetResponsesAsStrings().

See also

HasFileResponses()

Reimplemented from mitk::Forms::Question.

ToJSON()

void mitk::Forms::ScreenshotQuestion::ToJSON ( nlohmann::ordered_json &  j ) const

overridevirtual

Serialize to JSON.

Polymorphism and the use of base class pointers make it necessary to implement serialization through member functions. Using the pure native approach of the "JSON for Modern C++" library via free functions would lead to partially serialized instances of derived classes.

The actual implementation can and should still be located in a corresponding to_json() free function but we also need the indirection through this member function.

void RhetoricalQuestion::ToJSON(nlohmann::ordered_json& j) const
{
  to_json(j, *this);
}

See also

to_json(nlohmann::ordered_json& j, const Question& q)

Implements mitk::Forms::Question.

---

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

• mitkScreenshotQuestion.h