Eplan Platform API
Eplan.EplApi.DataModel.Planning Namespace / PlanningSegmentPropertyList Class
Members Example

In This Topic
    PlanningSegmentPropertyList Class
    In This Topic
    This class represents collection of properties of PlanningSegment class. Please check also base classes for other properties which are available for PlanningSegment objects: Eplan.EplApi.DataModel.StorableObjectPropertyList
    Inheritance Hierarchy
    Syntax
    [DefaultMember("Property")]
    public class PlanningSegmentPropertyList : Eplan.EplApi.DataModel.StorableObjectPropertyList 
    [DefaultMember("Property")]
    public ref class PlanningSegmentPropertyList : public Eplan.EplApi.DataModel.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 ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyAutomationML GUID # 25030.  
    Public PropertyDocument type (main identifier) # 1500.  
    Public PropertyDocument type (main identifier): Description # 1530.  
    Public PropertyDocument type (leading identifiers) # 1522.  
    Public PropertyDocument type (single component) # 1528.  
    Public PropertyDocument type # 1520.  
    Public PropertyDocument type: Description # 1550.  
    Public PropertyDocument type with preceding sign # 1540.  
    Public PropertyFunctional assignment # 1320.  
    Public PropertyFunctional assignment: Description # 1350.  
    Public PropertyFunctional assignment with preceding sign # 1340.  
    Public PropertyHigher-level function number # 1720.  
    Public PropertyHigher-level function number: Description # 1750.  
    Public PropertyHigher-level function number with preceding sign # 1740.  
    Public PropertyLocation designation # 1220.  
    Public PropertyLocation designation: Description # 1250.  
    Public PropertyLocation designation with preceding sign # 1240.  
    Public PropertyInstallation site # 1420.  
    Public PropertyInstallation site: Description # 1450.  
    Public PropertyInstallation site with preceding sign # 1440.  
    Public PropertyFunction designation # 1120.  
    Public PropertyFunction designation: Description # 1150.  
    Public PropertyFunction designation with preceding sign # 1140.  
    Public PropertyProduct # 1820.  
    Public PropertyProduct: Description # 1850.  
    Public PropertyProduct with preceding sign # 1840.  
    Public PropertyDocument type (sub-identifier, complete) # 1521.  
    Public PropertyFunctional assignment (sub-identifier, complete) # 1321.  
    Public PropertyHigher-level function number (sub-identifier, complete) # 1721.  
    Public PropertyLocation designation (sub-identifier, complete) # 1221.  
    Public PropertyInstallation site (sub-identifier, complete) # 1421.  
    Public PropertyFunction designation (sub-identifier, complete) # 1121.  
    Public PropertyProduct (sub-identifier, complete) # 1821.  
    Public PropertyUser-defined structure (sub-identifier, complete) # 1621.  
    Public PropertyUser-defined structure # 1620.  
    Public PropertyUser-defined structure: Description # 1650.  
    Public PropertyUser-defined structure with preceding sign # 1640.  
    Public PropertyFunctional assignment (main identifier) # 1300.  
    Public PropertyFunctional assignment (main identifier): Description # 1330.  
    Public PropertyFunctional assignment (leading identifiers) # 1322.  
    Public PropertyFunctional assignment (single component) # 1328.  
    Public PropertyHigher-level function number (main identifier) # 1700.  
    Public PropertyHigher-level function number (main identifier): Description # 1730.  
    Public PropertyHigher-level function number (leading identifiers) # 1722.  
    Public PropertyHigher-level function number (single component) # 1728.  
    Public PropertyLocation designation (main identifier) # 1200.  
    Public PropertyLocation designation (main identifier): Description # 1230.  
    Public PropertyLocation designation (leading identifiers) # 1222.  
    Public PropertyLocation designation (single component) # 1228.  
    Public PropertyInstallation site (main identifier) # 1400.  
    Public PropertyInstallation site (main identifier): Description # 1430.  
    Public PropertyInstallation site (leading identifiers) # 1422.  
    Public PropertyInstallation site (single component) # 1428.  
    Public PropertyFunction designation (main identifier) # 1100.  
    Public PropertyFunction designation (main identifier): Description # 1130.  
    Public PropertyFunction designation (leading identifiers) # 1122.  
    Public PropertyFunction designation (single component) # 1128.  
    Public PropertyProduct (main identifier) # 1800.  
    Public PropertyProduct (main identifier): Description # 1830.  
    Public PropertyProduct (leading identifiers) # 1822.  
    Public PropertyProduct aspect (single component) # 1828.  
    Public PropertyFunctional assignment (sub-identifier 1) # 1301.  
    Public PropertyFunctional assignment (sub-identifier 1): Description # 1331.  
    Public PropertyFunctional assignment (sub-identifier 2) # 1302.  
    Public PropertyFunctional assignment (sub-identifier 2): Description # 1332.  
    Public PropertyFunctional assignment (sub-identifier 3) # 1303.  
    Public PropertyFunctional assignment (sub-identifier 3): Description # 1333.  
    Public PropertyFunctional assignment (sub-identifier 4) # 1304.  
    Public PropertyFunctional assignment (sub-identifier 4): Description # 1334.  
    Public PropertyFunctional assignment (sub-identifier 5) # 1305.  
    Public PropertyFunctional assignment (sub-identifier 5): Description # 1335.  
    Public PropertyFunctional assignment (sub-identifier 6) # 1306.  
    Public PropertyFunctional assignment (sub-identifier 6): Description # 1336.  
    Public PropertyFunctional assignment (sub-identifier 7) # 1307.  
    Public PropertyFunctional assignment (sub-identifier 7): Description # 1337.  
    Public PropertyFunctional assignment (sub-identifier 8) # 1308.  
    Public PropertyFunctional assignment (sub-identifier 8): Description # 1338.  
    Public PropertyFunctional assignment (sub-identifier 9) # 1309.  
    Public PropertyFunctional assignment (sub-identifier 9): Description # 1339.  
    Public PropertyLocation designation (sub-identifier 1) # 1201.  
    Public PropertyLocation designation (sub-identifier 1): Description # 1231.  
    Public PropertyLocation designation (sub-identifier 2) # 1202.  
    Public PropertyLocation designation (sub-identifier 2): Description # 1232.  
    Public PropertyLocation designation (sub-identifier 3) # 1203.  
    Public PropertyLocation designation (sub-identifier 3): Description # 1233.  
    Public PropertyLocation designation (sub-identifier 4) # 1204.  
    Public PropertyLocation designation (sub-identifier 4): Description # 1234.  
    Public PropertyLocation designation (sub-identifier 5) # 1205.  
    Public PropertyLocation designation (sub-identifier 5): Description # 1235.  
    Public PropertyLocation designation (sub-identifier 6) # 1206.  
    Public PropertyLocation designation (sub-identifier 6): Description # 1236.  
    Public PropertyLocation designation (sub-identifier 7) # 1207.  
    Public PropertyLocation designation (sub-identifier 7): Description # 1237.  
    Public PropertyLocation designation (sub-identifier 8) # 1208.  
    Public PropertyLocation designation (sub-identifier 8): Description # 1238.  
    Public PropertyLocation designation (sub-identifier 9) # 1209.  
    Public PropertyLocation designation (sub-identifier 9): Description # 1239.  
    Public PropertyInstallation site (sub-identifier 1) # 1401.  
    Public PropertyInstallation site (sub-identifier 1): Description # 1431.  
    Public PropertyInstallation site (sub-identifier 2) # 1402.  
    Public PropertyInstallation site (sub-identifier 2): Description # 1432.  
    Public PropertyInstallation site (sub-identifier 3) # 1403.  
    Public PropertyInstallation site (sub-identifier 3): Description # 1433.  
    Public PropertyInstallation site (sub-identifier 4) # 1404.  
    Public PropertyInstallation site (sub-identifier 4): Description # 1434.  
    Public PropertyInstallation site (sub-identifier 5) # 1405.  
    Public PropertyInstallation site (sub-identifier 5): Description # 1435.  
    Public PropertyInstallation site (sub-identifier 6) # 1406.  
    Public PropertyInstallation site (sub-identifier 6): Description # 1436.  
    Public PropertyInstallation site (sub-identifier 7) # 1407.  
    Public PropertyInstallation site (sub-identifier 7): Description # 1437.  
    Public PropertyInstallation site (sub-identifier 8) # 1408.  
    Public PropertyInstallation site (sub-identifier 8): Description # 1438.  
    Public PropertyInstallation site (sub-identifier 9) # 1409.  
    Public PropertyInstallation site (sub-identifier 9): Description # 1439.  
    Public PropertyFunction designation (sub-identifier 1) # 1101.  
    Public PropertyFunction designation (sub-identifier 1): Description # 1131.  
    Public PropertyFunction designation (sub-identifier 2) # 1102.  
    Public PropertyFunction designation (sub-identifier 2): Description # 1132.  
    Public PropertyFunction designation (sub-identifier 3) # 1103.  
    Public PropertyFunction designation (sub-identifier 3): Description # 1133.  
    Public PropertyFunction designation (sub-identifier 4) # 1104.  
    Public PropertyFunction designation (sub-identifier 4): Description # 1134.  
    Public PropertyFunction designation (sub-identifier 5) # 1105.  
    Public PropertyFunction designation (sub-identifier 5): Description # 1135.  
    Public PropertyFunction designation (sub-identifier 6) # 1106.  
    Public PropertyFunction designation (sub-identifier 6): Description # 1136.  
    Public PropertyFunction designation (sub-identifier 7) # 1107.  
    Public PropertyFunction designation (sub-identifier 7): Description # 1137.  
    Public PropertyFunction designation (sub-identifier 8) # 1108.  
    Public PropertyFunction designation (sub-identifier 8): Description # 1138.  
    Public PropertyFunction designation (sub-identifier 9) # 1109.  
    Public PropertyFunction designation (sub-identifier 9): Description # 1139.  
    Public PropertyProduct (sub-identifier 1) # 1801.  
    Public PropertyProduct (sub-identifier 1): Description # 1831.  
    Public PropertyProduct (sub-identifier 2) # 1802.  
    Public PropertyProduct (sub-identifier 2): Description # 1832.  
    Public PropertyProduct (sub-identifier 3) # 1803.  
    Public PropertyProduct (sub-identifier 3): Description # 1833.  
    Public PropertyProduct (sub-identifier 4) # 1804.  
    Public PropertyProduct (sub-identifier 4): Description # 1834.  
    Public PropertyProduct (sub-identifier 5) # 1805.  
    Public PropertyProduct (sub-identifier 5): Description # 1835.  
    Public PropertyProduct (sub-identifier 6) # 1806.  
    Public PropertyProduct (sub-identifier 6): Description # 1836.  
    Public PropertyProduct (sub-identifier 7) # 1807.  
    Public PropertyProduct (sub-identifier 7): Description # 1837.  
    Public PropertyProduct (sub-identifier 8) # 1808.  
    Public PropertyProduct (sub-identifier 8): Description # 1838.  
    Public PropertyProduct (sub-identifier 9) # 1809.  
    Public PropertyProduct (sub-identifier 9): Description # 1839.  
    Public PropertyUser-defined structure (main identifier) # 1600.  
    Public PropertyUser-defined structure (main identifier): Description # 1630.  
    Public PropertyUser-defined structure (leading identifiers) # 1622.  
    Public PropertyUser-defined structure (single component) # 1628.  
    Public PropertyUser-defined structure (sub-identifier 1) # 1601.  
    Public PropertyUser-defined structure (sub-identifier 1): Description # 1631.  
    Public PropertyUser-defined structure (sub-identifier 2) # 1602.  
    Public PropertyUser-defined structure (sub-identifier 2): Description # 1632.  
    Public PropertyUser-defined structure (sub-identifier 3) # 1603.  
    Public PropertyUser-defined structure (sub-identifier 3): Description # 1633.  
    Public PropertyUser-defined structure (sub-identifier 4) # 1604.  
    Public PropertyUser-defined structure (sub-identifier 4): Description # 1634.  
    Public PropertyUser-defined structure (sub-identifier 5) # 1605.  
    Public PropertyUser-defined structure (sub-identifier 5): Description # 1635.  
    Public PropertyUser-defined structure (sub-identifier 6) # 1606.  
    Public PropertyUser-defined structure (sub-identifier 6): Description # 1636.  
    Public PropertyUser-defined structure (sub-identifier 7) # 1607.  
    Public PropertyUser-defined structure (sub-identifier 7): Description # 1637.  
    Public PropertyUser-defined structure (sub-identifier 8) # 1608.  
    Public PropertyUser-defined structure (sub-identifier 8): Description # 1638.  
    Public PropertyUser-defined structure (sub-identifier 9) # 1609.  
    Public PropertyUser-defined structure (sub-identifier 9): Description # 1639.  
    Public PropertyStructure identifier (Segment) # 44032.  
    Public PropertyTotal number of analog PLC inputs # 44030.  
    Public PropertyTotal number of analog PLC outputs # 44031.  
    Public PropertyAutomatically generated # 44074.  
    Public PropertyBasic segment definition: Displayed name # 44042.  
    Public PropertyBasic segment definition: Name (identifying) # 44039.  
    Public PropertyExpenditure construction # 44014.  
    Public PropertyTotal expenditure construction # 44015.  
    Public PropertyConnection: Cross-section / diameter # 44085.  
    Public PropertySegment definition: Displayed name # 44041.  
    Public PropertySegment definition: Name (identifying) # 44001.  
    Public PropertyDescription (Segment) # 44005.  
    Public PropertyDesignation # 44004.  
    Public PropertyDesignation (visible) # 44065.  
    Public PropertyTotal number of digital PLC inputs # 44028.  
    Public PropertyTotal number of digital PLC outputs # 44029.  
    Public PropertyDocuments # 44007.  
    Public PropertyDocuments: Designation # 44069.  
    Public PropertyDocuments: File / hyperlink # 44068.  
    Public PropertyDesignation (full) # 44009.  
    Public PropertyGMP-relevant # 44061.  
    Public PropertyHas linked segments # 44067.  
    Public PropertyHook-up # 44056.  
    Public PropertyDo not check for pre-planning depth # 44034.  
    Public PropertyIs linked to superior segments # 44066.  
    Public PropertyLinked segments: Name # 44063.  
    Public PropertyMacro # 44008.  
    Public PropertyProcessing function # 44037.  
    Public PropertyTechnical facility # 44035.  
    Public PropertyImplementation # 44043.  
    Public PropertyActivation site # 44044.  
    Public PropertyMeasurand # 44036.  
    Public PropertyNumber # 44038.  
    Public PropertyColor for P&I diagram # 44086.  
    Public PropertyPipe class # 44072.  
    Public PropertyMacro for pre-planning and P&I diagram # 44084.  
    Public PropertyPre-planning finished # 44040.  
    Public PropertyExpenditure planning # 44012.  
    Public PropertyTotal expenditure planning # 44013.  
    Public PropertyPLC address: Address # 44023.  
    Public PropertyPLC address: Configuration project # 44048.  
    Public PropertyPLC address: Counter # 44064.  
    Public PropertyPLC address: CPU # 44022.  
    Public PropertyPLC address: Data type # 44021.  
    Public PropertyPLC address: Direction # 44020.  
    Public PropertyPLC address: Function text # 44025.  
    Public PropertyPLC address: Workstation # 44047.  
    Public PropertyPLC address: Symbolic address # 44024.  
    Public PropertyPLC address: Symbolic address: Group # 44087.  
    Public PropertyPLC address: Symbolic address (single component) # 44052.  
    Public PropertyPLC address: Symbolic address: UDT (name) # 44088.  
    Public PropertyPLC address: Symbolic address: UDT (data type) # 44089.  
    Public PropertyTotal number of PLC counter inputs # 44059.  
    Public PropertyPre-planning item number # 44027.  
    Public PropertyPower consumption # 44010.  
    Public PropertyTotal power consumption # 44011.  
    Public PropertyCalculation value # 44018.  
    Public PropertyTotal calculation value # 44019.  
    Public PropertyExpenditure software # 44016.  
    Public PropertyTotal expenditure software # 44017.  
    Public PropertyQuality-relevant # 44062.  
    Public PropertyRelevant to safety # 44060.  
    Public PropertyNumber of analog PLC inputs # 44081.  
    Public PropertyNumber of analog PLC outputs # 44082.  
    Public PropertyNumber of digital PLC inputs # 44079.  
    Public PropertyNumber of digital PLC outputs # 44080.  
    Public PropertyNumber of PLC counter inputs # 44083.  
    Public PropertySource segment # 44070.  
    Public PropertySegment template # 44051.  
    Public PropertySubstance # 44078.  
    Public PropertySymbolic address (single component) # 44053.  
    Public PropertyTarget segment # 44071.  
    Public PropertyTechnical description # 44006.  
    Public PropertyLevel in tree # 44026.  
    Public PropertyUser-defined property: Name # 44054.  
    Public PropertyUser-defined property: Value # 44055.  
    Public PropertyTrade (Defined working sections) # 25000.  
    Public PropertyReturns array of property ids. Returns array of AnyPropertyId objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyReturns array of PropertyValue objects. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertySupplementary field Yes / No # 20916.  
    Public PropertySuppl. field: Text # 20915.  
    Public PropertyAssembly # 20905.  
    Public PropertyAssembly structure # 20922.  
    Public PropertyAssembly variant # 20923.  
    Public PropertyPart allocation # 20904.  
    Public PropertyUsed drilling pattern # 20284.  
    Public PropertyNumber of units / quantity # 20102.  
    Public PropertyPart: Designation 1 # 20193.  
    Public PropertyPart: Designation 2 # 20194.  
    Public PropertyPart: Designation 3 # 20203.  
    Public PropertyERP number # 31117.  
    Public PropertyPart: External document 1 # 20190.  
    Public PropertyPart: External document 10 # 20269.  
    Public PropertyPart: External document 11 # 20270.  
    Public PropertyPart: External document 12 # 20271.  
    Public PropertyPart: External document 13 # 20272.  
    Public PropertyPart: External document 14 # 20273.  
    Public PropertyPart: External document 15 # 20274.  
    Public PropertyPart: External document 16 # 20275.  
    Public PropertyPart: External document 17 # 20276.  
    Public PropertyPart: External document 18 # 20277.  
    Public PropertyPart: External document 19 # 20278.  
    Public PropertyPart: External document 2 # 20191.  
    Public PropertyPart: External document 20 # 20279.  
    Public PropertyPart: External document 3 # 20192.  
    Public PropertyPart: External document 4 # 20263.  
    Public PropertyPart: External document 5 # 20264.  
    Public PropertyPart: External document 6 # 20265.  
    Public PropertyPart: External document 7 # 20266.  
    Public PropertyPart: External document 8 # 20267.  
    Public PropertyPart: External document 9 # 20268.  
    Public PropertyExternal placement # 20917.  
    Public PropertyFunction group # 20902.  
    Public PropertyService time # 20909.  
    Public PropertyLubrication / maintenance # 20912.  
    Public PropertyManufacturer # 20921.  
    Public PropertyPart: Mounting surface # 20918.  
    Public PropertyPart description # 31014.  
    Public PropertyOrder number # 20919.  
    Public PropertySubset / length # 31008.  
    Public PropertySubset / length (full) # 31091.  
    Public PropertySubset / length in unit of project # 31040.  
    Public PropertyUnit for subset / length # 31012.  
    Public PropertySubset / length: Value # 31010.  
    Public PropertySubset / length with unit of project # 31043.  
    Public PropertyPart number # 20100.  
    Public PropertyRecord type # 20103.  
    Public PropertyPart group # 20903.  
    Public PropertyItem number # 20464.  
    Public PropertyQuantity / subset in unit of project # 31044.  
    Public PropertySpare part # 20907.  
    Public PropertyStress # 20910.  
    Public PropertySupplier # 20920.  
    Public PropertySuppress in bill of materials (if filtered) # 20105.  
    Public PropertyProcurement # 20911.  
    Public PropertySafety-related values: Use case in use # 20307.  
    Public PropertyPart variant # 20101.  
    Public PropertyWearing part # 20908.  
    Public PropertyBill of materials group # 20924.  
    Public PropertyBlock property: Format # 20202.  
    Public PropertyBlock property # 20201.  
    Public PropertyRemark # 20045.  
    Public PropertyTrade # 20466.  
    Public PropertyDT (full, without project structures) # 20009.  
    Public PropertyDevice protection # 20475.  
    Public PropertyOutput group # 20033.  
    Public PropertySubtrade # 20467.  
    Public PropertyModification date (change tracking) # 19032.  
    Public PropertyRevision marker (change tracking) # 19030.  
    Public PropertyRevision marker format (change tracking) # 19031.  
    Public PropertyModification time (change tracking) # 19034.  
    Public PropertyCreator (change tracking) # 19033.  
    Public PropertyRevision change marker (from property comparison) # 10153.  
    Public PropertyRevision marker (from property comparison) # 10152.  
    Public PropertyMessages in message management # 20930.  
    Public PropertyStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertySubproject number # 25101.  
    Public PropertyPCT type # 16016.  
    Public PropertyChange protection # 3014.  
    Public PropertyChange protection (hierarchical) # 3015.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Copies properties to other property list. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodDestructor for deterministic finalization of PlanningSegmentPropertyList object. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public MethodOverloaded. Checks property existence for used obiect.  
    Public MethodInternal method. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Top
    See Also