Harness proD API Help
EPLAN.Harness.API.ApiProperties Namespace / TimeProperty Class
Members Example
In This Topic
    TimeProperty Class
    In This Topic
    Property which stores a time value with a unit.
    Object Model
    TimeProperty ClassPropertyValue Class
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiProperties.Property
          EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty
             EPLAN.Harness.API.ApiProperties.TimeProperty

    Syntax
    public class TimeProperty : EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty
    Remarks

    Represents a property with a time value.

    Class provides a method to convert values between units.

    Example
    The following example shows how to use the class TimeProperty .
    TimeProperty time = new TimeProperty(18, Unit.Hour);
Console.WriteLine(time);

time.Convert(Unit.Week);
Console.WriteLine(time.ToString());

time = "800 ms";
Console.WriteLine(time);
Console.WriteLine($"Value: {(double)time.Value}, Unit: {time.Unit}");

// Results:
// 18 h
// 0,1071 w
// 800 ms
// Value: 800, Unit: Millisecond
    Public Constructors
     NameDescription
    Public ConstructorTimeProperty ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyIsInterval Specifies whether the property is interval. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Public PropertyUnit Unit of the value of this property. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Public PropertyValue Gets the value of this property. (Inherited from EPLAN.Harness.API.ApiProperties.Property)
    Top
    Public Methods
     NameDescription
    Public MethodConvert Convert a property to the specified unit. (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Public MethodEqualsIs this unit class property equal to the following object? (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Public MethodToStringOverloaded. Returns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiProperties.UnitProperties.UnitClassProperty)
    Top
    Public Operators
    public Operator Addition Sums two properties.
    public Operator Implicit Type Conversion Implicit conversion from System.String to TimeProperty.
    public Operator Subtraction Subtracts two properties.
    Top
    See Also

    Reference

    TimeProperty Members
    EPLAN.Harness.API.ApiProperties Namespace
    Unit Enumeration

    Send Feedback