seapy.base.Base

class seapy.base.Base(name, system, **properties)[source]

Bases: builtins.object

Abstract Base Class for all components, junctions, materials, subsystems, couplings and excitation.

__init__(name, system, **properties)[source]

Constructor.

Parameters:

Methods

__init__(name, system, **properties) Constructor.
Base.df
disable() Disable this object.
enable() Enable this object.
info([attributes]) Return dataframe.
plot(quantity[, yscale]) Plot quantity.

Attributes

classname Name of class of the object.
enabled Switch indicating whether the object is enabled.
frequency Frequency.
included Indicates whether the object is included in the analysis.
name
__init__(name, system, **properties)[source]

Constructor.

Parameters:
classname[source]

Name of class of the object. This is an alias for obj.__class__.__name__.

disable()[source]

Disable this object.

enable()[source]

Enable this object.

enabled[source]

Switch indicating whether the object is enabled.

Returns:A boolean indicating whether the object is enabled (True) or not (False)
Return type:bool()
frequency[source]

Frequency.

included[source]

Indicates whether the object is included in the analysis.

Parameters:extended (bool) – Whether to show a list of dependencies with outcomes.
Return type:bool or list
info(attributes=None)[source]

Return dataframe.

name = None

Name of object.

The name of the object is unique.

See also

Name

plot(quantity, yscale='linear')[source]

Plot quantity.

Seealso:seapy.tools.plot()
system = None

Reference to System this object belongs to.

Previous topic

seapy.base.MetaBase

Next topic

seapy.base.LinkedList

This Page