Package empro :: Class ActiveProject

Class ActiveProject

Nested Classes
	__metaclass__

Instance Methods

__enter__(self)

source code

__exit__(self, type, value, traceback)

source code

__del__(self)

source code

__getattr__(self, name)

source code

__setattr__(self, name, value)

source code

__dir__(self)

source code

sipiSetupList(*args, **kws)
sipiSetupList is deprecated, and will be removed in the 2021 release.

source code

createSimulation(self, iQueue)

source code

tuple{string,string}

addSimulationDataToProject(iQueued)
deprecated.

source code

dictionary{string,string}

attributes()
Returns a read-only map of attributes set to this project.

source code

cameraList(...)
No documentation available.

source code

None

clear()
Clears all values of this project.

source code

None

clearAttribute(iName)
Clears an attribute of a project.

source code

SimulationData

createSimulationData()
Simulation settings to be used when creating new simulations.

source code

createSimulationEx(...)
No documentation available.

source code

BondwireDefinition

defaultBondwireDefinition()
Returns a default bondwire definition.

source code

CircuitComponentDefinition

defaultCircuitComponentDefinition()
Returns a default circuit component definition.

source code

Feed

defaultFeed()
Returns a default feed.

source code

PassiveLoad

defaultPassiveLoad()
Returns a default passive load.

source code

Waveform

defaultWaveform()
Returns a default waveform.

source code

WaveformShape

defaultWaveformShape()
Returns a default waveform shape.

source code

getADSVisual(...)
No documentation available.

source code

isValid(...)
No documentation available.

source code

bool

loadActiveProjectFrom(iPath)
Loads a project from a given directory.

source code

loadActiveProjectFromLocation(...)
No documentation available.

source code

readADSVisual(...)
No documentation available.

source code

readSiSolution(...)
No documentation available.

source code

reasonWhyInvalid(...)
No documentation available.

source code

None

recoverBrokenModels()
An internal method to recover models for which the modeling sequence is corrupted.

source code

int

recoverableBrokenModels()
Returns the number of models that are recoverable for which the modeling sequence was corrupted.

source code

Assembly

rootGroup()
Returns a reference to the geometry.

source code

saveActiveProject(...)
No documentation available.

source code

bool

saveActiveProjectTo(iPath)
Saves the project to a given directory.

source code

scriptList

scriptList()
Returns a reference to the list of scripts.

source code

setADSVisual(...)
No documentation available.

source code

None

setAttribute(iName, iValue)
Sets an attribute of a project.

source code

usesOAStorageFormat(...)
No documentation available.

source code

Static Methods

subscribeActiveProjectChanged(function)

source code

Class Variables
	__call__ = `<method-wrapper '__call__' of _ActiveProjectMeta ob...`

Properties
	layout
	analyses No documentation available.
`BondwireDefinitiontList`	bondwireDefinitions bondwireDefinitions() Returns a reference to the bondwire definitions.
BoundaryConditions	boundaryConditions boundaryConditions() Returns a reference to the boundary conditions.
	cameras No documentation available.
`CircuitComponenDefinitiontList`	circuitComponentDefinitions circuitComponentDefinitions() Returns a reference to the circuit component definitions.
CircuitComponentList	circuitComponents circuitComponents() Returns a reference to the circuit components.
	connectivity No documentation available.
ExpressionNone	customTimestepMultiplier When used, the value of the custom time step multiplier.
	displayUnits No documentation available.
ExternalExcitationList	externalExcitations externalExcitations() Returns a reference to the external excitations.
FarZoneSensorList	farZoneSensors farZoneSensors() Returns a reference to the far zone sensors.
Assembly	geometry geometry() Returns a reference to the geometry.
GridGenerator	gridGenerator gridGenerator() Returns a reference to the grid generator.
int (read-only)	lastSavedTime The time the last time the project was saved.
`LibraryComponenDefinitiontList`	libraryComponentDefinitions libraryComponentDefinitions() Returns a reference to the library component definitions.
	location No documentation available.
MaterialList	materials materials() Returns a reference to the material list.
Mesh	mesh mesh() Returns a reference to the mesh.
	name No documentation available.
NearFieldSensorList	nearFieldSensors nearFieldSensors() Returns a reference to the near field sensors.
	newPartModelingUnit No documentation available.
	notes No documentation available.
ParameterList	parameters parameters() Returns a reference to the list of parameters.
	readOnly No documentation available.
stringNone	rootDir The root directory of the project.
SARAveragingSensor	sarAveragingSensor sarAveragingSensor() Returns a reference to the SAR averaging sensor.
SARSensor	sarSensor sarSensor() Returns a reference to the SAR sensor.
	scripts
SensorDataDefinitionList	sensorDataDefinitions sensorDataDefinitions() Returns a reference to the sensor data definitions.
	shortcuts No documentation available.
SimulationList	simulations simulations() Returns a reference to the simulations in the queue.
	skin No documentation available.
TemperatureRiseSensor	temperatureRiseSensor temperatureRiseSensor() Returns a reference to the temperature rise sensor.
boolNone	useCustomTimestepMultiplier Determines the use of a custom time step multiplier.
	verticalAxis No documentation available.
WaveGuideList	waveGuides waveGuides() Returns a reference to the list of wave guides.
WaveformList	waveforms waveforms() Returns a reference to the waveforms.

Method Details

sipiSetupList(*args, **kws)

source code

sipiSetupList is deprecated, and will be removed in the 2021 release. Use empro.activeProject.analyses instead.

Decorators:

@_deprecation.deprecated(390, "Use empro.activeProject.analyses instead.")

addSimulationDataToProject(iQueued)

source code

deprecated. creates a new simulation using settings from createSimulationData and adds it to the project.

Parameters:

iQueued (bool) - Determines if the simulation has to be queued.

Returns: tuple{string,string}

clearAttribute(iName)

source code

Clears an attribute of a project.

Parameters:

iName (string) - The name of the attribute to clear.

Returns: None

loadActiveProjectFrom(iPath)

source code

Loads a project from a given directory.

Parameters:

iPath (string) - The path to load the project from.

Returns: bool

rootGroup()

source code

Returns a reference to the geometry. This is a synonym for Project.geometry.

Returns: Assembly

saveActiveProjectTo(iPath)

source code

Saves the project to a given directory.

Parameters:

iPath (string) - The path to save the project to.

Returns: bool

setAttribute(iName, iValue)

source code

Sets an attribute of a project.

Parameters:

iName (string) - The name of the attribute to set.
iValue (string) - The value of the attribute.

Returns: None

Class Variable Details

call

Value:

<method-wrapper '__call__' of _ActiveProjectMeta object at 0x000000000
3470048>

Property Details

layout

Get Method:: internal.layout(self)

lastSavedTime

The time the last time the project was saved. (seconds since epoch)

Type:: int (read-only)