ThinWireProbe Class

A probe that can be attached to a thin wire segment.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseThinWireProbe
ema3d.Api.V25.CablingThinWireProbe

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 ThinWireProbe : APISimObjectBase<ThinWireProbe>, 
	IHasSegment, IHasTime

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

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

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

The ThinWireProbe type exposes the following members.

Properties

	Name	Description
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Location	Location on a segment.
	Quantity	Gets/Sets the quantity to probe (voltage or current).
	Segment	Gets the segment this probe lies on.
	TEnd	Gets/Sets end time.
	TStart	Gets/Sets start time.
	TStep	Gets/Sets time step.

Top

Methods

	Name	Description
	Create	Creates a new ThinWireProbe 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 ThinWireProbe 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	Move this probe to a new location.
	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

Reference

ema3d.Api.V25.Cabling Namespace