Coretex
coretex.coretex.sample.any_local_sample.AnyLocalSample Class Reference
Inheritance diagram for coretex.coretex.sample.any_local_sample.AnyLocalSample:
coretex.coretex.sample.local_sample.LocalSample coretex.coretex.sample.sample.Sample

Public Member Functions

str path (self)
 
str zipPath (self)
 
- Public Member Functions inherited from coretex.coretex.sample.local_sample.LocalSample
bool download (self, bool ignoreCache=False)
 
- Public Member Functions inherited from coretex.coretex.sample.sample.Sample
None unzip (self, bool ignoreCache=False)
 
Path joinPath (self, Union[Path, str] other)
 

Detailed Description

    Generic class for local samples

Definition at line 26 of file any_local_sample.py.

Member Function Documentation

◆ path()

str coretex.coretex.sample.any_local_sample.AnyLocalSample.path (   self)
    Returns
    -------
    str -> path for any local sample

Reimplemented from coretex.coretex.sample.local_sample.LocalSample.

Definition at line 33 of file any_local_sample.py.

33  def path(self) -> str:
34  """
35  Returns
36  -------
37  str -> path for any local sample
38  """
39 
40  return str(self._path)
41 

◆ zipPath()

str coretex.coretex.sample.any_local_sample.AnyLocalSample.zipPath (   self)
    Returns
    -------
    str -> zip path for any local sample

Reimplemented from coretex.coretex.sample.local_sample.LocalSample.

Definition at line 43 of file any_local_sample.py.

43  def zipPath(self) -> str:
44  """
45  Returns
46  -------
47  str -> zip path for any local sample
48  """
49 
50  return str(self._path)

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