CableVoltageProbe Class

A probe that measures the current on an MHARNESS cable element.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseCableVoltageProbe
ema3d.Api.V25.CablingCableVoltageProbe

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

Syntax

C++

Copy

public sealed class CableVoltageProbe : APISimObjectBase<CableVoltageProbe>, 
	IHasSegment, IHasCable, IHasTime

Public NotInheritable Class CableVoltageProbe
	Inherits APISimObjectBase(Of CableVoltageProbe)
	Implements IHasSegment, IHasCable, IHasTime

public ref class CableVoltageProbe sealed : public APISimObjectBase<CableVoltageProbe^>, 
	IHasSegment, IHasCable, IHasTime

[<SealedAttribute>]
type CableVoltageProbe = 
    class
        inherit APISimObjectBase<CableVoltageProbe>
        interface IHasSegment
        interface IHasCable
        interface IHasTime
    end

The CableVoltageProbe type exposes the following members.

Properties

	Name	Description
	Cable	The cable this probe is attached to.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Location	Location on a segment
	TEnd	Gets/Sets end time.
	TStart	Gets/Sets start time.
	TStep	Gets/Sets time step.

Top

Methods

	Name	Description
	Create	Creates a new CableVoltageProbe attached to the given cable.
	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 CableVoltageProbe objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	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(IAPICable)	Move this probe to a new cable at the given location.
	Move(SegmentLocation)	Move this probe to a new location.
	Move(SegmentLocation, IAPICable)	Move this probe to a new location and cable.
	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 import CableVoltageProbe as CableVoltageProbe
import ema3d.Api.V25.Cabling as Cabling
# create SegmentLocation and attach to an IAPICable
_loc = Cabling.SegmentLocation.CreateRelative(trimmed_curve, 0.5) # Create a location at the middle of a curve
_vprobe = CableVoltageProbe.Create(_loc, api_cable)
_vprobe.DisplayName = "API Cable Voltage Probe"

Reference

ema3d.Api.V25.Cabling Namespace