Type: BCS.Sym3.ITag

Tag Remarks: Available in Integrator and Operator only

Properties

Address

  • Description: Address: Previously called DataPoint. Example: [GT01].MDEConv[1].StatusPE1
  • Type: String
  • Access: Read and Write

BaseProject

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

Comment

  • Description: Get/Set ‘Comment’ - For Integrator Only. Same as calling EquipmentProperty.Comment
  • Type: String
  • Access: Read and Write

CurrentQuality

  • Description: Current Quality (Read Only): Quality when attempting to read the tag from the editor
  • Type: String
  • Access: Read and Write

CurrentValue

  • Description: Current Value (Read Only): Value when attempting to read the tag from the editor
  • Type: String
  • Access: Read and Write

DataSource

  • Description: Data Source: Choice of configured datasources of type OPC DA
  • Type: IDataSource
  • Access: Read and Write

DataType

  • Description: Data type
  • Type: TagDataType
  • 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

EquipmentIOType

  • Description: Get/Set ‘EquipmentIOType’ - For Integrator Only. Same as calling EquipmentProperty.EquipmentIOType
  • Type: TagEquipmentIOType
  • Access: Read and Write

EquipmentName

  • Description: Get/Set ‘Equipment Name’ - For Integrator Only. Same as calling EquipmentProperty.EquipmentName
  • Type: String
  • Access: Read and Write

EquipmentProperty

  • Description: EquipmentProperty associated with this tag
  • Type: ITagEquipmentProperty
  • Access: Read and Write

EquipmentPropertyName

  • Description: Get/Set ‘EquipmentPropertyName’ - For Integrator Only. Same as calling EquipmentProperty.EquipmentPropertyName
  • Type: String
  • Access: Read and Write

EquipmentType

  • Description: Get/Set ‘EquipmentType’ - For Integrator Only. Same as calling EquipmentProperty.EquipmentType
  • Type: String
  • 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)

InvertedLogic

  • Description: Get/Set ‘InvertedLogic’ - For Integrator Only. Same as calling EquipmentProperty.InvertedLogic
  • Type: Boolean
  • Access: Read and Write

IsEnabled

  • Description: Ability to enable/disable a tag. By default a tag is enabled.
  • Type: Boolean
  • Access: Read and Write

IsPrimaryBitWordTag

  • Description: Is Primary Bit Word Tag: If true, sym3 treats this as 16 bit array
  • Type: Boolean
  • Access: Read and Write

IsSecondaryBitWordTag

  • Description: Is Secondary BitWord Tag: Is true means this tag is a bitword tag, which represents a single bit in the 16 bit primary bitword tag
  • Type: Boolean
  • Access: Read

LiveValueServiceTagIndex

  • Description: Live Value Service Tag Index
  • Type: Int32
  • 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

OpcTag

  • Description: OPC Data tag reference
  • Type: IOPCTag
  • Access: Read and Write

OperatorBitwordIOType

  • Description: Gets or sets the type of bitword: input or output Available in Operator only
  • Type: OperatorTagIOType
  • Access: Read and Write

OverrideTag

  • Description: Indicates whether this tag’s override value is in effect
  • Type: Boolean
  • Access: Read

OverrideValue

  • Description: The value of the tag being overridden
  • Type: String
  • Access: Read

OverrideValueEnabled

  • Description: Indicates if this tag’s override value can be set.
  • Type: Boolean
  • Access: Read

PrimaryBitWordTag

  • Description: Primary BitWord Tag: This is a reference to the primary bitword tag. This is only populated for secondary bitword tags.
  • Type: ITag
  • Access: Read

ScriptHandler

  • Description: Get/Set ‘ScriptHandler’ - For Integrator Only. Same as calling EquipmentProperty.ScriptHandler
  • Type: String
  • Access: Read and Write

SecondaryBitWordTags

  • Description: Secondary BitWord Tags: This is a list of secondary bitword tags that make up the primary bitword tag. Only populated if its a Primary Bitword tag.
  • Type: ObservableCollection`1
  • Access: Read

SecondaryTagOrder

  • Description: Secondary Tag Order: This specifies the secondary bitword tags position in the primary bitword tag array.
  • Type: Int32
  • Access: Read

SimulateTag

  • Description: Simulate Tag: If true, sym3 treats this as internal tag (server side)
  • Type: Boolean
  • Access: Read and Write

SimulateTagReadOnly

  • Description: Tells if SimulateTag is forced (That’s the case for PLC Emulation)
  • Type: Boolean
  • Access: Read

SupportsSimulateTag

  • Description: Indicates if this tag support the ‘SimulateTag’ property
  • Type: Boolean
  • Access: Read

SupportsUpdateRate

  • Description: Indicates if this tag support the ‘UpdateRate’ property
  • Type: Boolean
  • Access: Read

TypeName

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

UpdateRate

  • Description: Update Rate: if zero, the OPC server default is used in miliseconds
  • Type: Int32
  • Access: Read and Write

UserPropertyInstances

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

Methods

DataConversion(System.Object)

Convert Tag Value to String

  • Parameters:
    • value: Tag Value to Covert to String
  • Returns:
    • String

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.

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