Full

class Full(*args)

Full history storage strategy.

Available constructors:
Full()

Notes

The full strategy stores every points. Be careful! The memory will be exhausted for huge samples.

Methods

clear() Clear the stored points.
getClassName() Accessor to the object’s name.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getSample() Accessor to the stored sample.
getShadowedId() Accessor to the object’s shadowed id.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setDimension(dimension) Set the dimension of points to store.
setName(name) Accessor to the object’s name.
setShadowedId(id) Accessor to the object’s shadowed id.
setVisibility(visible) Accessor to the object’s visibility state.
store(*args) Store points or samples.
__init__(*args)

Initialize self. See help(type(self)) for accurate signature.

clear()

Clear the stored points.

Notes

It erases the previously stored points

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

The object class name (object.__class__.__name__).

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

getSample()

Accessor to the stored sample.

Returns:
sample : Sample

Numerical sample which is the collection of points stored by the history strategy.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
id : int

Internal unique identifier.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleName : bool

True if the name is not empty and not the default one.

setDimension(dimension)

Set the dimension of points to store.

This method must be called before calling the store method.

Parameters:
dimension: int

Dimension of points to store

Notes

It erases the previously stored points

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visible : bool

Visibility flag.

store(*args)

Store points or samples.

Parameters:
data : sequence of float or 2-d sequence of float

Point or sample to store.

Notes

It adds a unique point or all the point of the sample in the natural order to the history.