Class in Zendir.Classes | Inherits from UniverseBehaviour

Declaration

class PowerBus;

Description

The Power Bus is a component that can be attached to an object that controls the power system on-board the entity. It allows for power to flow from a battery unit, into a series of nodes. All components that are power related must attach to this component.


Properties

DeclaredDescription
DisableExcessPowerCorrectionA Flag that instructs the PowerBus to disable corrections to its simulation if PowerSources are over supplying PowerSinks.This means that the PowerNodeModel data for PowerSinks will be calculated as if they were receiving the correct amount of power.
DisableInsufficientPowerCorrectionA Flag that instructs the PowerBus to disable corrections to its simulation if PowerSources aren’t meeting the expectations of PowerSinks.This means that the PowerNodeModel data for PowerSinks will be calculated as if they were receiving the correct amount of power.
ZeroGroundPlaneA Flag that instructs the PowerBus to zero any Current or Voltage values that connect to the ground plane.
InheritedDescription
IsEnabledIs true if the object is currently enabled.
NameThe display name or tag of this object.
ParentThe currently attached parent object (if any).

Methods

DeclaredDescription
ConnectConnects two EPS Components in the network. This will create a wire between the two componentsThis assumes that the positive terminal of the ‘fromNode’ is connected to the negative terminalof the ‘toNode’.
ConnectTerminalsConnects two EPS Components in the network with a specific terminal type. Thiswill create a wire between the two components and connect them in the network.The terminals that the components are connected from and to can be specifiedhere in this network.
DisconnectDisconnects two EPS Components in the network. This will not removethe component from the cache, but more just disconnect the wire thatjoins the two components together.
DisconnectTerminalsDisconnects two EPS Components in the network. This is based on the terminalsthat the wires are connected to, within the network.
GetConnectedInputsReturns a list of all components that are connected on the power bus as an input to a particular component.This is all the components that are connected to the negative terminal of the component.
GetConnectedOutputsReturns a list of all components that are connected on the power bus as an output to a particular component.This is all the components that are connected to the positive terminal of the component.
GetNetworkedComponentsReturns an array of the components in the network of the PowerBus
IsComponentConnectedReturns whether a particular component is connected in the Network
IsValidReturns whether the current system is valid and hasa completed circuit.
RemoveRemoves a component from the network
ReplaceReplaces a component in the network with another component
InheritedDescription
DestroyRemoves the current object from the simulation.
FindParentWithIDReturns an attached parent that satisfies the specified ID.
FindParentWithTypeReturns an attached parent that satisfies the specified type.
FindRootWithIDReturns a root object that satisfies the specified ID.
FindRootWithTypeReturns a root object that satisfies the specified type.