Todo

Improve autoapi module

circadapt.components.node

Cavity objects.

Module Contents

Classes

Node

Basic Cavity object.

Objects

class circadapt.components.node.Node(component_type, model, objects=None)

Bases: circadapt.components.Component

Basic Cavity object.

parameters = '[]'
signals = "['A', 'p', 'q']"
parameter_on_set
objects
build()
add_object(o)
__repr__()

Object representation in string format.

__getitem__(arg: any) any

Get data.

This function is called when self[arg].

Parameters

arg: slice or string

If slice, return a components object with locs obtained from slice. If str, return the parameter or signal for all locs

__setitem__(arg: str, val: any) any

Set data.

Set data of the parameter given in arg. Only parameter names can be used.

Parameters

arg: str

Parameter name

val: float/int/bool

Value will automatically be translated to type to

__iter__()

Iterate over object, used for dict(self).

add(name)