vtkMRMLMarkupsJsonElement Class Reference

Represents a json object or list. More...

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

Inheritance diagram for vtkMRMLMarkupsJsonElement:

Collaboration diagram for vtkMRMLMarkupsJsonElement:

Public Types
typedef vtkMRMLJsonElement	Superclass
Public Types inherited from vtkMRMLJsonElement
typedef vtkObject	Superclass
enum	Type {   UNKNOWN = 0 , OBJECT = 1 , ARRAY = 2 , STRING = 3 ,   BOOL = 4 , INT = 5 , DOUBLE = 6 }

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
Public Member Functions inherited from vtkMRMLJsonElement
VTK_NEWINSTANCE vtkMRMLJsonElement *	GetArrayItem (int childItemIndex)
bool	GetArrayItemsStringProperty (const char *arrayName, const char *propertyName, std::vector< std::string > &propertyValues)
VTK_NEWINSTANCE vtkMRMLJsonElement *	GetArrayProperty (const char *arrayName)
int	GetArraySize ()
	Returns the number of elements in this array.
bool	GetBoolProperty (const char *propertyName)
	Get Boolean property value.
bool	GetBoolProperty (const char *propertyName, bool &propertyValue)
VTK_NEWINSTANCE vtkMRMLJsonElement *	GetChildMemberItem (int childItemIndex)
VTK_NEWINSTANCE vtkCodedEntry *	GetCodedEntryProperty (const char *propertyName)
VTK_NEWINSTANCE vtkDoubleArray *	GetDoubleArrayProperty (const char *propertyName)
double	GetDoubleProperty (const char *propertyName)
bool	GetDoubleProperty (const char *propertyName, double &propertyValue)
int	GetIntProperty (const char *propertyName)
bool	GetIntProperty (const char *propertyName, int &propertyValue)
bool	GetMatrix4x4Property (const char *propertyName, double v[16], bool flipRasLps)
Type	GetMemberType (const char *propertyName)
VTK_NEWINSTANCE vtkMRMLJsonElement *	GetObjectItem (int childItemIndex)
VTK_NEWINSTANCE vtkMRMLJsonElement *	GetObjectProperty (const char *objectName)
std::string	GetObjectPropertyNameByIndex (int childItemIndex)
	Get object member name by index.
int	GetObjectSize ()
	Returns the number of elements in this object.
std::string	GetSchema ()
	Get the JSON schema name.
std::string	GetStringProperty (const char *propertyName)
bool	GetStringProperty (const char *propertyName, std::string &propertyValue)
bool	GetStringVectorProperty (const char *propertyName, std::vector< std::string > &arrayValues)
Type	GetType ()
	Returns this element type.
virtual vtkMRMLMessageCollection *	GetUserMessages ()
	Returns user-displayable messages that may contain details about any failed operation.
bool	GetVectorProperty (const char *propertyName, double *v, int numberOfComponents=3)
bool	HasErrors ()
	Returns true if user messages contain error messages.
bool	HasMember (const char *propertyName)
	Returns true if the JSON object contains a member by this name.
bool	IsArray ()
	Returns true if this element is an array.
bool	IsObject ()
	Returns true if this element is an object.
void	PrintSelf (ostream &os, vtkIndent indent) override

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkMRMLMarkupsJsonElement *	New ()
static vtkMRMLMarkupsJsonElement *	SafeDownCast (vtkObject *o)
Static Public Member Functions inherited from vtkMRMLJsonElement
static int	IsTypeOf (const char *type)
static vtkMRMLJsonElement *	New ()
static vtkMRMLJsonElement *	SafeDownCast (vtkObject *o)

Protected Member Functions
	vtkMRMLMarkupsJsonElement ()
	~vtkMRMLMarkupsJsonElement () override=default
Protected Member Functions inherited from vtkMRMLJsonElement
void	operator= (const vtkMRMLJsonElement &)
	vtkMRMLJsonElement ()
	vtkMRMLJsonElement (const vtkMRMLJsonElement &)
	~vtkMRMLJsonElement () override

Additional Inherited Members
Static Public Attributes inherited from vtkMRMLJsonElement
static const std::string	XML_NAME_VALUE_SEPARATOR
static const std::string	XML_SEPARATOR
Protected Attributes inherited from vtkMRMLJsonElement
vtkInternal *	Internal
vtkNew< vtkMRMLMessageCollection >	UserMessages

Detailed Description

Represents a json object or list.

Deprecated

This class is empty and kept only for backward compatibility. The implementation has been moved to core MRML class vtkMRMLJsonElement.

Definition at line 27 of file vtkMRMLMarkupsJsonElement.h.

Member Typedef Documentation

Superclass

typedef vtkMRMLJsonElement vtkMRMLMarkupsJsonElement::Superclass

Definition at line 31 of file vtkMRMLMarkupsJsonElement.h.

Constructor & Destructor Documentation

vtkMRMLMarkupsJsonElement()

vtkMRMLMarkupsJsonElement::vtkMRMLMarkupsJsonElement ( )

inlineprotected

Definition at line 34 of file vtkMRMLMarkupsJsonElement.h.

~vtkMRMLMarkupsJsonElement()

vtkMRMLMarkupsJsonElement::~vtkMRMLMarkupsJsonElement ( )

overrideprotecteddefault

Member Function Documentation

GetClassName()

virtual const char * vtkMRMLMarkupsJsonElement::GetClassName ( )

virtual

Reimplemented from vtkMRMLJsonElement.

IsA()

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

virtual

Reimplemented from vtkMRMLJsonElement.

IsTypeOf()

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

static

New()

static vtkMRMLMarkupsJsonElement * vtkMRMLMarkupsJsonElement::New ( )

static

SafeDownCast()

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

static

---

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

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