Harness Class

A harness object that exists within a document.

Inheritance Hierarchy

SystemObject
ema3d.Api.V25APISimObjectBaseHarness
ema3d.Api.V25.CablingHarness

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 Harness : APISimObjectBase<Harness>

Public NotInheritable Class Harness
	Inherits APISimObjectBase(Of Harness)

public ref class Harness sealed : public APISimObjectBase<Harness^>

[<SealedAttribute>]
type Harness = 
    class
        inherit APISimObjectBase<Harness>
    end

The Harness type exposes the following members.

Properties

	Name	Description
	Approximate	Gets/Sets or not to use low frequency approximation.
	DefaultConnectorType	The default type of connector energy transfer to use at ends in a harness.
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	FilamentNumber	Gets/Sets harness filament number.
	HarnessPad	Gets/Sets the padding to add to elements when packing a harness cross-section.
	Height	Gets/Sets offset from ground plane (1D/Standalone only)
	IsWeaklyCoupled	Gets/Sets if harness should be weakly coupled with main document.
	OuterLayerConnectivity
	OverrideDefaultConnectorType	Whether to override the default connector type.
	PackingFactor	Gets/Sets harness packing factor.
	Segments	All curves that are a part of the routing for children of this harness.

Top

Methods

	Name	Description
	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 Harness objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetInstance	Gets the existing harness within a document or creates a new one if one does not exist.
	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)
	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

Remarks

Documents can only have one instance of a harness.

Example

Python

Copy

from ema3d.Api.V25.Cabling import Harness as Harness
# Get harness instance and configure some options
_harn = Harness.GetInstance()
_harn.Approximate = True
_harn.PackingFactor = 0.75
_harn.FilamentNumber = 40

Reference

ema3d.Api.V25.Cabling Namespace