Type: BCS.Sym3.Equipment.IPath

Represents a path

Properties

Alias

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

BaseProject

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

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

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

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

DoubleRender

  • Description: Gets or sets path double render
  • Type: Boolean
  • Access: Read and Write

DoubleRenderGap

  • Description: Gets or sets path double render gap
  • 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

LineWidth

  • Description: Gets or sets path line width
  • Type: Double
  • Access: Read and Write

LogicalProcessor

  • Description: Gets or sets the logical processor
  • Type: ILogicalProcessor
  • Access: Read and Write
  • 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

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

RailHeight

  • Description: Gets or sets path rail height
  • Type: Double
  • Access: Read and Write

RailWidth

  • Description: Gets or sets path rail width
  • Type: Double
  • Access: Read and Write

RenderMode

  • Description: Gets or sets the type of a path. It can be quad or line. By default, a path is ‘quad’
  • Type: PathRenderMode
  • Access: Read and Write
  • Example:
This example shows you how to set the type


            // set a path to be quad
            Project.Equipment["Path1"].RenderMode = BCS.Sym3.Equipment.PathRenderMode.Quad;
            
            // set a chute to be straight
            Project.Equipment["Path1"].RenderMode = BCS.Sym3.Equipment.PathRenderMode.Line;

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

Sections

  • Description: Gets or sets path sections
  • Type: ObservableCollection`1
  • Access: Read and Write

Selectable

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

SubSystem

  • Description: Gets or sets the Sub System
  • Type: ISubSystem
  • 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

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

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

ZOffset

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

Methods

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 : Path
//
//******************************************************************************

//------------------------------------------------------------------------------
// How to create equipment
//------------------------------------------------------------------------------
var equipment = Project.Equipment.New("Path");
equipment.Name = "MyEquipment";

var obj=Project.Equipment.New("Path");
equipment.Parent=obj;

// How to get parent name
print("Parent:" + equipment.Parent);

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

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

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

// get all Paths: - Does not work!
var entities = Project.Equipment.Paths;
if (entities != null) { print("Paths:" + entities.Count); }

//------------------------------------------------------------------------------
// How to loop
//------------------------------------------------------------------------------
var entities = Project.Equipment.Objects;
for (var i = 0; i < entities.Count; i++) {
  print("Object:" + entities[i].Name);
}

// loop through all Paths
var entities = Project.Equipment.Paths;
if (entities != null) {
  for (var i = 0; i < entities.Count; i++) {
    print("Path:" + entities[i].Name);
  }
}

//------------------------------------------------------------------------------
// 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("Background");
equipment.Color = Project.Colors.Get("Sym3 Red");
equipment.Visible = true;
equipment.DisplayBackFace = false;
equipment.XOffset = 1;
equipment.YOffset = 1;
equipment.ZOffset = 1;
equipment.DirectionOffset = 1;
equipment.TiltOffset = 1;
equipment.RollOffset = 1;

// How to edit Path properties
equipment.Width = 1;
equipment.Length = 2;
equipment.Height = 3;
equipment.LineWidth = 2;

equipment.Sections.Clear();

// set z to non-zero to create a 3D path
var z = 0;

var s1 = new BCS.Sym3.Equipment.PathSection();
s1.AddPoint(0,0,0,0);
s1.AddPoint(20,0,z,0);

var s2 = new BCS.Sym3.Equipment.PathSection();
s2.AddPoint(20,0,z,0);
s2.AddPoint(25,0,z,0);

var s3 = new BCS.Sym3.Equipment.PathSection();
s3.AddPoint(25,0,z,0.3);
s3.AddPoint(30,5,0,0);

var s4 = new BCS.Sym3.Equipment.PathSection();
s4.AddPoint(30,5,z,-0.3);
s4.AddPoint(40,15,0,0);
s4.AddPoint(60,15,z,-0.3);
s4.AddPoint(70,5,0,0);

var s5 = new BCS.Sym3.Equipment.PathSection();
s5.AddPoint(70,5,z,0.3);
s5.AddPoint(75,0,0,0);

var s6 = new BCS.Sym3.Equipment.PathSection();
s6.AddPoint(25,0,z,-0.3);
s6.AddPoint(30,-5,0,0);

var s7 = new BCS.Sym3.Equipment.PathSection();
s7.AddPoint(30,-5,z,0.3);
s7.AddPoint(40,-15,0,0);
s7.AddPoint(60,-15,z,0.3);
s7.AddPoint(70,-5,0,0);

var s8 = new BCS.Sym3.Equipment.PathSection();
s8.AddPoint(70,-5,z,-0.3);
s8.AddPoint(75,0,0,0);

var s9 = new BCS.Sym3.Equipment.PathSection();
s9.AddPoint(75,0,z,0);
s9.AddPoint(80,0,z,0);

var s10 = new BCS.Sym3.Equipment.PathSection();
s10.AddPoint(80,0,z,0);
s10.AddPoint(100,0,0,0);

equipment.Sections.Add(s1);
equipment.Sections.Add(s2);
equipment.Sections.Add(s3);
equipment.Sections.Add(s4);
equipment.Sections.Add(s5);
equipment.Sections.Add(s6);
equipment.Sections.Add(s7);
equipment.Sections.Add(s8);
equipment.Sections.Add(s9);
equipment.Sections.Add(s10);

//------------------------------------------------------------------------------
// How to delete
//------------------------------------------------------------------------------
var equipment = Project.Equipment.Get("MyEquipment");
print("Remove:"+equipment.Name);
Project.Equipment.Remove(equipment);