Todo

Improve autoapi module

circadapt.error

CircAdapt Error functions.

Package Contents

Functions

catch_general_error(func)	Raise error on non existance.
raise_error_on_non_existance_set(func)	Raise error on non existance.
except_OSerror(func)	Catch OSError and give a userfriendly exception.

Objects

circadapt.error.catch_general_error(func)

Raise error on non existance.

If parameter does not exist, raise error.

Returns

True (boolean) on success

Raises

NameError if not success

circadapt.error.raise_error_on_non_existance_set(func)

Raise error on non existance.

If parameter does not exist, raise error.

Returns

True (boolean) on success

Raises

NameError if not success

circadapt.error.except_OSerror(func)

Catch OSError and give a userfriendly exception.

exception circadapt.error.CircAdaptException

Bases: Exception

General CircAdapt error.

class __cause__

exception cause

class __context__

exception context

class __suppress_context__

class __traceback__

class args

__delattr__()

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__()

Return self==value.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__hash__()

Return hash(self).

__le__()

Return self<=value.

__lt__()

Return self<value.

__ne__()

Return self!=value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__()

Implement setattr(self, name, value).

__setstate__()

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.ModelNotStable

Bases: CircAdaptException

Model is not stable, consecutive beats are not the same.

class __cause__

exception cause

class __context__

exception context

class __suppress_context__

class __traceback__

class args

msg = "'Model is not stable.'"

__str__()

Return self.msg.

__delattr__()

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__()

Return self==value.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__hash__()

Return hash(self).

__le__()

Return self<=value.

__lt__()

Return self<value.

__ne__()

Return self!=value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__()

Implement setattr(self, name, value).

__setstate__()

__sizeof__()

Size of object in memory, in bytes.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.ModelCrashed

Bases: CircAdaptException

Model is crashed, nans are present in the signal.

class __cause__

exception cause

class __context__

exception context

class __suppress_context__

class __traceback__

class args

msg = "'Model is numerically crashed.'"

__str__()

Return self.msg.

__delattr__()

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__()

Return self==value.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__hash__()

Return hash(self).

__le__()

Return self<=value.

__lt__()

Return self<value.

__ne__()

Return self!=value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__()

Implement setattr(self, name, value).

__setstate__()

__sizeof__()

Size of object in memory, in bytes.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.TriggerNotFound(par)

Bases: CircAdaptException

Trigger is not found.

class __cause__

exception cause

class __context__

exception context

class __suppress_context__

class __traceback__

class args

msg

__str__()

Return self.msg.

__delattr__()

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__()

Return self==value.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__hash__()

Return hash(self).

__le__()

Return self<=value.

__lt__()

Return self<value.

__ne__()

Return self!=value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__()

Implement setattr(self, name, value).

__setstate__()

__sizeof__()

Size of object in memory, in bytes.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception circadapt.error.CorruptBuild

Bases: CircAdaptException

Model is not properly built.

class __cause__

exception cause

class __context__

exception context

class __suppress_context__

class __traceback__

class args

msg = Multiline-String

Show Value

""""""Model is not properly built.
 Make sure all components in the model are connected before you run the model, or before you get or set parameters.""""""

__str__()

Return self.msg.

__delattr__()

Implement delattr(self, name).

__dir__()

Default dir() implementation.

__eq__()

Return self==value.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__hash__()

Return hash(self).

__le__()

Return self<=value.

__lt__()

Return self<value.

__ne__()

Return self!=value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__()

Implement setattr(self, name, value).

__setstate__()

__sizeof__()

Size of object in memory, in bytes.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

add_note()

Exception.add_note(note) – add a note to the exception

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.