Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

OAPDimChange

Synopsis

struct OAPDimChange (
    decimal[]? PropChoiceList,
    string[] symbolicPropValues,
    Axis? axis,
    Dimension dimension,
    string propClass,
    string propName,
    decimal propValue,
    decimal minPropValue,
    decimal maxPropValue,
    boolean fixedValue,
    int propDecDigits,
    decimal multiplier,
    decimal precision,
    boolean changeSeparately,
    boolean thirdDimension
)

See also: Axis, Dimension

axis

Field axis is optional. It is present if and only if the new field dimension has a bi-directional value (X, Y or Z).

dimension

specifies the axis and direction of an allowed dimension change.

propClass

Optional attribute, type string class of the property to use; This attribute is optional because a) determining the class of the property would cause some additional overhead and b) in case of OFML articles the property class is ignored by operation ‘setPropertyValue’ anyway.

So, if no property class is returned, the client should pass an empty string as property class to ‘setPropertyValue’. If a property class is returned the client is expected to pass this roperty class to ‘setPropertyValue’.

PropName

Required attribute, type string name of the property to use

propValue

Required attribute, type decimal current property value

minPropValue

Required attribute, type decimal minimum allowed property value

maxPropValue

Required attribute, type decimal maximum allowed property value

propChoiceList

Optional sequence of elements of type decimal optional choice list

fixedValue

Required attribute, type boolean, if true, only choice list values are allowed as property values; if false, choice list values (if present) are just suggestions

propDecDigits

Required attribute, type int, allowed number of decimal digits in property values right of decimal point

multiplier

Required attribute, type decimal, conversion factor used to convert between meters and the unit used by property values (given in meters per prop value unit)

precision

Required attribute, type decima, precision of dimension change given as an absolute value in meters (for instance, 0.1 means that dimension should be changed in multiples of 10 centimeters)

changeSeparetely

corresponds to column Separate of OAP table DimChange. For OAP 1.1 data, the value of this field is false.

symbolicPropValues

The sequence of symbolic property values is either empty or contains the same number of elements as the sequence of numeric choice values (propChoiceList). If non-empty, the client must set the property specified by fields propClass and propName to the symbolic value at index N to effect a dim-change to the choice value at index N.

thirdDimension

corresponds to column ThirdDim of OAP table DimChange. For OAP 1.1 data, the value of this field is false.