Software Customisation Reference Manual

Name	Returns	Arguments	Description	Remarks
OwningDbBranch	DBREF		Returns owner branch element of this route point.
OwningRoute	mdrRoute		Returns owning mdrRoute	Redundant? - could be constructed easily from OwningDbBranch
IsEqual	bool	mdrRoutePoint	Returns true if objects are equal	Checks first if the objects could be compared by under lying DB element. If not the position On is used
ExpandToRoute	mdrRoute		Expands external geometry to mdrRoute object.
IsExternalGeometry	bool		Returns true if its an external geometry object.
EndingRoutePoint		mdrRoutePoint	Sets end external geometry ending route point.	Valid only if this is a external geometry type route point
EndingRoutePoint	mdrRoutePoint		Gets end external geometry ending route point.	Valid only if this is a external geometry type route point
StartingRoutePoint		mdrRoutePoint	Sets end external geometry starting route point.	Valid only if this is a external geometry type route point
StartingRoutePoint	mdrRoutePoint		Gets end external geometry starting route point.	Valid only if this is a external geometry type route point
Position	Position		Gets position of the route point in world coordinates.	Valid only if this isn't an external geometry type route point. If there is DB element owned then gets the world position, otherwise its stored as world position inside an object
Position		Position	Sets position of the route point in world coordinates.	Valid only if this isn't an external geometry type route point. If there is DB element owned then sets the local position, converting it before from world coordinates, otherwise sets the world position inside an object
Radius	Real		Get the fillet radius of route point
Radius		Real	Set the fillet radius of route point	Valid only if this isn't an external geometry type route point. If there is DB element owned then sets the filet radius, otherwise sets the radius inside the object
Clone	mdrRoutePoint		Returns cloned object	Clones all the attributes taken from object which from this method is invoked (besides underlying DB element, and name)
Name	String		Gets the name of named route point
Is That		String type	Returns true if the named types match	Compares if the type is the same with passed as argument.
Type	String		Gets the type of route point object
Type		String type	Sets the type of route point object	behaviour not specified
DbElement	DBREF		Gets the underlying DB element.
IsEnabled	bool		Check if element is enables.
IsNamed			Checks if element is named
IsOn			true if route point are on the same position	true if route point are on the same position
DbElement		DBREF	Sets owned DB element.
Enable		bool enabled	Enables or disables route point.	enable true if we want to enable route point otherwise false

Name	Returns	Arguments	Description	Remarks
dbWrite	bool	DBREF	Writes to DB hierarchy. Argument specify where to method should write to.	Returns true if write was successful
dbUpdate	bool		Updates DB hierarchy.	Returns true if write was successful
clone	mdrRoute		Returns cloned object	Clones all the attributes taken from object which from this method is invoked (besides underlying DB element, and name)
DbElement	DBREF		Gets the underlying DB element.
DbElement		DBREF	Sets the underlying element.	Method changes ownership
Construct		DBREF	Constructs route point from DB
Equals	Bool		Checks for equality of elements
HeadRoutePoint	mdrRoutePoint		Gets head route point
TailRoutePoint	mdrRoutePoint		Gets tail route point
HeadRoutePoint		mdrRoutePoint	Sets head route point
TailRoutePoint		mdrRoutePoint	Sets tail route point
InsertRoutePointAtHead		mdrRoutePoint	Inserts route point at head
InsertRoutePointAtTail		mdrRoutePoint	Inserts route point at tail
InsertRoutePoint		mdrRoutePoint	Insert route points at chosen index
RemoveRoutePoint		mdrRoutePoint	Remove route point from route
FindRoutePoint		mdrRoutePoint	Gets route index of route point (0 based)
RoutePoints		Array of mdrRoutePoint	Gets route points
InsertRouteAtHead		mdrRoute	Merge two routes on head
InsertRouteAtTail		mdrRoute	Appends route at end
insert Route		mdrRoute, mdrRoutePoint	Inserts route at route point
ExpandToRoute			Expands all the ext geom. into route
ExpandRoutePoint	mdrRoute	mdrRoutePoint	In place expand of ext geom.
size	real		number of route points in route
at	mdrRoutePoint	real	Route Point at
SubRoute	mdrRoute	mdrRoutePoint, mdrRoutePoint	Cuts the route between two route points
HeadSubRoute	mdrRoute	mdrRoutePoint	Creates sub route from head to route point
TailSubroute	mdrRoute	mdrRoutePoint	Creates sub route from route point to tail
Transform		Orientation	Transforms route
Length	Real		Calculates route length
Length	Real	mdrRoutePoint, mdrRoutePoint	Length between two route points
Length From	Real		Length from route point

Name	Returns	Arguments	Description	Remarks
CreateRoutePoint	mdrRoutePoint	Position	Route point from pos
CreateRoutePoint	mdrRoutePoint	DBREF	Route Point from dbref
CreateRoutePoint	DBREF		Route from dbref
FindRoute	Array of mdrConectionPoint	mdrConnectionGraph, mdrRoutePoint,mdrRoutePoint	For given connection graph, and two RoutePoints, find the best path between these route points
BeginInteractiveRoutePointsEditing		mdrRoute	Enter Route point model editor for given route
BeginInteractiveQuickRouting		mdrRoute	Enter Quick Routing model editor for given route

Name	Returns	Arguments	Description	Remarks
CreateRouteFromConnectionPoints	mdrRoute	Array of mdrConnectionPoints	For given path described by connection points array create route
CreateConnectionGraphFromOwner	mdrConnectionGraph	DBREF	For given owner, create connection graph
CreateConnectionGraphFromBranches	mdrRoute	Array of DBREF	For given array of dbrefs, create a connection graph
CreateConnectionByGeometryFrombranches		Array of DBREF	Connect list of branches base on their positions
CreateConnectionsByGeometryFromOwner		DBRF	Connect owning branches element based on their pos
GetConnectedAttasToAtta	ARRAY of DBREF	DBREF	Connected attas from atta

Name	Returns	Arguments	Description	Remarks
GetConnectionPoint	mdrConnectionPoint	mdrRoutePoint	For given route point return connection point
GetAllConnectionPoints	Array of mdrConnectionPoints		Get connection point list

Name	Returns	Arguments	Description	Remarks
getRoutePoint	mdrRoutePoint		Get route point
getConnectedRoutePoint	mdrRoutePoint		Get connected route point
getFirstConnectionType	Real		0- head, 1- tail, 2- mid, 3- free, 4- none
getSecondConnectionType	Real		0- head, 1- tail, 2- mid, 3- free, 4- none