pqLoadDataReaction Class Reference

Reaction for open data files. More...

#include <pqLoadDataReaction.h>

Inheritance diagram for pqLoadDataReaction:

Collaboration diagram for pqLoadDataReaction:

Public Slots
void	updateEnableState () override
	Updates the enabled state. More...

Signals
void	loadedData (pqPipelineSource *)
	Fired when a dataset is loaded by this reaction. More...

Public Member Functions
	pqLoadDataReaction (QAction *parent)
	Constructor. More...
Public Member Functions inherited from pqReaction
	pqReaction (QAction *parent, Qt::ConnectionType type=Qt::AutoConnection)
	Constructor. More...
	~pqReaction () override
QAction *	parentAction () const
	Provides access to the parent action. More...

Static Public Member Functions
static pqPipelineSource *	loadData (const QList< QStringList > &files, const QString &readergroup=QString(), const QString &readername=QString(), pqServer *server=NULL)
	Loads multiple data files. More...
static pqPipelineSource *	loadData (const QStringList &files, const QString &readergroup=QString(), const QString &readername=QString(), pqServer *server=NULL)
	Loads data files. More...
static QList< pqPipelineSource * >	loadData ()

Protected Member Functions
void	onTriggered () override
	Called when the action is triggered. More...

Static Protected Member Functions
static bool	TestFileReadability (const QString &file, pqServer *server, vtkSMReaderFactory *factory)
static bool	DetermineFileReader (const QString &filename, pqServer *server, vtkSMReaderFactory *factory, QPair< QString, QString > &readerInfo)
static pqPipelineSource *	LoadFile (const QStringList &files, pqServer *server, const QPair< QString, QString > &readerInfo)

Additional Inherited Members
Protected Slots inherited from pqReaction
virtual void	updateEnableState ()
virtual void	updateMasterEnableState (bool)
Protected Attributes inherited from pqReaction
bool	IsMaster

Detailed Description

Reaction for open data files.

Definition at line 47 of file pqLoadDataReaction.h.

Constructor & Destructor Documentation

pqLoadDataReaction()

pqLoadDataReaction::pqLoadDataReaction

(

QAction *

parent

)

Constructor.

Parent cannot be NULL.

Member Function Documentation

loadData() [1/3]

static pqPipelineSource* pqLoadDataReaction::loadData ( const QList< QStringList > &  files, const QString &  readergroup = QString(), const QString &  readername = QString(), pqServer *  server = NULL  )

static

Loads multiple data files.

Uses reader factory to determine what reader are supported. If a file requires user input the reader of choice, it will use that reader for all other files of that type. Returns the reader is creation successful, otherwise returns NULL. Note that this method is static. Applications can simply use this without having to create a reaction instance.

If readergroup and readername are non empty, then they are assumed to be the type of the reader to use and reader factory is not used.

If server is NULL, active server is used.

loadData() [2/3]

static pqPipelineSource* pqLoadDataReaction::loadData ( const QStringList &  files, const QString &  readergroup = QString(), const QString &  readername = QString(), pqServer *  server = NULL  )

static

Loads data files.

Uses reader factory to determine what reader are supported. Returns the reader is creation successful, otherwise returns NULL. Note that this method is static. Applications can simply use this without having to create a reaction instance.

If readergroup and readername are non empty, then they are assumed to be the type of the reader to use and reader factory is not used.

If server is NULL, active server is used.

loadData() [3/3]

static QList<pqPipelineSource*> pqLoadDataReaction::loadData ( )

static

updateEnableState

void pqLoadDataReaction::updateEnableState ( )

overrideslot

Updates the enabled state.

Applications need not explicitly call this.

loadedData

void pqLoadDataReaction::loadedData ( pqPipelineSource *  )

signal

Fired when a dataset is loaded by this reaction.

onTriggered()

void pqLoadDataReaction::onTriggered ( )

inlineoverrideprotectedvirtual

Called when the action is triggered.

Reimplemented from pqReaction.

Definition at line 111 of file pqLoadDataReaction.h.

TestFileReadability()

static bool pqLoadDataReaction::TestFileReadability ( const QString &  file, pqServer *  server, vtkSMReaderFactory *  factory  )

staticprotected

DetermineFileReader()

static bool pqLoadDataReaction::DetermineFileReader ( const QString &  filename, pqServer *  server, vtkSMReaderFactory *  factory, QPair< QString, QString > &  readerInfo  )

staticprotected

LoadFile()

static pqPipelineSource* pqLoadDataReaction::LoadFile ( const QStringList &  files, pqServer *  server, const QPair< QString, QString > &  readerInfo  )

staticprotected

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/ApplicationComponents/pqLoadDataReaction.h