ipa.IPACatalog Class Reference
[ipa-python Data Classes]

A logical partition of related IPA datasets. More...

List of all members.

Public Member Functions
def	add_dataset
	Add a new dataset to the catalog.
def	get_dataset
	Retrieve a dataset for a given time from the catalog.
def	get_datasets
	Retrieve one or more datasets valid during a time interval from the catalog.
def	get_labels
	Retrieve all of the labels in the dataset.
def	delete_dataset
	Deletes the dataset for a given time from the catalog.

---

Detailed Description

A logical partition of related IPA datasets.

---

Member Function Documentation

def ipa.IPACatalog.add_dataset	(		self,
			start,
			end
	)

Add a new dataset to the catalog.

Parameters:

	self
	start	start date of dataset validity
	end	end date of dataset validity

def ipa.IPACatalog.get_dataset	(		self,
			date
	)

Retrieve a dataset for a given time from the catalog.

Parameters:

	self
	date	Date and time of dataset to be retrieved

Exceptions:

IPADatasetNotFoundError,IPADatasetError

def ipa.IPACatalog.get_datasets	(		self,
			begin = None,
			end = None
	)

Retrieve one or more datasets valid during a time interval from the catalog.

Parameters:

	self
	begin	Beginning of time interval of interest
	end	End of time interval of interest

def ipa.IPACatalog.get_labels	(		self,
			labels = None
	)

Retrieve all of the labels in the dataset.

Parameters:

	self
	labels	Optional list of label names to be returned

def ipa.IPACatalog.delete_dataset	(		self,
			date
	)

Deletes the dataset for a given time from the catalog.

Parameters:

	self
	date	Date and time of dataset to be deleted

---

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

• __init__.py