Skip to content

etp source Interface

cedricRobert edited this page Jan 25, 2023 · 1 revision

Interface


inheritance

↑ Back to top

This class "vtkETPSouorce" inherits from "vtkPartitionedDataSetCollectionAlgorithm"

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

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);

connection management

↑ Back to top

API Set the url for ETP connection.

	void setETPUrlConnection(char *etp_url);

variable

std::string ETPUrl;

API Set the data partition for ETP connection.

	void setDataPartition(char *data_partition);

variable

	std::string DataPartition;

API Set the Auth for ETP connection.

	void setAuthType(int auth_type);
	void setAuthPwd(char *auth_connection);

variable

	std::string Authentification;
	std::string AuthPwd;

API when Click on button (connect/disconnect)

	void confirmConnectionClicked();
	void disconnectionClicked();

once connected. the etp server returns the list of dataspaces. API Get/Set the dataspaces received.

	void SetDataspaces(const char *dataspace);
	vtkGetObjectMacro(AllDataspaces, vtkStringArray);

variable

	vtkStringArray *AllDataspaces;

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 ETP server 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;