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 ConstructorSegmentTemplatePropertyList ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyDESIGNATION_DOCTYPE_PARTDocument type (single component) # 1528.  
    Public PropertyDESIGNATION_FUNCTIONALASSIGNMENT_PARTFunctional assignment (single component) # 1328.  
    Public PropertyDESIGNATION_INSTALLATIONNUMBER_PARTHigher-level function number (single component) # 1728.  
    Public PropertyDESIGNATION_LOCATION_PARTLocation designation (single component) # 1228.  
    Public PropertyDESIGNATION_PLACEOFINSTALLATION_PARTInstallation site (single component) # 1428.  
    Public PropertyDESIGNATION_PLANT_PARTFunction designation (single component) # 1128.  
    Public PropertyDESIGNATION_PRODUCT_PARTProduct aspect (single component) # 1828.  
    Public PropertyDESIGNATION_USERDEFINED_PARTUser-defined structure (single component) # 1628.  
    Public PropertyDMPLAOBJECT_BASEDEFINITIONDISPLAYNAMEBasic segment definition: Displayed name # 44042.  
    Public PropertyDMPLAOBJECT_BASEDEFINITIONNAMEBasic segment definition: Name (identifying) # 44039.  
    Public PropertyDMPLAOBJECT_BUILDINGTIMEExpenditure construction # 44014.  
    Public PropertyDMPLAOBJECT_DEFINITIONDISPLAYNAMESegment definition: Displayed name # 44041.  
    Public PropertyDMPLAOBJECT_DEFINITIONNAMESegment definition: Name (identifying) # 44001.  
    Public PropertyDMPLAOBJECT_DESCRIPTIONDescription (Segment) # 44005.  
    Public PropertyDMPLAOBJECT_DESIGNATIONDesignation # 44004.  
    Public PropertyDMPLAOBJECT_DOCUMENTSDocuments # 44007.  
    Public PropertyDMPLAOBJECT_DOCUMENTS_DESIGNATIONDocuments: Designation # 44069.  
    Public PropertyDMPLAOBJECT_DOCUMENTS_URLDocuments: File / hyperlink # 44068.  
    Public PropertyDMPLAOBJECT_FULLDESIGNATIONDesignation (full) # 44009.  
    Public PropertyDMPLAOBJECT_GMP_RELEVANTGMP-relevant # 44061.  
    Public PropertyDMPLAOBJECT_HOOKUPHook-up # 44056.  
    Public PropertyDMPLAOBJECT_MACROMacro # 44008.  
    Public PropertyDMPLAOBJECT_PCT_FUNCTIONProcessing function # 44037.  
    Public PropertyDMPLAOBJECT_PCT_IDENTIFIERTechnical facility # 44035.  
    Public PropertyDMPLAOBJECT_PCT_IMPLEMENTATIONImplementation # 44043.  
    Public PropertyDMPLAOBJECT_PCT_LOCATIONActivation site # 44044.  
    Public PropertyDMPLAOBJECT_PCT_MEASURANDMeasurand # 44036.  
    Public PropertyDMPLAOBJECT_PCT_NUMBERNumber # 44038.  
    Public PropertyDMPLAOBJECT_PIPECLASSPipe class # 44072.  
    Public PropertyDMPLAOBJECT_PLAMACROMacro for pre-planning and P&I diagram # 44084.  
    Public PropertyDMPLAOBJECT_PLANNING_COMPLETEPre-planning finished # 44040.  
    Public PropertyDMPLAOBJECT_PLANNINGTIMEExpenditure planning # 44012.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_ADDRESSPLC address: Address # 44023.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_CONFIGURATIONPROJECTPLC address: Configuration project # 44048.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_COUNTERPLC address: Counter # 44064.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_CPUPLC address: CPU # 44022.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_DATATYPEPLC address: Data type # 44021.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_DIRECTIONPLC address: Direction # 44020.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_FUNCTIONTEXTPLC address: Function text # 44025.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_STATIONPLC address: Workstation # 44047.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESSPLC address: Symbolic address # 44024.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_GROUPPLC address: Symbolic address: Group # 44087.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_PARTPLC address: Symbolic address (single component) # 44052.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_UDTPLC address: Symbolic address: UDT (name) # 44088.  
    Public PropertyDMPLAOBJECT_PLCADDRESS_SYMBOLICADDRESS_UDT_DATATYPEPLC address: Symbolic address: UDT (data type) # 44089.  
    Public PropertyDMPLAOBJECT_POWER_REQUIREMENTPower consumption # 44010.  
    Public PropertyDMPLAOBJECT_PRICECalculation value # 44018.  
    Public PropertyDMPLAOBJECT_PROGRAMMINGTIMEExpenditure software # 44016.  
    Public PropertyDMPLAOBJECT_QUALITY_RELEVANTQuality-relevant # 44062.  
    Public PropertyDMPLAOBJECT_SAFETY_RELEVANTRelevant to safety # 44060.  
    Public PropertyDMPLAOBJECT_SYMBOLICADDRESS_PARTSymbolic address (single component) # 44053.  
    Public PropertyDMPLAOBJECT_TECHNICAL_DESCRIPTIONTechnical description # 44006.  
    Public PropertyDMPLAOBJECT_USERPROPERTY_NAMEUser-defined property: Name # 44054.  
    Public PropertyDMPLAOBJECT_USERPROPERTY_VALUEUser-defined property: Value # 44055.  
    Public PropertyDMPLASPECIFICATION_DESCRIPTIONSegment template: Description # 44049.  
    Public PropertyDMPLASPECIFICATION_NAMESegment template: Name (identifying) # 44050.  
    Public PropertyDMPLASPECIFICATION_OBJECT_COUNTUsage count # 44057.  
    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_ARTICLE_ADDITIONAL_BOOLFIELDSupplementary field Yes / No # 20916.  
    Public PropertyFUNC_ARTICLE_ADDITIONAL_TEXTFIELDSuppl. field: Text # 20915.  
    Public PropertyFUNC_ARTICLE_ASSEMBLYAssembly # 20905.  
    Public PropertyFUNC_ARTICLE_ASSEMBLY_STRUCTUREAssembly structure # 20922.  
    Public PropertyFUNC_ARTICLE_ASSEMBLYVARIANTAssembly variant # 20923.  
    Public PropertyFUNC_ARTICLE_ASSIGNMENTPart allocation # 20904.  
    Public PropertyFUNC_ARTICLE_CONSTRUCTIONUsed drilling pattern # 20284.  
    Public PropertyFUNC_ARTICLE_COUNTNumber of units / quantity # 20102.  
    Public PropertyFUNC_ARTICLE_DESCR1Part: Designation 1 # 20193.  
    Public PropertyFUNC_ARTICLE_DESCR2Part: Designation 2 # 20194.  
    Public PropertyFUNC_ARTICLE_DESCR3Part: Designation 3 # 20203.  
    Public PropertyFUNC_ARTICLE_ERPNRERP number # 31117.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_1Part: External document 1 # 20190.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_10Part: External document 10 # 20269.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_11Part: External document 11 # 20270.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_12Part: External document 12 # 20271.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_13Part: External document 13 # 20272.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_14Part: External document 14 # 20273.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_15Part: External document 15 # 20274.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_16Part: External document 16 # 20275.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_17Part: External document 17 # 20276.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_18Part: External document 18 # 20277.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_19Part: External document 19 # 20278.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_2Part: External document 2 # 20191.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_20Part: External document 20 # 20279.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_3Part: External document 3 # 20192.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_4Part: External document 4 # 20263.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_5Part: External document 5 # 20264.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_6Part: External document 6 # 20265.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_7Part: External document 7 # 20266.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_8Part: External document 8 # 20267.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_DOCUMENT_9Part: External document 9 # 20268.  
    Public PropertyFUNC_ARTICLE_EXTERNAL_PLACEMENTExternal placement # 20917.  
    Public PropertyFUNC_ARTICLE_FUNCTIONGROUPFunction group # 20902.  
    Public PropertyFUNC_ARTICLE_LIFETIMEService time # 20909.  
    Public PropertyFUNC_ARTICLE_MAINTENANCELubrication / maintenance # 20912.  
    Public PropertyFUNC_ARTICLE_MANUFACTURERManufacturer # 20921.  
    Public PropertyFUNC_ARTICLE_MOUNTINGSITEPart: Mounting surface # 20918.  
    Public PropertyFUNC_ARTICLE_NOTEPart description # 31014.  
    Public PropertyFUNC_ARTICLE_ORDERNROrder number # 20919.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTHSubset / length # 31008.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_FULLSubset / length (full) # 31091.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_IN_PROJECT_UNITSubset / length in unit of project # 31040.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_UNITUnit for subset / length # 31012.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_VALUESubset / length: Value # 31010.  
    Public PropertyFUNC_ARTICLE_PARTIAL_LENGTH_WITH_PROJECT_UNITSubset / length with unit of project # 31043.  
    Public PropertyFUNC_ARTICLE_PARTNRPart number # 20100.  
    Public PropertyFUNC_ARTICLE_PARTTYPERecord type # 20103.  
    Public PropertyFUNC_ARTICLE_PIECETYPEPart group # 20903.  
    Public PropertyFUNC_ARTICLE_POSNRItem number # 20464.  
    Public PropertyFUNC_ARTICLE_QUANTITY_IN_PROJECT_UNITQuantity / subset in unit of project # 31044.  
    Public PropertyFUNC_ARTICLE_SPARESpare part # 20907.  
    Public PropertyFUNC_ARTICLE_STRESSStress # 20910.  
    Public PropertyFUNC_ARTICLE_SUPPLIERSupplier # 20920.  
    Public PropertyFUNC_ARTICLE_SUPPRESSINPARTSLISTSuppress in bill of materials (if filtered) # 20105.  
    Public PropertyFUNC_ARTICLE_USAGEProcurement # 20911.  
    Public PropertyFUNC_ARTICLE_USED_SAFETYRELATEDVALUESafety-related values: Use case in use # 20307.  
    Public PropertyFUNC_ARTICLE_VARIANTPart variant # 20101.  
    Public PropertyFUNC_ARTICLE_WEARWearing part # 20908.  
    Public PropertyFUNC_ARTICLEREF_PARTSLISTGROUPBill of materials group # 20924.  
    Public PropertyFUNC_BLOCK_FORMATBlock property: Format # 20202.  
    Public PropertyFUNC_COMMENTRemark # 20045.  
    Public PropertyFUNC_CRAFTTrade # 20466.  
    Public PropertyFUNC_OUTPUTASSEMBLYOutput group # 20033.  
    Public PropertyFUNC_SUBCRAFTSubtrade # 20467.  
    Public PropertyParentStorableObject to which this property list is connected. (Inherited from Eplan.EplApi.DataModel.UniversalPropertyList)
    Public PropertyPropertyOverloaded. Method used by operator[] in order to access indexed properties.  
    Public PropertyPROPUSER_DBOBJECTIDOverloaded. Object identification # 2000. (Inherited from Eplan.EplApi.DataModel.StorableObjectPropertyList)
    Public PropertySYMB_PLTTYPEPCT type # 16016.  
    Public PropertyWRITEPROTECTEDChange protection # 3014.  
    Public PropertyWRITEPROTECTED_AUTOMATICChange protection (hierarchical) # 3015.  
    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 SegmentTemplatePropertyList 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

    SegmentTemplatePropertyList Members
    Eplan.EplApi.DataModel.Planning Namespace
    SegmentTemplate 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