XJEaseParameterCollection Class

A collection of XJEaseParameter objects which are used to call XJEase functions through one of the RunFunction methods.

Namespace: XJTAG.Integration.XJRunner

Syntax

public class XJEaseParameterCollection : IEnumerable<XJEaseParameter>

Inheritance Hierarchy

  • object
  • IEnumerable<XJEaseParameter>
    • IEnumerable

Members

Constructors

Name Description
XJEaseParameterCollection

Creates a new empty instance of the XJEaseParameterCollection class.

Indexers

Name Description
XJEaseParameter this[int]

Gets the parameter in this collection located at the given index.

Properties

Name Description
Count

Returns the number of parameters in this collection.

Methods

Name Description
Add

Adds a parameter to the collection.

AddInt(int)

Adds a new IntParameter (based on an Int32) to the collection.

AddInt(uint)

Adds a new IntParameter (based on a UInt32) to the collection.

AddInt(long)

Adds a new IntParameter (based on an Int64) to the collection.

AddInt(ulong)

Adds a new IntParameter (based on a UInt64) to the collection.

AddString

Adds a new StringParameter to the collection.

Equals(object) (from object)
Finalize (from object)
GetEnumerator

Returns an enumerator that iterates through the XJEaseParameters in the collection.

GetHashCode (from object)
GetOutputCollection

Gets a new XJEaseParameterCollection instance, with a number of empty parameters specified by the count parameter. This can be used to create a collection of output parameters which will be initialised with default values and populated when a called XJEase function completes.

GetParameter

Gets the parameter in this collection located at the given index.

GetType (from object)
MemberwiseClone (from object)
ToString (from object)
With

Adds a parameter to the collection.

WithInt(int)

Adds a new IntParameter (based on an Int32) to the collection.

WithInt(uint)

Adds a new IntParameter (based on a UInt32) to the collection.

WithInt(long)

Adds a new IntParameter (based on an Int64) to the collection.

WithInt(ulong)

Adds a new IntParameter (based on a UInt64) to the collection.

WithString

Adds a new StringParameter to the collection.