Todo

Improve autoapi module

circadapt.components

Components for easy input/output of the CircAdapt model.

The component is a general class. It holds parameters that will be called using the Parameter object and signals that are called using the Signals object.

Package Contents

Classes

Component	General functions to communicate with c++ objects.
ParSig	Basic functions used for Parameter and Signal classes.
Parameter	General functions to retreive signals from the c++ object.
Signal	General functions to retreive signals from the c++ object.
General	Component object with no locations.
AutoComponent	Any component that automatically detects the parameters from the c++ class.

Submodules

• circadapt.components.cavity
• circadapt.components.connector
• circadapt.components.global_functions
• circadapt.components.node
• circadapt.components.patch
• circadapt.components.solver
• circadapt.components.wall

Objects

class circadapt.components.Component(model, objects=None)

General functions to communicate with c++ objects.

Parameters

model: ctypes object

C++ model

locs: string

Locations of objects in the c++ model that can be altered along this component

parameters = []

signals = []

parameter_on_set

build()

add_object(o)

class circadapt.components.ParSig(model, par, locs)

Basic functions used for Parameter and Signal classes.

build()

class circadapt.components.Parameter(model, par, locs, parameter_on_set=None)

Bases: ParSig

General functions to retreive signals from the c++ object.

Parameters

model: ctypes object

C++ model

par: str

Parameter name that will be obtained from each loc.

locs: string

Locations of objects in the c++ model that can be altered along this component.

build()

class circadapt.components.Signal(model, par, locs)

Bases: ParSig

General functions to retreive signals from the c++ object.

Parameters

model: ctypes object

C++ model

par: str

Parameter name that will be obtained from each loc.

locs: string

Locations of objects in the c++ model that can be altered along this component

build()

class circadapt.components.General(model)

Bases: Component

Component object with no locations.

parameters

signals

parameter_on_set

build()

add_object(o)

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

Bases: Component

Any component that automatically detects the parameters from the c++ class.

This type of component is especially for plugins. No special functions are given to this type of component.

parameters = []

signals = []

parameter_on_set

add_object(*arg, **kwarg)

build()