Abstract class, which specifies the basic interfaces a protocol must implement. More...

Inheritance diagram for fosanalysis.protocols.Protocol:

Public Member Functions
	__init__ (self, args, *kwargs)
	Constructs a Protocol object.

np.array	get_x_values (self)
	Returns the values of the x-axis record (location data).

list	get_y_table (self, args, *kwargs)
	Returns the table of the strain data.

Public Member Functions inherited from fosanalysis.utils.base.Base
	__init__ (self, args, *kwargs)
	Construct the object and warn about unused/unknown arguments.

Public Attributes
dict	metadata = {}
	Dictionary containting metadata information.

Detailed Description

Abstract class, which specifies the basic interfaces a protocol must implement.

Deprecated: This class and its subclasses are deprecated and will be removed in the next release. Please update to the new interface, see datahandling.

Definition at line 48 of file protocols.py.

Constructor & Destructor Documentation

fosanalysis.protocols.Protocol.__init__	(		self,
		*	args,
		**	kwargs )

Constructs a Protocol object.

Needs to be reimplemented by sub-classes.

Definition at line 56 of file protocols.py.

Here is the call graph for this function:

Here is the caller graph for this function:

np.array fosanalysis.protocols.Protocol.get_x_values ( self )

Returns the values of the x-axis record (location data).

Definition at line 71 of file protocols.py.

Here is the caller graph for this function:

list fosanalysis.protocols.Protocol.get_y_table	(		self,
		*	args,
		**	kwargs )

Returns the table of the strain data.

Definition at line 77 of file protocols.py.

Here is the caller graph for this function:

dict fosanalysis.protocols.Protocol.metadata = {}

Dictionary containting metadata information.

Definition at line 63 of file protocols.py.

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