#include <Modules/Loadable/Tables/Logic/vtkSlicerTablesReader.h>

Inheritance diagram for vtkSlicerTablesReader:

[legend]

Collaboration diagram for vtkSlicerTablesReader:

[legend]

Public Types
enum	{ PasswordRequestedEvent = vtkCommand::UserEvent + 181 }

typedef vtkMRMLFileReader	Superclass

Public Types inherited from vtkMRMLFileReader
typedef vtkMRMLFileIOHandler	Superclass

Public Types inherited from vtkMRMLFileIOHandler
typedef vtkObject	Superclass

Public Member Functions
double	CanLoadFileConfidence (const std::string &filePath) override
	.txt file is more likely a simple text file than a table, therefore lower confidence is returned.

virtual const char *	GetClassName ()

vtkSlicerTablesLogic *	GetTablesLogic ()

virtual int	IsA (const char *type)

bool	Load (vtkMRMLIOProperties *properties) override

void	SetTablesLogic (vtkSlicerTablesLogic *logic)

Public Member Functions inherited from vtkMRMLFileReader
void	AddLoadedNodeID (const std::string &nodeID)

virtual bool	CanLoadFile (const std::string &filePath)

void	ClearLoadedNodeIDs ()

virtual std::string	ExamineFileList (std::vector< std::string > &fileList, vtkMRMLIOProperties *ioProperties)

virtual double	ExamineFileListConfidence (std::vector< std::string > &fileList, vtkMRMLIOProperties *ioProperties)

virtual double	GetConfidenceForMatchingExtension ()

const std::vector< std::string > &	GetLoadedNodeIDs () const
	The nodes the last Load added, by node ID.

std::vector< std::string >	GetSupportedNameFilters (const std::string &filePath)

std::vector< std::string >	GetSupportedNameFilters (const std::string &filePath, int &longestExtensionMatch)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetConfidenceForMatchingExtension (double)

void	SetLoadedNodeIDs (const std::vector< std::string > &nodeIDs)

Public Member Functions inherited from vtkMRMLFileIOHandler
void	FillOptionsDescription (vtkMRMLIOProperties properties, vtkMRMLIOOptionsDescription description)

virtual std::string	GetDescription ()
	What to call this in a file dialog ("Volume", "Mimics project").

const std::vector< std::string > &	GetExtensions () const

vtkMRMLFileIOManager *	GetFileIOManager () const

virtual std::string	GetFileType ()

virtual std::string	GetMatchedExtension (const std::string &filePath) const
	The longest matching extension of filePath, or an empty string.

const std::vector< std::string > &	GetNameFilters () const

vtkMRMLIOProperties *	GetOptionDefaults ()

virtual void	GetOptionsDescription (vtkMRMLIOOptionsDescription *description)

std::string	GetOptionsDescriptionJSON (vtkMRMLIOProperties *properties)

void	GetOptionValues (vtkMRMLIOProperties properties, vtkMRMLIOProperties values)

vtkMRMLScene *	GetScene () const

vtkMRMLMessageCollection *	GetUserMessages () const

virtual bool	IsWriter () const
	Whether this writes rather than reads.

virtual bool	MatchesExtension (const std::string &filePath) const

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	SetDescription (std::string)

void	SetFileIOManager (vtkMRMLFileIOManager *manager)

virtual void	SetFileType (std::string)

void	SetNameFilters (const std::vector< std::string > &filters)
	The name filters, as Slicer writes them: "Mimics project (.mcs .mcs.gz)".

virtual void	SetScene (vtkMRMLScene *scene)
	Where the nodes go, and where messages for the user are collected.

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkSlicerTablesReader *	New ()

static vtkSlicerTablesReader *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileReader
static int	IsTypeOf (const char *type)

static vtkMRMLFileReader *	New ()

static vtkMRMLFileReader *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkMRMLFileIOHandler
static std::vector< std::string >	ExtensionsFromNameFilter (const std::string &nameFilter)
	The extensions named by a filter such as "Mimics project (.mcs .mcs.gz)".

static std::vector< std::string >	GetMatchingNameFilters (const std::string &filePath, const std::vector< std::string > &nameFilters, bool requireReadableFile, int *longestExtensionMatch=nullptr)

static int	IsTypeOf (const char *type)

static std::string	LongestMatchingExtension (const std::string &filePath, const std::vector< std::string > &extensions)

static std::vector< std::string >	NameFilterToWildcards (const std::string &nameFilter)

static vtkMRMLFileIOHandler *	New ()

static vtkMRMLFileIOHandler *	SafeDownCast (vtkObject *o)

static bool	WildcardMatch (const std::string &pattern, const std::string &text)
	Case-insensitive wildcard matching of the whole text. Supported wildcards: '*', '?', and character sets ("[abc]", "[!abc]").

Protected Member Functions
	vtkSlicerTablesReader ()

	~vtkSlicerTablesReader () override

Protected Member Functions inherited from vtkMRMLFileReader
	vtkMRMLFileReader ()

	~vtkMRMLFileReader () override

Protected Member Functions inherited from vtkMRMLFileIOHandler
	vtkMRMLFileIOHandler ()

	~vtkMRMLFileIOHandler () override

Protected Attributes
vtkWeakPointer< vtkSlicerTablesLogic >	TablesLogic

Protected Attributes inherited from vtkMRMLFileReader
double	ConfidenceForMatchingExtension { 0.5 }

std::vector< std::string >	LoadedNodeIDs

Protected Attributes inherited from vtkMRMLFileIOHandler
std::string	Description

std::vector< std::string >	Extensions

vtkWeakPointer< vtkMRMLFileIOManager >	FileIOManager

std::string	FileType

std::vector< std::string >	NameFilters

vtkNew< vtkMRMLIOProperties >	OptionDefaults

vtkWeakPointer< vtkMRMLScene >	Scene

vtkNew< vtkMRMLMessageCollection >	UserMessages

Additional Inherited Members
Static Protected Member Functions inherited from vtkMRMLFileReader
static bool	EndsWithNoCase (const std::string &text, const std::string &suffix)
	Returns true if the string ends with the suffix (case-insensitive).

static std::string	ReadFileHeader (const std::string &filePath, size_t maxLength)

Detailed Description

Reader of table files (text and SQLite database).

Properties: "fileName", "name", "password" (for SQLite databases).

If a SQLite database cannot be opened without a password and no password is specified in the properties then PasswordRequestedEvent is invoked. The call data is a pointer to a std::string, which the observer (for example, a password dialog) may set to the password.

Definition at line 41 of file vtkSlicerTablesReader.h.

Member Typedef Documentation

◆ Superclass

typedef vtkMRMLFileReader vtkSlicerTablesReader::Superclass

Definition at line 45 of file vtkSlicerTablesReader.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
PasswordRequestedEvent

Definition at line 47 of file vtkSlicerTablesReader.h.

Constructor & Destructor Documentation

◆ vtkSlicerTablesReader()

vtkSlicerTablesReader::vtkSlicerTablesReader ( )

protected

◆ ~vtkSlicerTablesReader()

vtkSlicerTablesReader::~vtkSlicerTablesReader ( )

overrideprotected

Member Function Documentation

◆ CanLoadFileConfidence()

double vtkSlicerTablesReader::CanLoadFileConfidence ( const std::string & filePath )

overridevirtual

.txt file is more likely a simple text file than a table, therefore lower confidence is returned.

Reimplemented from vtkMRMLFileReader.

◆ GetClassName()

virtual const char * vtkSlicerTablesReader::GetClassName ( )

virtual

Reimplemented from vtkMRMLFileReader.

◆ GetTablesLogic()

vtkSlicerTablesLogic * vtkSlicerTablesReader::GetTablesLogic ( )

◆ IsA()

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

virtual

Reimplemented from vtkMRMLFileReader.

◆ IsTypeOf()

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

static

◆ Load()

bool vtkSlicerTablesReader::Load ( vtkMRMLIOProperties * properties )

overridevirtual

Read the file specified by the "fileName" property into the scene. Loaded nodes are reported by AddLoadedNodeID(). Returns true on success. The base class reads nothing and returns false.

Reimplemented from vtkMRMLFileReader.

◆ New()

static vtkSlicerTablesReader * vtkSlicerTablesReader::New ( )

static

◆ SafeDownCast()

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

static

◆ SetTablesLogic()

void vtkSlicerTablesReader::SetTablesLogic ( vtkSlicerTablesLogic * logic )

Member Data Documentation

◆ TablesLogic

vtkWeakPointer<vtkSlicerTablesLogic> vtkSlicerTablesReader::TablesLogic

protected

Definition at line 64 of file vtkSlicerTablesReader.h.

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

Modules/Loadable/Tables/Logic/vtkSlicerTablesReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ vtkSlicerTablesReader()

◆ ~vtkSlicerTablesReader()

Member Function Documentation

◆ CanLoadFileConfidence()

◆ GetClassName()

◆ GetTablesLogic()

◆ IsA()

◆ IsTypeOf()

◆ Load()

◆ New()

◆ SafeDownCast()

◆ SetTablesLogic()

Member Data Documentation

◆ TablesLogic