Struct String

Represents a rapid data of type string.

Implements

System.IConvertible

Namespace: ABB.Robotics.Controllers.RapidDomain

Assembly: ABB.Robotics.Controllers.PC.dll

Syntax

public struct String : IRapidData, IConvertible

Constructors

String(String)

Initializes a new instance of the String class with a specific value.

Declaration

public String(string value)

Parameters

Type	Name	Description
System.String	value	New string value.

Properties

Empty

Gets a new empyty String object.

Declaration

public static readonly String Empty { get; }

Property Value

Type	Description
String

Value

Gets/Sets the Value of the String.

Declaration

public string Value { get; set; }

Property Value

Type	Description
System.String

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 string data type.

GetDataType(Controller)

Gets the datatype object for this type from the supplied controller.

Declaration

public static RapidDataType GetDataType(Controller controller)

Parameters

Type	Name	Description
Controller	controller	Controller containing the datatype.

Returns

Type	Description
RapidDataType	A valid datatype object if it exist on the controller.

Parse(String)

Parses the string into a String object.

Declaration

public static String Parse(string value)

Parameters

Type	Name	Description
System.String	value	Value to parse into object.

Returns

Type	Description
String	The String object.

ToString()

Returns the string representation of the string rapid data.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation with the value of the string rapid data.

Overrides

System.ValueType.ToString()

Remarks

NOTE the returned string does contain quaternion marks.

ToStructure()

Converts the datastructure into a DataNode tree.

Declaration

public DataNode ToStructure()

Returns

Type	Description
DataNode	The root of the corresponding data tree.

Trim(String)

Removes any " from beginning and end of string. " must be both in begining and end to be removed.

Declaration

public static string Trim(string value)

Parameters

Type	Name	Description
System.String	value	String to trim.

Returns

Type	Description
System.String	The clean string.

TryParse(String, out String)

Attempts to parse the string into object.

Declaration

public static bool TryParse(string value, out String result)

Parameters

Type	Name	Description
System.String	value	Value to parse.
String	result	The result of the parse operation.

Returns

Type	Description
System.Boolean	True if parse succeeded.

Operators

Implicit(String to String)

Converts a String struct to a string.

Declaration

public static implicit operator string (String f)

Parameters

Type	Name	Description
String	f	A String struct reference.

Returns

Type	Description
System.String	The string value that is stored in the String struct

Remarks

NOTE the returned string does not contain quaternion marks. In order to retrieve the string with the quaternion marks, use the method ToString()

Explicit Interface Implementations

IConvertible.GetTypeCode()

Declaration

TypeCode IConvertible.GetTypeCode()

Returns

Type	Description
System.TypeCode

IConvertible.ToBoolean(IFormatProvider)

Declaration

bool IConvertible.ToBoolean(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Boolean

IConvertible.ToByte(IFormatProvider)

Declaration

byte IConvertible.ToByte(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Byte

IConvertible.ToChar(IFormatProvider)

Declaration

char IConvertible.ToChar(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Char

IConvertible.ToDateTime(IFormatProvider)

Declaration

DateTime IConvertible.ToDateTime(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.DateTime

IConvertible.ToDecimal(IFormatProvider)

Declaration

decimal IConvertible.ToDecimal(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Decimal

IConvertible.ToDouble(IFormatProvider)

Declaration

double IConvertible.ToDouble(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Double

IConvertible.ToInt16(IFormatProvider)

Declaration

short IConvertible.ToInt16(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Int16

IConvertible.ToInt32(IFormatProvider)

Declaration

int IConvertible.ToInt32(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Int32

IConvertible.ToInt64(IFormatProvider)

Declaration

long IConvertible.ToInt64(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Int64

IConvertible.ToSByte(IFormatProvider)

Declaration

sbyte IConvertible.ToSByte(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.SByte

IConvertible.ToSingle(IFormatProvider)

Declaration

float IConvertible.ToSingle(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.Single

IConvertible.ToString(IFormatProvider)

Declaration

string IConvertible.ToString(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.String

IConvertible.ToType(Type, IFormatProvider)

Declaration

object IConvertible.ToType(Type conversionType, IFormatProvider provider)

Parameters

Type	Name	Description
System.Type	conversionType
System.IFormatProvider	provider

Returns

Type	Description
System.Object

IConvertible.ToUInt16(IFormatProvider)

Declaration

ushort IConvertible.ToUInt16(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.UInt16

IConvertible.ToUInt32(IFormatProvider)

Declaration

uint IConvertible.ToUInt32(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.UInt32

IConvertible.ToUInt64(IFormatProvider)

Declaration

ulong IConvertible.ToUInt64(IFormatProvider provider)

Parameters

Type	Name	Description
System.IFormatProvider	provider

Returns

Type	Description
System.UInt64

Implements

IRapidData

System.IConvertible