Struct UserDefined
Represents an user defined rapid data type.
Implements
Namespace: ABB.Robotics.Controllers.RapidDomain
Assembly: ABB.Robotics.Controllers.PC.dll
Syntax
public struct UserDefined : IRapidDataConstructors
UserDefined(RapidDataType)
Initializes a new instance of the UserDefined class.
Declaration
public UserDefined(RapidDataType type)Parameters
| Type | Name | Description |
|---|---|---|
| RapidDataType | type | The type. |
UserDefined(String, String)
Initializes a new user defined struct of a specified rapid data type defined in a specified controller.
Declaration
[Obsolete("No longer supported", true)]
public UserDefined(string controllerID, string dataType)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | controllerID | Controller ID where the rapid data type is defined. |
| System.String | dataType | A user defined rapid data type. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | dataType or ArgumentNullException are null or empty. |
| System.ArgumentException | dataType does not represent the user defined data type in the specified controller. |
Properties
Components
Gets or sets the value of of an array of IRapidData.
Declaration
public readonly IRapidData[] Components { get; }Property Value
| Type | Description |
|---|---|
| IRapidData[] | An array of IRapidData that represents the rapid data types of the user data type. |
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | UserDefinedDataType struct does not have a rapid data type definition.". |
Methods
Fill(DataNode)
Fills the object from the specified parser root. This is Obsolete, use Fill2(DataNode) instead.
Declaration
[Obsolete("Use Fill2(DataNode) instead.")]
public void Fill(DataNode root)Parameters
| Type | Name | Description |
|---|---|---|
| DataNode | root | Root of data. |
Fill(String)
Fills the structure with the new value. This is Obsolete, use Fill2(String) instead.
Declaration
[Obsolete("Use Fill2(string) instead.")]
public void Fill(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | Value to string structure with. |
Fill2(DataNode)
Fills the object from the specified parser root.
Declaration
public void Fill2(DataNode root)Parameters
| Type | Name | Description |
|---|---|---|
| DataNode | root | Root of data. |
Exceptions
| Type | Condition |
|---|---|
| RapidDataFormatException | root does not represent the UserDefined data type. |
Fill2(String)
Fills the structure with the new value.
Declaration
public void Fill2(string value)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | value | Value to string structure with. |
Exceptions
| Type | Condition |
|---|---|
| RapidDataFormatException | value does not represent the UserDefined data type. |
FillFromString(String)
Fills the struct with a valid rapid string representation. This is Obsolete, use FillFromString2(String) instead.
Declaration
[Obsolete("Use FillFromString2 instead.")]
public void FillFromString(string newValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | newValue | The new value stored by the struct. |
Remarks
In order to fill the struct, users must use the method FillFromString(String) on each on the the Components of this struct.
Exceptions
| Type | Condition |
|---|---|
| System.InvalidOperationException | UserDefinedDataType struct does not have a rapid data type definition.". |
FillFromString2(String)
Fills the struct with a valid rapid string representation.
Declaration
public void FillFromString2(string newValue)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | newValue | The new value stored by the struct. |
Remarks
In order to fill the struct, users must use the method FillFromString(String) on each on the the Components of this struct.
Exceptions
| Type | Condition |
|---|---|
| RapidDataFormatException | newValue does not represent the UserDefined data type. |
ToString()
Returns the string representation of the user defined rapid data.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | The string representation with the value of the user defined rapid data. |
Overrides
ToStructure()
Converts the datastructure into a DataNode tree.
Declaration
public DataNode ToStructure()Returns
| Type | Description |
|---|---|
| DataNode | The root of the corresponding data tree. |