Table of Contents

Class Trend

Namespace
L5Sharp.Components
Assembly
L5Sharp.dll

A logix Trend component. Contains the properties that comprise the L5X Trend element.

public class Trend : LogixComponent<Trend>, ILogixSerializable
Inheritance
Trend
Implements
Inherited Members

Remarks

Observe these guidelines when defining a trend:
• A trend can support as many as eight pen declarations.

Constructors

Trend()

Creates a new default LogixElement initialized with an XElement having the L5XType name of the element.

public Trend()

Trend(XElement)

Initializes a new LogixElement with the provided XElement

public Trend(XElement element)

Parameters

element XElement

The L5X XElement to initialize the entity with.

Exceptions

ArgumentNullException

element is null.

Properties

CaptureSize

Specify the number of samples for each capture.

public int CaptureSize { get; set; }

Property Value

int

Remarks

Rockwell: The maximum number of samples is 2-hours worth of data samples or 1000 samples, whichever is greater. If the CaptureSizeType is Samples, the range is 1...(2 hours/SamplePeriod) or 1000 samples, whichever is greater. If the CaptureSizeType is TimePeriod, the range is SamplePeriod...2 hours or (SamplePeriod * 1000), whichever is greater

CaptureSizeType

Define how the capture size is specified.

public CaptureSizeType? CaptureSizeType { get; set; }

Property Value

CaptureSizeType

A CaptureSize representing the capture size option. Type Samples, TimePeriod, or NoLimit.

NumberOfCaptures

Specifies the maximum number of captures allowed (1...100).

public int NumberOfCaptures { get; set; }

Property Value

int

Pens

The collection of Pen components the Trend is configured with.

public LogixContainer<Pen> Pens { get; set; }

Property Value

LogixContainer<Pen>

Remarks

Only supports up to 8 pens per trend.

PostSamples

Specify the number of post-samples (0...1000) if the PostSampleType is Samples. Specify a time period (0...(SamplePeriod ∗ 1000)) that covers post-samples if the PostSampleType is TimePeriod.

public int? PostSamples { get; set; }

Property Value

int?

PostSamplesType

Define how post-samples are specified. Type Samples or TimePeriod.

public SamplesType? PostSamplesType { get; set; }

Property Value

SamplesType

PreSamples

Specify the number of pre-samples (0...1000) if the PreSampleType is Samples. Specify a time period (0...(SamplePeriod ∗ 1000)) that covers pre-samples if the PreSampleType is TimePeriod.

public int? PreSamples { get; set; }

Property Value

int?

PreSamplesType

Define how pre-samples are specified. Type Samples or TimePeriod.

public SamplesType? PreSamplesType { get; set; }

Property Value

SamplesType

SamplePeriod

Specify how often trending tags are collected in milliseconds (1 msec...30 minutes).

public int SamplePeriod { get; set; }

Property Value

int

StartTriggerLogicalOperation

Specify a logical operation (AND or OR) that is performed on StartTriggerXXX1 and StartTriggerXXX2.

public Operator? StartTriggerLogicalOperation { get; set; }

Property Value

Operator

Remarks

StartTriggerXXX1 consists of StartTriggerTag1, StartTriggerOperation1, StartTriggerTargetType1, and StartTriggerTargetValue1 or StartTriggerTargetTag1. StartTriggerXXX2 consists of StartTriggerTag2, StartTriggerOperation2, StartTriggerTargetType2, and StartTriggerTargetValue2 or StartTriggerTargetTag2.

StartTriggerOperation1

Specify the operation that is applied on StartTriggerTag1, and StartTriggerTargetValue1 or StartTriggerTargetTag1.

public TriggerOperation? StartTriggerOperation1 { get; set; }

Property Value

TriggerOperation

StartTriggerOperation2

Specify the operation that is applied on StartTriggerTag2, and StartTriggerTargetValue2 or StartTriggerTargetValue2.

public TriggerOperation? StartTriggerOperation2 { get; set; }

Property Value

TriggerOperation

StartTriggerTag1

Specify the tag name of the first start trigger. The name must be one of the pen names.

public TagName? StartTriggerTag1 { get; set; }

Property Value

TagName

StartTriggerTag2

Specify the tag name of the second start trigger. The name must be one of the pen names.

public TagName? StartTriggerTag2 { get; set; }

Property Value

TagName

StartTriggerTargetTag1

Specify a target tag if the StartTriggerTargetType is TargetTag.

public TagName? StartTriggerTargetTag1 { get; set; }

Property Value

TagName

Remarks

The tag must be one of the pen names.

StartTriggerTargetTag2

Specify a target tag if the StartTriggerTargetType is TargetTag.

public TagName? StartTriggerTargetTag2 { get; set; }

Property Value

TagName

Remarks

The tag must be one of the pen names.

StartTriggerTargetType1

Specify the type of the first start trigger target.

public TriggerTargetType? StartTriggerTargetType1 { get; set; }

Property Value

TriggerTargetType

Remarks

If you type TargetValue, StartTriggerTargetValue1 is expected. Otherwise, StartTriggerTargetTag1 is expected.

StartTriggerTargetType2

Specify the type of the first start trigger target.

public TriggerTargetType? StartTriggerTargetType2 { get; set; }

Property Value

TriggerTargetType

Remarks

If you type TargetValue, StartTriggerTargetValue2 is expected. Otherwise, StartTriggerTargetTag2 is expected.

StartTriggerTargetValue1

Specify a target value if the StartTriggerTargetType1 is TargetValue.

public AtomicType? StartTriggerTargetValue1 { get; set; }

Property Value

AtomicType

Remarks

Type a binary, octal, decimal, or hexadecimal integer number or type a floating point number.

StartTriggerTargetValue2

Specify a target value if the StartTriggerTargetType2 is TargetValue.

public AtomicType? StartTriggerTargetValue2 { get; set; }

Property Value

AtomicType

Remarks

Type a binary, octal, decimal, or hexadecimal integer number or type a floating point number.

StartTriggerType

Specify the type of the start trigger

public TriggerType? StartTriggerType { get; set; }

Property Value

TriggerType

StopTriggerLogicalOperation

Specify a logical operation (AND or OR) that is performed on StopTriggerXXX1 and StopTriggerXXX2.

public Operator? StopTriggerLogicalOperation { get; set; }

Property Value

Operator

Remarks

StopTriggerXXX1 consists of StopTriggerTag1, StopTriggerOperation1, StopTriggerTargetType1, and StopTriggerTargetValue1 or StopTriggerTargetTag1. StopTriggerXXX2 consists of StopTriggerTag2, StopTriggerOperation2, StopTriggerTargetType2, and StopTriggerTargetValue2 or StopTriggerTargetTag2.

StopTriggerOperation1

Specify the operation that is applied on StopTriggerTag1, and StopTriggerTargetValue1 or StopTriggerTargetTag1.

public TriggerOperation? StopTriggerOperation1 { get; set; }

Property Value

TriggerOperation

StopTriggerOperation2

Specify the operation that is applied on StopTriggerTag2, and StopTriggerTargetValue2 or StopTriggerTargetValue2.

public TriggerOperation? StopTriggerOperation2 { get; set; }

Property Value

TriggerOperation

StopTriggerTag1

Specify the tag name of the first start trigger. The name must be one of the pen names.

public TagName? StopTriggerTag1 { get; set; }

Property Value

TagName

StopTriggerTag2

Specify the tag name of the second start trigger. The name must be one of the pen names.

public TagName? StopTriggerTag2 { get; set; }

Property Value

TagName

StopTriggerTargetTag1

Specify a target tag if the StopTriggerTargetType is TargetTag.

public TagName? StopTriggerTargetTag1 { get; set; }

Property Value

TagName

Remarks

The tag must be one of the pen names.

StopTriggerTargetTag2

Specify a target tag if the StopTriggerTargetType is TargetTag.

public TagName? StopTriggerTargetTag2 { get; set; }

Property Value

TagName

Remarks

The tag must be one of the pen names.

StopTriggerTargetType1

Specify the type of the first start trigger target.

public TriggerTargetType? StopTriggerTargetType1 { get; set; }

Property Value

TriggerTargetType

Remarks

If you type TargetValue, StopTriggerTargetValue1 is expected. Otherwise, StopTriggerTargetTag1 is expected.

StopTriggerTargetType2

Specify the type of the first start trigger target.

public TriggerTargetType? StopTriggerTargetType2 { get; set; }

Property Value

TriggerTargetType

Remarks

If you type TargetValue, StopTriggerTargetValue2 is expected. Otherwise, StopTriggerTargetTag2 is expected.

StopTriggerTargetValue1

Specify a target value if the StopTriggerTargetType1 is TargetValue.

public AtomicType? StopTriggerTargetValue1 { get; set; }

Property Value

AtomicType

Remarks

Type a binary, octal, decimal, or hexadecimal integer number or type a floating point number.

StopTriggerTargetValue2

Specify a target value if the StopTriggerTargetType2 is TargetValue.

public AtomicType? StopTriggerTargetValue2 { get; set; }

Property Value

AtomicType

Remarks

Type a binary, octal, decimal, or hexadecimal integer number or type a floating point number.

StopTriggerType

Specify the type of the stop trigger

public TriggerType? StopTriggerType { get; set; }

Property Value

TriggerType

A TriggerType representing the value NoTrigger or Event Trigger.

TrendxVersion

Specify the version of the Trend feature.

public int? TrendxVersion { get; set; }

Property Value

int?