PinVoltage Class

An MHARNESS Pin Voltage source attached to the end of some cable.

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBasePinVoltage
    ema3d.Api.V25.Core.ExcitationExcitationBasePinVoltage
      ema3d.Api.V25.Cabling.ExcitationPinVoltage

Namespace: ema3d.Api.V25.Cabling.Excitation
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class PinVoltage : ExcitationBase<PinVoltage>, 
	IHasSegment, IHasCable

Public NotInheritable Class PinVoltage
	Inherits ExcitationBase(Of PinVoltage)
	Implements IHasSegment, IHasCable

public ref class PinVoltage sealed : public ExcitationBase<PinVoltage^>, 
	IHasSegment, IHasCable

[<SealedAttribute>]
type PinVoltage = 
    class
        inherit ExcitationBase<PinVoltage>
        interface IHasSegment
        interface IHasCable
    end

The PinVoltage type exposes the following members.

Properties

	Name	Description
	Cable	The cable this item is attached to.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Document	The document an object exists in. (Inherited from ExcitationBaseT)
	End	The end of the Segment this source lies on.
	Segment	The segment this item is located on.
	Simulation	The Simulation an object exists in. (Inherited from ExcitationBaseT)

Top

Methods

	Name	Description
	Create	Create a new PinVoltage source at a given segment and cable end.
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all PinVoltage objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLocation	Gets the point location of this element.
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Move	Move this source to a new segment and end.
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Cabling.Excitation import PinVoltage as PinVoltage
import ema3d.Api.V25.Cabling as Cabling
import ema3d.Api.V25.Core.Signals as Signals
# Grab an existing conductor and attach a new pinVoltage source
_cond = Cabling.Conductor.GetAll()[0]
_pinvoltage = PinVoltage.Create(segment, Cabling.Excitation.EndType.End, _cond)
_pinvoltage.DisplayName = "Test Pin Voltage"
# Attach a new signal to the data
_sine = Signals.SineSignal.Create()
_sine.AttachTo(_pinvoltage)

Reference

ema3d.Api.V25.Cabling.Excitation Namespace