Eplan Platform API
Eplan.EplApi.DataModel Namespace / PlcIOPropertyList Class
Members Example

In This Topic
    PlcIOPropertyList Class
    In This Topic
    This class represents collection of properties of PlcIO class. Please check also base classes for other properties which are available for PlcIO objects: StorableObjectPropertyList
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.PlcIOPropertyList

    Syntax
    [DefaultMember("Property")]
public class PlcIOPropertyList : StorableObjectPropertyList 
    [DefaultMember("Property")]
public ref class PlcIOPropertyList : public StorableObjectPropertyList
    Remarks
    It uses operator[] in order to access its elements (stored properties).

    Property list is a container for property values and just like them can be online or offline. If property list is online it means that is associated with properties of some StorableObject or other property list. In this case if any property is added, changed or removed from property list the result is also visible in related objects. Whether property list is online or offline is being determine in time of it's creation and can not be changed.

    Example
    Example shows usage of online an offline property list: 
    //creation of online property list
FunctionPropertyList oPropertyListOnline1 = oFunction.Properties;
oPropertyListOnline1.FUNC_COMMENT = "Comment";
//now oFunction.Properties.FUNC_COMMENT is equal "Comment"

FunctionPropertyList oPropertyLineOnline2 = new FunctionPropertyList(oFunction);
oPropertyLineOnline2.FUNC_COMMENT = "Test";
//now oFunction.Properties.FUNC_COMMENT is equal "Test"

//creation of offline property list
FunctionPropertyList oPropertyLineOffline = new FunctionPropertyList();
oPropertyLineOffline.FUNC_COMMENT = "Test comment";
oFunction.Properties.FUNC_COMMENT = oPropertyLineOffline.FUNC_COMMENT;
oPropertyLineOffline.FUNC_COMMENT = "Offline comment";
//now oPropertyLineOffline.FUNC_COMMENT is equal "Test comment"
    Public Constructors
     NameDescription
    Public ConstructorPlcIOPropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAUTOMATIONML_OBJECTIDAutomationML GUID # 25030.  
    Public PropertyAUTOMATIONML_OBJECTID_2AutomationML GUID 2 # 25031.  
    Public PropertyExistingIdsReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyExistingValuesReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyFUNC_PLC_SIGNALRANGESignal range # 20388.  
    Public PropertyFUNC_PLCCONFIGURATIONPROJECT_INDIRECTConfiguration project (indirect) # 20108.  
    Public PropertyFUNC_PLCCPU_INDIRECTCPU (indirect) # 20434.  
    Public PropertyFUNC_PLCSTATIONNAME_INDIRECTPLC station: ID (indirect) # 20420.  
    Public PropertyFUNC_PLCTERMINAL_INDEX_OF_STARTADDRESSPLC subdevice: Index # 20384.  
    Public PropertyFUNC_PLCTERMINAL_NO_ADRESSINGDo not include in addressing # 20380.  
    Public PropertyFUNCTION_PLCIMPORTCOMPARE_MARKEDTOBEDELETEDMarked for deletion # 20186.  
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPLCIOENTRY_COMMUNICATIONENTITY_NAMEName of the communication unit # 23400.  
    Public PropertyPLCIOENTRY_DIRECTIONDirection # 23403.  
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Top
    Public Methods
     NameDescription
    Public MethodCopyToOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDispose()Destructor for deterministic finalization of PlcIOPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodExistsOverloaded. Checks property existence for used obiect.  
    Public MethodgetPropListInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also

    Reference

    PlcIOPropertyList Members
    Eplan.EplApi.DataModel Namespace
    PlcIO Class
    StorableObjectPropertyList Class

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support