Class ArrayData
Represents a RAPID array.
Inheritance
Namespace: ABB.Robotics.Controllers.RapidDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public class ArrayData : IRapidData, IEnumerableProperties
BaseIndex
Gets or sets the base index of array.
Declaration
public int BaseIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Item[Int32]
Gets/sets data in a one dimension array.
Declaration
public IRapidData this[int index] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type | Description |
|---|---|
| IRapidData |
Item[Int32, Int32]
Gets/Sets data in a two dimension array.
Declaration
public IRapidData this[int y, int x] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | y | |
| System.Int32 | x |
Property Value
| Type | Description |
|---|---|
| IRapidData |
Item[Int32, Int32, Int32]
Gets/Sets data in a three dimension array.
Declaration
public IRapidData this[int z, int y, int x] { get; set; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | z | |
| System.Int32 | y | |
| System.Int32 | x |
Property Value
| Type | Description |
|---|---|
| IRapidData |
Length
Gets the array length in the first dimension.
Declaration
public int Length { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Mode
Gets/Sets the current mode of the array.
Declaration
public ArrayModes Mode { get; set; }Property Value
| Type | Description |
|---|---|
| ArrayModes |
Rank
Gets the number of dimensions of the array.
Declaration
public int Rank { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Methods
Fill(DataNode)
Fills the RapidData object from the specified parser root.
Declaration
public void Fill(DataNode root)Parameters
| Type | Name | Description |
|---|---|---|
| DataNode | root | Root of data. |
Fill(String)
Fills the structure with the new value.
Declaration
public void Fill(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | Value to fill structure with. |
FillFromString(String)
Fills the struct with a valid rapid string representation.
Declaration
public void FillFromString(string newValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | newValue | The new value stored by the struct. |
Exceptions
| Type | Condition |
|---|---|
| RapidDataFormatException | newValue does not represent the ArrayData data type. |
GetEnumerator()
Gets a IEnumerator object for the array,
Declaration
public IEnumerator GetEnumerator()Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | The enumerator object. |
GetLength(Int32)
Gets the length of the specified dimension. Zero based index.
Declaration
public int GetLength(int dimension)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | dimension | Dimension to get length for. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The length of the dimension. |
ToString()
Returns the string representation of the rapid data array.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | The string representation with the value of the rapid data. |
Overrides
ToStructure()
This method is not supported.
Declaration
public DataNode ToStructure()Returns
| Type | Description |
|---|---|
| DataNode |