Type: BCS.Sym3.Equipment.IShoeSorter

Represents a shoe sorter

Properties

Acceleration

• Description: Gets or sets the acceleration.
• Type: Double
• Access: Read and Write

AccelerationEnabled

• Description: Gets or sets a value indicating whether [acceleration enabled].
• Type: Boolean
• Access: Read and Write

AccelerationTime

• Description: Gets or sets the acceleration time.
• Type: Double
• Access: Read and Write

Alias

• Description: Gets or sets
• Type: String
• Access: Read and Write

BaseColor

• Description: Gets or sets the color of the base
• Type: IResourceColor
• Access: Read and Write

BaseProject

• Description: Gets the project
• Type: IBaseProject
• Access: Read

BaseVisible

• Description: Gets or sets the visibility of the base
• Type: Boolean
• Access: Read and Write

BillboardText

• Description: Gets or sets the billboard text.
• Type: String
• Access: Read and Write

BoundProperties

• Description: Gets the list of bound properties
• Type: ObservableCollection`1
• Access: Read

ChainStretchProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

ChainStretchProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

Children

• Description: Get list of children (only for MyEquipment instances)
• Type: List`1
• Access: Read

Color

• Description: Gets or sets the color of the equipment
• Type: IResourceColor
• Access: Read and Write

ConnectionDestination

• Description: Gets or sets - TO BE DOCUMENTED
• Type: IBaseEquipment
• Access: Read and Write

ConnectionDestinationDistance

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

ConnectionSource

• Description: Gets or sets - TO BE DOCUMENTED
• Type: IBaseEquipment
• Access: Read and Write

ConnectionSourceDistance

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

Deceleration

• Description: Gets or sets the deceleration.
• Type: Double
• Access: Read and Write

DecelerationTime

• Description: Gets or sets the deceleration time.
• Type: Double
• Access: Read and Write

DefaultSpeed

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

Direction

• Description: Gets or sets the direction of the equipment. In degrees
• Type: Double
• Access: Read and Write

DirectionOffset

• Description: Gets or sets the direction offset. In degrees
• Type: Double
• Access: Read and Write

DisplayBackFace

• Description: Gets or sets whether to render back face
• Type: Boolean
• Access: Read and Write

DisplayTypeName

• Description: Gets the display name of the type name of the object. It returns the english display name of the type name.
• Type: String
• Access: Read

DistanceTravelled

• Description: Gets The distance Travel by the transporter measured in the currently defined system units.
• Type: UInt32
• Access: Read

DivertAngle

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

EnableEncoder

• Description: Gets or sets The flag to enable calculation for distance Travel by the transporter
• Type: Boolean
• Access: Read and Write

Height

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

Id

• Description: Gets the globally unique identifier (GUID) id of the object. This unique identifier is generated once at the object creation. This id will be kept unique for the entire life of the object, event after saving/loading the project.
• Type: Guid
• Access: Read and Write
• Example:

This example shows how to get the id of an object in a string format. The following script will output a string like 'b3122ae0-dcf7-43b6-b17c-5381afaca5cb'

            strid = Project.Colors.Get("myColor").Id.ToString();
            print(strid)
            

InheritedTypeName

• Description: Get typename, if this is a MyEquipment type from standard type, returns the typename of the inherited equipment
• Type: String
• Access: Read

IsUserDefined

• Description: Indicates if this equipment is a User Defined one
• Type: Boolean
• Access: Read

Layer

• Description: Gets or sets the layer the equipment belongs to.
• Type: ILayer
• Access: Read and Write

LayerId

• Description: Gets or sets the layer ID the equipment belongs to.
• Type: Nullable`1
• Access: Read and Write

LeftShoeConfirmProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

LeftShoeConfirmProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

LeftShoeDetectProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

LeftShoeDetectProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

Length

• Description: Gets - TO BE DOCUMENTED
• Type: Double
• Access: Read

LogicalProcessor

• Description: Gets or sets the logical processor
• Type: ILogicalProcessor
• Access: Read and Write

MaxDistanceTravelled

• Description: Gets or sets the Max value for distance Travel by the transporter in the currently defined system units.
• Type: UInt32
• Access: Read and Write

Menu

• Description: Gets or sets the associated menu
• Type: IResourceMenu
• Access: Read and Write

Name

• Description: Gets or sets the name of the object. All objects of the same type have a unique name.
• Type: String
• Access: Read and Write
• Example:

This example shows how to get and set the name of an object.

            // get the color name
            colorname = Project.Colors.Get("myColor").Name;
            
            // set the color name
            Project.Colors.Get("myColor").Name = "myNewName";
            

NameSuffix

• Description: The project explorer will display this after the Name of this object.
• Type: String
• Access: Read

NumSlats

• Description: Gets - TO BE DOCUMENTED
• Type: Int32
• Access: Read

OperationMode

• Description: Gets or sets the operation mode. Can be one of the following string value:

        "ScreeningStationController"
        "CascadeController"
        "MergeSourceController" use this one for "Window Reservation" mode
        "InductorController"
        "ExternalController"
  

• Type: String

• Access: Read and Write

Parent

• Description: Gets
• Type: IBaseEquipment
• Access: Read and Write

PrePositionerPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

PrePositionerProxOffset

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

PrePositionerProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

PrePositionShoe

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read and Write

RightShoeConfirmProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

RightShoeConfirmProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

RightShoeDetectProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

RightShoeDetectProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

Roll

• Description: Gets or sets the roll of the equipment. In degrees
• Type: Double
• Access: Read and Write

RollOffset

• Description: Gets or sets the roll offset. In degrees.
• Type: Double
• Access: Read and Write

Running

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read and Write

Selectable

• Description: Gets or sets whether equipment is selectable.
• Type: Boolean
• Access: Read and Write

ShoeDetectPE

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

ShoeDiverters

• Description: Gets or sets - TO BE DOCUMENTED
• Type: List`1
• Access: Read and Write

ShoesColor

• Description: Gets or sets the color of all the shoes
• Type: IResourceColor
• Access: Read and Write

ShoesVisible

• Description: Gets or sets the visibility of all the shoes
• Type: Boolean
• Access: Read and Write

SlatsColor

• Description: Gets or sets the color of all the slats
• Type: IResourceColor
• Access: Read and Write

SlatsVisible

• Description: Gets or sets the visibility of all the slats
• Type: Boolean
• Access: Read and Write

SlatWidth

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

Speed

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

StartStopRequest

• Description: Gets or sets the Start Stop request flag of the sorter
• Type: Boolean
• Access: Read and Write

StartStopStatus

• Description: Gets Start Stop Status Text of the sorter
• Type: String
• Access: Read

SubSystem

• Description: Gets or sets the Sub System
• Type: ISubSystem
• Access: Read and Write

TargetSpeed

• Description: Gets or sets the target speed.
• Type: Double
• Access: Read and Write

Template

• Description: Gets or sets the template
• Type: ITemplate
• Access: Read and Write

Tilt

• Description: Gets or sets the tilt of the equipment. In degrees
• Type: Double
• Access: Read and Write

TiltOffset

• Description: Gets or sets the tilt offset. In degrees
• Type: Double
• Access: Read and Write

TypeName

• Description: Gets the typename of the object. A type name doesn’t contain any space characters.
• Type: String
• Access: Read

UseAccelerationTime

• Description: Gets or sets a value indicating whether [use acceleration time].
• Type: Boolean
• Access: Read and Write

UserPropertyInstances

• Description: Gets a list of all the instances of user properties.
• Type: ObservableCollection`1
• Access: Read

Visible

• Description: Gets or sets the visibility of the equipment
• Type: Boolean
• Access: Read and Write

Width

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

X

• Description: Gets or sets the X position of the equipment
• Type: Double
• Access: Read and Write

XOffset

• Description: Gets or sets the offset in the X direction
• Type: Double
• Access: Read and Write

Y

• Description: Gets or sets the Y position of the equipment
• Type: Double
• Access: Read and Write

YOffset

• Description: Gets or sets the offset in the Y direction
• Type: Double
• Access: Read and Write

Z

• Description: Gets or sets the Z position of the equipment
• Type: Double
• Access: Read and Write

ZeroShoeDetectProxPos

• Description: Gets or sets - TO BE DOCUMENTED
• Type: Double
• Access: Read and Write

ZeroShoeDetectProxStatus

• Description: Gets - TO BE DOCUMENTED
• Type: Boolean
• Access: Read

ZOffset

• Description: Gets or sets the offset in the Z direction
• Type: Double
• Access: Read and Write

Methods

ActionStart

Starts the shoe sorter

ActionStop

Stops the shoe sorter

AddShoeDiverter(BCS.Sym3.IBaseEquipment,System.Double,System.Boolean,System.Double)

Create and add a new shoe diverter to the ShoeDiverters collection the exit equipmentdiverter distance on the sorterdivert shoeprox offset on the sorter

ForceRename(System.String,System.Boolean)

Rename the object.

• Parameters:
  • value: The new name.
  • fireChangingEvent: If false, no change event will fire. In particular, this disables the check for duplicate names, which can be costly as it has to check every equipment. The caller is responsible for ensuring that value is a unique name, or Bad Things will happen.

FromXmlString(BCS.IToolXmlToObjectHelper)

Init object from IToolXmlToObjectHelper. All properties found in the RootElement of IToolXmlToObjectHelper will be set with the value in the rootElement

• Parameters:
  • xmlHelperObj: xmlHelperObj IToolXmlToObjectHelper

FromXmlString(System.String)

Init object from xml. All properties found in the xml will be set with the value in the xml file

• Parameters:
  • xmlText: Xml string

FromXmlString(System.Xml.Linq.XElement)

Init object from root element. All properties found in the XElement will be set with the value in the XElement

• Parameters:
  • objXml: objXml XElement

GetBoundProperty(System.String)

Gets a bound property by property name

• Parameters:
  • propertyName: Property name
• Returns:
  • Returns bound property. Null if not found
• Example:

This example shows you how to get a binding on a property if this one exists

            // get control:
            var td = Project.Windows["Window1"]["Text Display1"]
            
            // bind property 'Value'
            var boundProperty = td.GetBoundProperty("Value")
            

GetCopyPasteXml

Converts the object into an XML string including overrides for for copy/paste functionality

• Returns:
  • the string that contains xml version of the object for copy/paste

GetPropertyValues

Get all properties and values that are different from default values

GetUserPropertyInstance(System.String)

Gets the user property instance of the specified name

• Parameters:
  • userPropertyName: The user property name.
• Returns:
  • Returns the user property instance object. If not found, the methods returns null.
• Example:

This example shows how to set the value of a user property by using this method

            cc1 = Project.Equipment.Get("CC1");
            
            // get the value of a user property using the method
            userPropertyInstance = cc1.GetUserPropertyInstance("UserProperty1");
            if(userPropertyInstance != null) {
               userPropertyInstance.Value = 3;
            }
            

GetUserPropertyValue(System.String)

Gets the value of a user property. A better way to get the value of a user property is to use the indexer operator [], see example. Instead of using the method ‘GetUserPropertyInstance’ and then access the ‘Value’ property of the returned value, this method simplifies the way we get the value of a user property.

• Parameters:
  • userPropertyName: The name of the user property to set.
• Returns:
  • Returns null if user property is not found. Otherwise returns the value of the user property.
• Example:

This example shows how to get the value of a user property using this method and also by using the indexer

            cc1 = Project.Equipment.Get("CC1");
            
            // get the value of a user property using the method
            val = cc1.GetUserPropertyValue("UserProperty1");
            
            // get the value of a user property using the indexer operator
            val = cc1["UserProperty1"];
            

IsUserProperty(System.String)

Indicates if the object contains a user property with the name you specify

• Parameters:
  • userPropertyName: user property name
• Returns:
  • Returns true if the object contains a user property with the name you specified in parameter.

NewBoundProperty(System.String)

Creates a new bound property

• Parameters:
  • propertyName: Name of property to bind
• Returns:
  • If the property (propertyName) doesn’t exist for this object type, no bound property will be created so this method will return null.
• Example:

This example shows you how to bind a property

            // get control:
            var td = Project.Windows["Window1"]["Text Display1"]
            
            // bind property 'Value'
            var boundProperty = td.NewBoundProperty("Value")
            
            // set expression:
            boundProperty.Expression = "%caller.Name%_Running";
            
            // create a mapping:
            boundProperty.AddMapping("1", "It is true");
            boundProperty.AddMapping("0", "It is false");
            

RemoveBoundProperty(System.String)

Removes a binding

• Parameters:
  • propertyName:
• Example:

This example shows you how to remove a binding on a property

            // get control:
            var td = Project.Windows["Window1"]["Text Display1"]
            
            // remove data binding on property 'Value'
            td.RemoveBoundProperty("Value")
            

ReplaceEquipmentSpecificMarkup(System.String,System.String)

Gets a list of expressions that have had any markup replaced by the equipment specific tag identifier

• Parameters:
  • expression: The expression that needs to be parsed for markup
  • property: property name associated with the expression

SetUserPropertyValue(System.String,System.Object)

Sets the value of a user property. A better way to set the value of a user property is to use the indexer operator [], see example. Instead of using the method ‘GetUserPropertyInstance’ and then access the ‘Value’ property of the returned value, this method simplifies the way we set the value of a user property.

• Parameters:
  • userPropertyName: The name of the user property to set.
  • value: If the user property is not found, this methods does nothing.
• Example:

This example shows how to set the value of a user property using this method and also by using the indexer

            cc1 = Project.Equipment.Get("CC1");
            
            // set the value of a user property using the method
            cc1.SetUserPropertyValue("UserProperty1", 3);
            
            // set the value of a user property using the indexer operator
            cc1["UserProperty1"] = 3;
            

ToCSVString(System.Char)

Returns the object in a CSV string.

• Returns:
  • A string that contains properties of the object in a CSV format.

ToXmlString

Converts the object in an xml string

• Returns:
  • the string that contains xml version of the object

Examples:

//******************************************************************************
// HOW TO : ShoeSorter
//
//******************************************************************************


//------------------------------------------------------------------------------
// How to create equipment
//------------------------------------------------------------------------------

// create a new shoe diverter
var newEntity = Project.Equipment.NewShoeDiverter()


//------------------------------------------------------------------------------
// How to access equipment
//------------------------------------------------------------------------------

// get by name using method 'Get'
var entity1 = Project.Equipment.Get("CC1")
print("Get entity by name: " + entity1.Name)

// get by name using operator []
var entity2 = Project.Equipment["CC1"]
print("Get entity by name: " + entity2.Name)

// get by index:
var entity3 = Project.Equipment[0]
print("Get entity by index: " + entity3.Name)



// get all shoe sorters
var entities = Project.Equipment.ShoeSorters;
if (entities != null) { print(entities.Count); }



//------------------------------------------------------------------------------
// How to loop
//------------------------------------------------------------------------------

// loop through all equipment types:
var entities = Project.Equipment.Objects;
for (var i = 0; i < entities.Count; i++) {

    print(entities[i].Name);
}

// loop through all conveyors
var entities = Project.Equipment.Conveyors;
if (entities != null) {

    for (var i = 0; i < entities.Count; i++) {

        print(entities[i].Name);
    }
}




//------------------------------------------------------------------------------
// How to delete
//------------------------------------------------------------------------------

// remove entity
var equipment = Project.Equipment.Get("CC1")
Project.Equipment.Remove(equipment)


//------------------------------------------------------------------------------
// How to edit common properties
//------------------------------------------------------------------------------


equipment.Alias = "the alias";


equipment.X = 1;
equipment.Y = 2;
equipment.Z = 3;
equipment.Direction = 4;
equipment.Tilt = 5;
equipment.Roll = 6;
equipment.Selectable = false;
equipment.Layer = Project.Layers.Get("Layer1");
equipment.DisplayBackFace = false;
equipment.XOffset = 1;
equipment.YOffset = 1;
equipment.ZOffset = 1;
equipment.DirectionOffset = 1;
equipment.TiltOffset = 1;
equipment.RollOffset = 1;

// get parent name
print(equipment.Parent);

// set operation mode:
equipment.OperationMode = "ScreeningStationController";
equipment.OperationMode = "CascadeController";
equipment.OperationMode = "MergeSourceController";
equipment.OperationMode = "InductorController";
equipment.OperationMode = "ExternalController";




//------------------------------------------------------------------------------
// How to edit shoe sorter properties
//------------------------------------------------------------------------------

var sorter = Project.Equipment.Get("MyEquipment")

// set properties

//---- General

sorter.ConnectionSource = Project.Equipment.Get("CC1");
sorter.ConnectionSourceDistance = 0.1;
sorter.ConnectionDestination = Project.Equipment.Get("CC2");
sorter.ConnectionDestinationDistance = 0.2;

var shoeDiverters = sorter.ShoeDiverters;
for (i = 0; i < shoeDiverters.Count; i++) {

    var shoeDiverter = shoeDiverters[i];

    print(shoeDiverter.Exit);
    shoeDiverter.Exit = Project.Equipment.Get("A1");

    print(shoeDiverter.Rule);
    shoeDiverter.Rule = Project.Equipment.Get("Rule1");

    print(shoeDiverter.Distance);
    shoeDiverter.Distance = 1;

    print(shoeDiverter.Divert);
    shoeDiverter.Divert = true;

    print(shoeDiverter.ProxOffset);
    shoeDiverter.ProxOffset = 1;

    print(shoeDiverter.ProxStatus);
    shoeDiverter.ProxStatus = true;
}

//---- Geometry

sorter.Width = 1;
sorter.Height = 1;
sorter.SlatWidth = 1;

// get only:
print(sorter.Length);
print(sorter.NumSlats);

//---- Kinematrics

sorter.Speed = 1;
sorter.DefaultSpeed = 1;
sorter.Running = true;
sorter.DivertAngle = 1;
sorter.PrePositionerPos = 1;
sorter.PrePositionShoe = true;
sorter.PrePositionerProxOffset = 1;
sorter.ZeroShoeDetectProxPos = 1;
sorter.LeftShoeDetectProxPos = 1;
sorter.RightShoeDetectProxPos = 1;
sorter.LeftShoeConfirmProxPos = 1;
sorter.RightShoeConfirmProxPos = 1;
sorter.ChainStretchProxPos = 1;

// get only:
print(sorter.ShoeDetectPE);
print(sorter.PrePositionerProxStatus);
print(sorter.ZeroShoeDetectProxStatus);
print(sorter.LeftShoeDetectProxStatus);
print(sorter.RightShoeDetectProxStatus);
print(sorter.LeftShoeConfirmProxStatus);
print(sorter.RightShoeConfirmProxStatus);
print(sorter.ChainStretchProxStatus);


//---- Visual

sorter.BaseColor = Project.Colors.Get("Sym3 Red")
sorter.BaseVisible = true;


//---- Actions

sorter.ActionStart();
sorter.ActionStop();