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

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

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

    Represents a property with a volume value.

    Class provides a method to convert values between units.

    Example
    The following example shows how to use the class VolumeProperty.
    VolumeProperty volume = new VolumeProperty(9, Unit.Liter);
Console.WriteLine(volume);

volume.Convert(Unit.CubicMeter);
Console.WriteLine(volume.ToString());

volume = "22 mm3";
Console.WriteLine(volume);
Console.WriteLine($"Value: {(double)volume.Value}, Unit: {volume.Unit}");

// Results:
// 9 l
// 0,009 m3
// 22 mm3
// Value: 22, Unit: CubicMillimeter
    Public Constructors
     NameDescription
    Public ConstructorVolumeProperty 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 VolumeProperty.
    public Operator Subtraction Subtracts two properties.
    Top
    See Also

    Reference

    VolumeProperty Members
    EPLAN.Harness.API.ApiProperties Namespace
    Unit Enumeration
    ToString Method

    Send Feedback