tarch.plotter.api.output.Visualiser.SnapShot Class Reference

Small class to capture all of the snapshots in a Patch meta file. More...

Public Member Functions
	__init__ (self)
	add_patch_file (self, patch_file_name)
	include_file_counter (self)
	Property to indicate number of patch files in this snapshot.
	set_timestamp (self, timestamp)
	__repr__ (self)

Data Fields
	timestamp
	filenames

Detailed Description

Small class to capture all of the snapshots in a Patch meta file.

Just need the timestamp this is associated with and all of the patch files that this file includes. Add them using the right member function.

Definition at line 89 of file Visualiser.py.

Constructor & Destructor Documentation

__init__()

tarch.plotter.api.output.Visualiser.SnapShot.__init__

(

self

)

Definition at line 97 of file Visualiser.py.

Member Function Documentation

__repr__()

tarch.plotter.api.output.Visualiser.SnapShot.__repr__

(

self

)

Definition at line 118 of file Visualiser.py.

add_patch_file()

tarch.plotter.api.output.Visualiser.SnapShot.add_patch_file	(		self,
			patch_file_name
	)

Definition at line 101 of file Visualiser.py.

References tarch.plotter.api.output.Visualiser.SnapShot.filenames.

include_file_counter()

tarch.plotter.api.output.Visualiser.SnapShot.include_file_counter

(

self

)

Property to indicate number of patch files in this snapshot.

Definition at line 108 of file Visualiser.py.

References tarch.plotter.api.output.Visualiser.SnapShot.filenames.

set_timestamp()

tarch.plotter.api.output.Visualiser.SnapShot.set_timestamp	(		self,
			timestamp
	)

Definition at line 114 of file Visualiser.py.

References tarch.plotter.api.output.Visualiser.SnapShot.timestamp, toolbox::blockstructured::GlobalDatabase::Entry.timestamp, and toolbox::particles::TrajectoryDatabase::Entry.timestamp.

Field Documentation

filenames

tarch.plotter.api.output.Visualiser.SnapShot.filenames

Definition at line 99 of file Visualiser.py.

Referenced by tarch.plotter.api.output.Visualiser.SnapShot.add_patch_file(), and tarch.plotter.api.output.Visualiser.SnapShot.include_file_counter().

timestamp

tarch.plotter.api.output.Visualiser.SnapShot.timestamp

Definition at line 98 of file Visualiser.py.

Referenced by tarch.plotter.api.output.Visualiser.SnapShot.set_timestamp().

---

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

• src/tarch/plotter/api/output/Visualiser.py