vtkMRMLMarkupsJsonReader Class Reference

Reads a JSON file into a vtkMRMLMarkupsJsonElement. More...

#include <Modules/Loadable/Markups/MRML/vtkMRMLMarkupsJsonElement.h>

Inheritance diagram for vtkMRMLMarkupsJsonReader:

Collaboration diagram for vtkMRMLMarkupsJsonReader:

Public Types
typedef vtkObject	Superclass

Public Member Functions
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 vtkMRMLMarkupsJsonElement *	ReadFromFile (const char *filePath)

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

Protected Member Functions
void	operator= (const vtkMRMLMarkupsJsonReader &)
	vtkMRMLMarkupsJsonReader ()
	vtkMRMLMarkupsJsonReader (const vtkMRMLMarkupsJsonReader &)
	~vtkMRMLMarkupsJsonReader () override

Protected Attributes
vtkNew< vtkMRMLMessageCollection >	UserMessages

Detailed Description

Reads a JSON file into a vtkMRMLMarkupsJsonElement.

Definition at line 156 of file vtkMRMLMarkupsJsonElement.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkMRMLMarkupsJsonReader::Superclass

Definition at line 161 of file vtkMRMLMarkupsJsonElement.h.

Constructor & Destructor Documentation

vtkMRMLMarkupsJsonReader() [1/2]

vtkMRMLMarkupsJsonReader::vtkMRMLMarkupsJsonReader ( )

protected

~vtkMRMLMarkupsJsonReader()

vtkMRMLMarkupsJsonReader::~vtkMRMLMarkupsJsonReader ( )

overrideprotected

vtkMRMLMarkupsJsonReader() [2/2]

vtkMRMLMarkupsJsonReader::vtkMRMLMarkupsJsonReader ( const vtkMRMLMarkupsJsonReader & )

protected

Member Function Documentation

GetClassName()

virtual const char * vtkMRMLMarkupsJsonReader::GetClassName ( )

virtual

GetUserMessages()

virtual vtkMRMLMessageCollection * vtkMRMLMarkupsJsonReader::GetUserMessages ( )

virtual

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

HasErrors()

bool vtkMRMLMarkupsJsonReader::HasErrors

(

)

Returns true if user messages contain error messages.

IsA()

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

virtual

IsTypeOf()

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

static

New()

static vtkMRMLMarkupsJsonReader * vtkMRMLMarkupsJsonReader::New ( )

static

operator=()

void vtkMRMLMarkupsJsonReader::operator= ( const vtkMRMLMarkupsJsonReader & )

protected

PrintSelf()

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

override

ReadFromFile()

VTK_NEWINSTANCE vtkMRMLMarkupsJsonElement * vtkMRMLMarkupsJsonReader::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.

SafeDownCast()

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

static

Member Data Documentation

UserMessages

vtkNew<vtkMRMLMessageCollection> vtkMRMLMarkupsJsonReader::UserMessages

protected

Definition at line 182 of file vtkMRMLMarkupsJsonElement.h.

---

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

• Modules/Loadable/Markups/MRML/vtkMRMLMarkupsJsonElement.h