Connection3D Class

In This Topic

Class represents 3D connection between two Placement3D objects.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.Connection
         Eplan.EplApi.DataModel.E3D.Connection3D

Syntax

C#
C++/CLI

public class Connection3D : Eplan.EplApi.DataModel.Connection, Eplan.EplApi.DataModel.IArticleUser, Eplan.EplApi.DataModel.IWriteProtection

public ref class Connection3D : public Eplan.EplApi.DataModel.Connection, Eplan.EplApi.DataModel.IArticleUser, Eplan.EplApi.DataModel.IWriteProtection

Public Constructors

	Name	Description
	Connection3D Constructor	Default constructor.

Top

Public Properties

	Name	Description
	ArticleReferences	Returns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	Articles	Returns Eplan.EplApi.DataModel.Articles that are referenced by Connection, and only those that are stored in project database. (Inherited from Eplan.EplApi.DataModel.Connection)
	CableDefinitionLine	Returns Eplan.EplApi.DataModel.EObjects.Cable from a Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection. If there are more then one Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling Eplan.EplApi.DataModel.Connection.ConnectionDefPoints and analyze of the result. (Inherited from Eplan.EplApi.DataModel.Connection)
	CableNameParts	Gets/Sets a cable's name to the connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	CanHaveArticleData	Check if the Connection can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.Connection)
	Color	Represents color in which connection is displayed.
	Connection3D	Returns the Connection3D which is a 3d representation of this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	ConnectionDefPointProperties	Allows to access properties of a Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection. If there are more then one Eplan.EplApi.DataModel.ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling Eplan.EplApi.DataModel.Connection.ConnectionDefPoints and analyze of the result. (Inherited from Eplan.EplApi.DataModel.Connection)
	ConnectionDefPoints	Returns the Eplan.EplApi.DataModel.ConnectionDefinitionPoint related to this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	CrossReferencedObjectsAll	Returns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
	DatabaseIdentifier	Returns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	EndConnectionPointPosition	Eplan.EplApi.DataModel.ConnectionPointPosition by which this connection is connected to Eplan.EplApi.DataModel.Connection.EndSymbolReference.
	EndIndex	Index of the end function's connection point (0,1,2,...) that the connection is connected to. (Inherited from Eplan.EplApi.DataModel.Connection)
	EndObject	Returns the second of two Function3Ds connected by this connection3D.
	EndSymbolConnPoint	Returns the Eplan.EplApi.DataModel.PinBase which this connection is connected to on the target side. If this connection is not connected on the target side, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
	EndSymbolReference	Returns the second of two Eplan.EplApi.DataModel.SymbolReferences connected by this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	EndTargetNumber	Target number of end function (1,2,3...) (Inherited from Eplan.EplApi.DataModel.Connection)
	FunctionDefinition	Returns the Eplan.EplApi.DataModel.FunctionDefinition of the Connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	IsCoveredTemplate	Returns true if this is a Connection object that covers a wire's template in the cable where it belongs. (Inherited from Eplan.EplApi.DataModel.Connection)
	IsFixedDevice	Checks if device to which connection is assign is fixed or not. (Inherited from Eplan.EplApi.DataModel.Connection)
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsPlaced	Returns true if the placement is placed (Inherited from Eplan.EplApi.DataModel.Connection)
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsRemovable	Returns true if the Connection can be removed (Inherited from Eplan.EplApi.DataModel.Connection)
	IsRouted	Returns true if connection is routed through at least one point.
	IsTemplate	Returns true if this is a transient Connection object representing a cable wire's template. (Inherited from Eplan.EplApi.DataModel.Connection)
	IsTransient	Determines if the the StorableObject is transient. The StorableObject is transient when it was created by default constructor and: it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project, it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsVisible	Indicates whether connectionobject is currently visible in 3D editor view.
	KindOfWire	Returns kind of wire. (Inherited from Eplan.EplApi.DataModel.Connection)
	Layer	Gets or sets object's graphical layer.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Page	Returns the Eplan.EplApi.DataModel.Page where the connection is placed on. (Inherited from Eplan.EplApi.DataModel.Connection)
	PotentialDefinitions	Returns the Eplan.EplApi.DataModel.PotentialDefinition related to this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to P8 properties of the Connection3D object.
	RepresentationType	Gets/Sets connection's representation type. (Inherited from Eplan.EplApi.DataModel.Connection)
	RouteNodes	Array of route elements space through which connection is routed.
	RoutePoints	Array of points in 3d space through which connection is routed.
	RoutePointsAndNode	Array of points in 3d space through which connection is routed and objects in which points are located.
	RoutingType	Gets or sets type of routing (with/without using a network)
	Shieldings	Returns the Shielding objects the connection is composed of. It does not return Shielding objects the connection is shielded by. (Inherited from Eplan.EplApi.DataModel.Connection)
	StartConnectionPointPosition	Eplan.EplApi.DataModel.ConnectionPointPosition by which this connection is connected to Eplan.EplApi.DataModel.Connection.StartSymbolReference.
	StartIndex	Index of the start function's connection point (0,1,2,...) that the connection is connected to. (Inherited from Eplan.EplApi.DataModel.Connection)
	StartObject	Returns the first of two Function3Ds connected by this connection3D.
	StartSymbolConnPoint	Returns the Eplan.EplApi.DataModel.PinBase which this connection is connected to on the source side. If this connection is not connected on the source side, NULL is returned. (Inherited from Eplan.EplApi.DataModel.Connection)
	StartSymbolReference	Returns the first of two Eplan.EplApi.DataModel.SymbolReferences connected by this connection. (Inherited from Eplan.EplApi.DataModel.Connection)
	StartTargetNumber	Target number of start function (1,2,3...) (Inherited from Eplan.EplApi.DataModel.Connection)
	SubConnections	If connection contains interruption points, this method returns an array of partial connections which current connection consists of For a "net connection" this method will return an empty array. (Inherited from Eplan.EplApi.DataModel.Connection)
	SymbolReferences	This method returns an array of SymbolReferences objects that belong to a connection . This may for example be T-pieces or corners. Also beginning and end are returned. (Inherited from Eplan.EplApi.DataModel.Connection)
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	WriteProtected	Check if object is currently write protected or sets Manual write protection (Inherited from Eplan.EplApi.DataModel.Connection)

Top

Public Methods

	Name	Description
	AddArticleReference	Overloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the Connection. Returns the added Eplan.EplApi.DataModel.ArticleReference. (Inherited from Eplan.EplApi.DataModel.Connection)
	Assign	Assigns this connection to another, which means that values of this connection's properties are copied to the target connection and the source connection itself is removed from the project. (Inherited from Eplan.EplApi.DataModel.Connection)
	ClearRouteAndNodes	Clears all route points of connection.
	Create	Overloaded. Creates connection between two 3d placements.
	Dispose()	Destructor for deterministic finalization of Connection3D object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetWriteProtectionFlagSet	Checks if a specific write protection kind was set. (Inherited from Eplan.EplApi.DataModel.Connection)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	MakePersistent	Allows to create non-placed connection from a connection template. In effect connection template becomes covered template. (Inherited from Eplan.EplApi.DataModel.Connection)
	PauseWriteProtection	Temporarily disables write protection. Note that current write protection flags are not cleared. (Inherited from Eplan.EplApi.DataModel.Connection)
	PlaceAsConnectionDefinitionPoint	Places this connection as a connection def. point on the given schematic page and in the given location. If this is an uncovered connection template and the location points to a connection line on schematic page, the template automatically becomes covered (i.e. connection is created in the project) Note: When uncovered connection template becomes covered, connections on the page are updated which may affect performance. If this method needs to be called repeatedly, use the Eplan.EplApi.DataModel.DisableConnectionUpdateStep object to make the performance better. (Inherited from Eplan.EplApi.DataModel.Connection)
	Remove	Removes the connection from the Eplan.EplApi.DataModel.Project. (Inherited from Eplan.EplApi.DataModel.Connection)
	RemoveArticleReference	Removes the ArticleReference from the Connecttion (Inherited from Eplan.EplApi.DataModel.Connection)
	SmartLock	Tries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

Connection3D Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback