epc reader Interface

Interface

• inheritance
• multi process
• file management
• treeview
• wellbore properties

---

inheritance

↑ Back to top

This class "vtkEPCReader" inherits from "vtkPartitionedDataSetCollectionAlgorithm"

redefinition of the "RequestData" method for the needs of the reader

• verify: the elements selected in the tree structure are indeed loaded
• get the index of the "time_steps" for set the mapper (ResqmlDataRepositoryToVtkPartitionedDataSetCollection repository)
• loads the objects selected for the representation of the "vtkPartitionedDataSetCollection"

Multi process

↑ Back to top

Get/set the multi process controller to use for coordinated reads. By default, set to the global controller.

declaration

   vtkGetObjectMacro(Controller, vtkMultiProcessController);
   void SetController(vtkMultiProcessController *controller);

variable

  vtkMultiProcessController *Controller;

call

  vtkCxxSetObjectMacro(vtkEPCReader, Controller, vtkMultiProcessController);

File management

↑ Back to top

1. create reader pipeline

The source used to build the pipeline is a file see the GUI parameters file "proxy source"

2. added file(s)

  const char *GetFileName(int index) const;
	void AddFileNameToFiles(const char *fname);
	void ClearFileName();
	size_t GetNumberOfFileNames() const;
  void SetFiles(const std::string& file);
  vtkStringArray* GetAllFiles();

variable

  vtkSmartPointer<vtkStringArray> Files;
  std::set<std::string> FilesList;
  std::set<std::string> FileNamesLoaded;

Treeview

↑ Back to top

Assemblies (vtkDataAssembly) provide yet another way to select blocks/assemblies to load, if available in the dataset. If a block (or assembly) is enabled in block (or assembly) selection or using the assembly selector, it is treated as enabled and will be loaded.

This method returns the vtkDataAssembly. Since toto can have multiple fichiers, all are nested under the root "data" node. If the file has no assemblies, this will return nullptr.

declaration

  vtkDataAssembly* GetAssembly();

Whenever the assembly is changed, this tag gets changed. Note, users should not assume that this is monotonically increasing but instead simply rely on its value to determine if the assembly may have changed since last time.

It is set to 0 whenever there's no valid assembly available.

declaration

  vtkGetMacro(AssemblyTag, int);

variable

  int AssemblyTag;

API to specify selectors that indicate which branches on the assembly are chosen.

declaration

	bool AddSelector(const char *selector);
	void ClearSelectors();
	void SetSelector(const char* selector);

API to access selectors.

declaration

	int GetNumberOfSelectors() const;
	const char *GetSelector(int index) const;

variable

	std::set<std::string> selectors;

Wellbore properties

↑ Back to top

Wellbore marker properties.

declaration

	void setMarkerOrientation(bool orientation);
	void setMarkerSize(int size);

variable

	bool MarkerOrientation;
	int MarkerSize;