Type: BCS.Sym3.ITypeMyEquipmentFromType

Definition of a user equipment type based from another type This equipment inherits from another equipment and set some properties

Properties

BasedOnEquipmentType

  • Description: Get the typename of the standard equipment this new type is based on
  • Type: ITypeEquipment
  • Access: Read

BaseProject

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

Children

  • Description: A list of ITypeMyEquipment that are children of this type.
  • Type: IList
  • Access: Read

ComponentClassType

  • Description: Get .Net type
  • Type: Type
  • Access: Read

ComponentDisplayName

  • Description: Display name of component
  • Type: String
  • Access: Read

ComponentModuleName

  • Description: Module name of component
  • Type: String
  • Access: Read

ComponentTypeName

  • Description: Type name of component
  • Type: String
  • Access: Read

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

HasMacroOnCreate

  • Description: If true, this equipment has a macro set.
  • Type: Boolean
  • Access: Read and Write

HasMetadata

  • Description: This type has metadata that need to be saved in project
  • Type: Boolean
  • Access: Read

HasSimulationScript

  • Description: If true, this equipment has a simulation script set.
  • Type: Boolean
  • 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)

IsChild

  • Description: Is true if this MyEquipment has a parent, false otherwise.
  • Type: Boolean
  • Access: Read

IsMaster

  • Description: Is false if this MyEquipment has a parent, true otherwise.
  • Type: Boolean
  • Access: Read

IsTemplatable

  • Description: To know if this type is templatable
  • Type: Boolean
  • Access: Read

IsToolboxAvailable

  • Description: Is available in toolbox
  • Type: Boolean
  • Access: Read

IsValid

  • Description: To know if this type is valid
  • Type: Boolean
  • Access: Read

MacroOnCreate

  • Description: The string used if HasMacroOnCreate is true.
  • Type: String
  • 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

Parent

  • Description: The parent type of this equipment, or null if it has no parent.
  • Type: ITypeMyEquipment
  • Access: Read and Write

SimulationScript

  • Description: The string used if HasSimulationScript is true.
  • Type: String
  • Access: Read and Write

Sym3Product

  • Description: To know in which sym3 product the type is available. Designer/Integrator or Operator
  • Type: Sym3SuiteProduct
  • Access: Read

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

Methods

AddChild(BCS.Sym3.ITypeMyEquipment)

Add a child ITypeMyEquipment.

  • Parameters:
    • child: The type to add as a child. Its name must be unique among the children. Its Parent property will be set to this type.

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

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

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.

RemoveChild(BCS.Sym3.ITypeMyEquipment)

Remove a previously added child. This should be the same instance passed to AddChild.

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