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

In This Topic
    SegmentTemplatePropertyList Class
    In This Topic
    This class represents collection of properties of SegmentTemplate class. Please check also base classes for other properties which are available for SegmentTemplate objects: Eplan.EplApi.DataModel.StorableObjectPropertyList
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.UniversalPropertyList
          Eplan.EplApi.DataModel.StorableObjectPropertyList
             Eplan.EplApi.DataModel.Planning.SegmentTemplatePropertyList

    Syntax
    [DefaultMember("Property")]
    public class SegmentTemplatePropertyList : Eplan.EplApi.DataModel.StorableObjectPropertyList 
    [DefaultMember("Property")]
    public ref class SegmentTemplatePropertyList : 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 PropertyDocument type (single component) # 1528.  
    Public PropertyFunctional assignment (single component) # 1328.  
    Public PropertyHigher-level function number (single component) # 1728.  
    Public PropertyLocation designation (single component) # 1228.  
    Public PropertyInstallation site (single component) # 1428.  
    Public PropertyFunction designation (single component) # 1128.  
    Public PropertyProduct aspect (single component) # 1828.  
    Public PropertyUser-defined structure (single component) # 1628.  
    Public PropertyBasic segment definition: Displayed name # 44042.  
    Public PropertyBasic segment definition: Name (identifying) # 44039.  
    Public PropertyExpenditure construction # 44014.  
    Public PropertySegment definition: Displayed name # 44041.  
    Public PropertySegment definition: Name (identifying) # 44001.  
    Public PropertyDescription (Segment) # 44005.  
    Public PropertyDesignation # 44004.  
    Public PropertyDocuments # 44007.  
    Public PropertyDocuments: Designation # 44069.  
    Public PropertyDocuments: File / hyperlink # 44068.  
    Public PropertyDesignation (full) # 44009.  
    Public PropertyGMP-relevant # 44061.  
    Public PropertyHook-up # 44056.  
    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 PropertyPipe class # 44072.  
    Public PropertyMacro for pre-planning and P&I diagram # 44084.  
    Public PropertyPre-planning finished # 44040.  
    Public PropertyExpenditure planning # 44012.  
    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 PropertyPower consumption # 44010.  
    Public PropertyCalculation value # 44018.  
    Public PropertyExpenditure software # 44016.  
    Public PropertyQuality-relevant # 44062.  
    Public PropertyRelevant to safety # 44060.  
    Public PropertySymbolic address (single component) # 44053.  
    Public PropertyTechnical description # 44006.  
    Public PropertyUser-defined property: Name # 44054.  
    Public PropertyUser-defined property: Value # 44055.  
    Public PropertySegment template: Description # 44049.  
    Public PropertySegment template: Name (identifying) # 44050.  
    Public PropertyUsage count # 44057.  
    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 PropertyRemark # 20045.  
    Public PropertyTrade # 20466.  
    Public PropertyOutput group # 20033.  
    Public PropertySubtrade # 20467.  
    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 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 SegmentTemplatePropertyList 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