LogicalSystemsRouting Functions Functions

This page describes how you can customize the routing of logical connections by adding your own business rules.

This page discusses:

RFLVPMLogicalConnection.GetLogicalRoutingAttributes()

This function gets the logical routing attribute values of the passed in logical Connection.

Signature

RFLVPMLogicalConnection.GetLogicalRoutingAttributes(Segregation : String, UserLength : Real, RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalConnection.GetPhysicalRoutingAttributes()

This function gets the physical routing attribute values of the passed in logical Connection.

Signature

RFLVPMLogicalConnection.GetPhysicalRoutingAttributes(Segregation : String, UserLength : ,Real RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalConnection.GetRoutingAttributes()

This function is obsolete.

Signature

RFLVPMLogicalConnection.GetRoutingAttributes(Segregation : String, UserLength : Real, RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalConnection.LogicalRouteOfRoutableObject()

This function gets the pointed Pathway Segments on the passed in Logical instance, if there are some.

Signature

RFLVPMLogicalConnection.LogicalRouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalConnection.PhysicalRouteOfRoutableObject()

This function gets the pointed Branch Segments on the passed in Logical instance, if there are some.

Signature

RFLVPMLogicalConnection.PhysicalRouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalConnection.RoutableObjectsRoutedTogether()

This function gets on the passed in Logical Instance: both the other routables sharing the same routing parameters and the list of routables routed in the same segments.

Signature

RFLVPMLogicalConnection.RoutableObjectsRoutedTogether() : List

ReturnType

List

RFLVPMLogicalConnection.RouteOfRoutableObject()

This function is obsolete.

Signature

RFLVPMLogicalConnection.RouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalConnection.SetLogicalRoutingAttributes()

This function sets the properties defining the logical routing of the given logical connection.

Signature

RFLVPMLogicalConnection.SetLogicalRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalConnection.SetPhysicalRoutingAttributes()

This function sets the properties defining the physical routing of the given logical connection.

Signature

RFLVPMLogicalConnection.SetPhysicalRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalConnection.SetRoutingAttributes()

This function sets the routing attributes (Segregation and UserLength) on the passed in Logical Instance.

Important: This function is obsolete.

Signature

RFLVPMLogicalConnection.SetRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.GetLogicalRoutingAttributes()

This function retrieves the properties defining the logical routing of the given logical instance.

Signature

RFLVPMLogicalInstance.GetLogicalRoutingAttributes(Segregation : String, UserLength : Real, RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.GetPhysicalRoutingAttributes()

This function retrieves the properties defining the physical routing of the given logical instance.

Signature

RFLVPMLogicalInstance.GetPhysicalRoutingAttributes(Segregation : String, UserLength : Real, RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.GetRoutingAttributes()

This function is obsolete.

Signature

RFLVPMLogicalInstance.GetRoutingAttributes(Segregation : String, UserLength : Real, RoutedLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation Out Yes String -
UserLength Out Yes Real -
RoutedLength Out Yes Real -
RoutingType Out Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.LogicalRouteOfRoutableObject()

This function retrieves the list of Logical Pathway Segments in which the given Logical instance is routed.

Signature

RFLVPMLogicalInstance.LogicalRouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalInstance.PhysicalRouteOfRoutableObject()

This function retrieves the list of Physical Branch Segments in which the given Logical instance is routed.

Signature

RFLVPMLogicalInstance.PhysicalRouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalInstance.RoutableObjectsRoutedTogether()

This function retrieves the list of routables sharing the same properties and route than the given Logical Instance.

Signature

RFLVPMLogicalInstance.RoutableObjectsRoutedTogether() : List

ReturnType

List

RFLVPMLogicalInstance.RouteOfRoutableObject()

This function is obsolete.

Signature

RFLVPMLogicalInstance.RouteOfRoutableObject() : List

ReturnType

List

RFLVPMLogicalInstance.SetLogicalRoutingAttributes()

This function sets the properties defining the logical routing of the given logical instance.

Signature

RFLVPMLogicalInstance.SetLogicalRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.SetPhysicalRoutingAttributes()

This function sets the properties defining the physical routing of the given logical instance.

Signature

RFLVPMLogicalInstance.SetPhysicalRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean

RFLVPMLogicalInstance.SetRoutingAttributes()

This function is obsolete.

Signature

RFLVPMLogicalInstance.SetRoutingAttributes(Segregation : String, UserLength : Real, RoutingType : String, ReturnMessage : String) : Boolean

Arguments

Name Input/Output Required? Type Comment
Segregation In Yes String -
UserLength In Yes Real -
RoutingType In Yes String -
ReturnMessage Out Yes String -

ReturnType

Boolean