vtkMRMLJsonReader Class Reference

#include <Libs/MRML/Core/vtkMRMLJsonElement.h>

Inheritance diagram for vtkMRMLJsonReader:

Collaboration diagram for vtkMRMLJsonReader:

Public Types
typedef vtkObject	Superclass

Public Member Functions
std::string	ConvertJsonToXML (const std::string &jsonString, const std::string &nodeTagName)
virtual const char *	GetClassName ()
virtual vtkMRMLMessageCollection *	GetUserMessages ()
	Returns user-displayable messages that may contain details about any failed operation.
bool	HasErrors ()
	Returns true if user messages contain error messages.
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
VTK_NEWINSTANCE vtkMRMLJsonElement *	ReadFromFile (const char *filePath)
VTK_NEWINSTANCE vtkMRMLJsonElement *	ReadFromString (const std::string &jsonString)

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLJsonReader *	New ()
static vtkMRMLJsonReader *	SafeDownCast (vtkObject *o)

Protected Member Functions
void	operator= (const vtkMRMLJsonReader &)
std::string	processJsonElement (vtkMRMLJsonElement *jsonElement, const std::string &elementKey="")
	vtkMRMLJsonReader ()
	vtkMRMLJsonReader (const vtkMRMLJsonReader &)
	~vtkMRMLJsonReader () override

Protected Attributes
vtkNew< vtkMRMLMessageCollection >	UserMessages

Detailed Description

Definition at line 189 of file vtkMRMLJsonElement.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLJsonReader::Superclass

Definition at line 193 of file vtkMRMLJsonElement.h.

Constructor & Destructor Documentation

vtkMRMLJsonReader() [1/2]

vtkMRMLJsonReader::vtkMRMLJsonReader ( )

protected

~vtkMRMLJsonReader()

vtkMRMLJsonReader::~vtkMRMLJsonReader ( )

overrideprotected

vtkMRMLJsonReader() [2/2]

vtkMRMLJsonReader::vtkMRMLJsonReader ( const vtkMRMLJsonReader & )

protected

Member Function Documentation

ConvertJsonToXML()

std::string vtkMRMLJsonReader::ConvertJsonToXML	(	const std::string &	jsonString,
		const std::string &	nodeTagName )

Convert JSON to XML string return string

GetClassName()

virtual const char * vtkMRMLJsonReader::GetClassName ( )

virtual

Reimplemented in vtkMRMLMarkupsJsonReader.

GetUserMessages()

virtual vtkMRMLMessageCollection * vtkMRMLJsonReader::GetUserMessages ( )

virtual

Returns user-displayable messages that may contain details about any failed operation.

HasErrors()

bool vtkMRMLJsonReader::HasErrors

(

)

Returns true if user messages contain error messages.

IsA()

virtual int vtkMRMLJsonReader::IsA ( const char * type )

virtual

Reimplemented in vtkMRMLMarkupsJsonReader.

IsTypeOf()

static int vtkMRMLJsonReader::IsTypeOf ( const char * type )

static

New()

static vtkMRMLJsonReader * vtkMRMLJsonReader::New ( )

static

operator=()

void vtkMRMLJsonReader::operator= ( const vtkMRMLJsonReader & )

protected

PrintSelf()

void vtkMRMLJsonReader::PrintSelf ( ostream & os, vtkIndent indent )

override

processJsonElement()

std::string vtkMRMLJsonReader::processJsonElement ( vtkMRMLJsonElement * jsonElement, const std::string & elementKey = "" )

protected

ReadFromFile()

VTK_NEWINSTANCE vtkMRMLJsonElement * vtkMRMLJsonReader::ReadFromFile

(

const char *

filePath

)

Read JSON document from file.

Returns

JSON element on success and nullptr on failure. Only in C++: The caller must take ownership of the returned object.

ReadFromString()

VTK_NEWINSTANCE vtkMRMLJsonElement * vtkMRMLJsonReader::ReadFromString

(

const std::string &

jsonString

)

Read JSON document from file.

Returns

JSON element on success and nullptr on failure. Only in C++: The caller must take ownership of the returned object.

SafeDownCast()

static vtkMRMLJsonReader * vtkMRMLJsonReader::SafeDownCast ( vtkObject * o )

static

Member Data Documentation

UserMessages

vtkNew<vtkMRMLMessageCollection> vtkMRMLJsonReader::UserMessages

protected

Definition at line 226 of file vtkMRMLJsonElement.h.

---

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

• Libs/MRML/Core/vtkMRMLJsonElement.h