Class DataRecorderSignal

Represents a piece of information that can be recorder by a DataRecorder

Inheritance
object
ProjectObject
DataRecorderSignal
Inherited Members
Namespace: ABB.Robotics.RobotStudio
Assembly: ABB.Robotics.RobotStudio.dll
Syntax
[Persistent("DataRecorderSignal")]
public sealed class DataRecorderSignal : ProjectObject

Constructors

View Source

DataRecorderSignal(string, string, DataRecorderSignalInfo, string)

Declaration
public DataRecorderSignal(string sourceId, string id, DataRecorderSignalInfo info, string displayPath)
Parameters
Type Name Description
string sourceId
string id
DataRecorderSignalInfo info
string displayPath

Properties

View Source

DisplayPath

Returns a user-friendly path.

Declaration
public string DisplayPath { get; }
Property Value
Type Description
string
Remarks

The display path may contain a path element with a "#" character followed by a unique identifier. This element is not part of the actual path and must be filtered before use. The element indicates an identifier to separate objects with same name.

View Source

Id

Gets a string that uniquely identifies the signal.

Declaration
public string Id { get; }
Property Value
Type Description
string
View Source

Info

Gets a DataRecorderSignalInfo that provides information about the signal.

Declaration
public DataRecorderSignalInfo Info { get; }
Property Value
Type Description
DataRecorderSignalInfo
View Source

InitialValue

Gets or sets an initial value of the signal data.

Declaration
public object InitialValue { get; set; }
Property Value
Type Description
object
View Source

SourceId

Gets the unique identifier of the DataRecorderSourceBase whence the signal originates.

Declaration
public string SourceId { get; }
Property Value
Type Description
string

Methods

View Source

Equals(string)

Checks if this signal has a specified identifier.

Declaration
public bool Equals(string id)
Parameters
Type Name Description
string id

Identifier
Returns
Type Description
bool

True if Id is equal to the supplied identifier.
Remarks

The comparison is case sensitive.

View Source

GetParametersFromPath(string)

Splits the Id or DisplayPath of a signal into its individual parts.

Declaration
public static string[] GetParametersFromPath(string path)
Parameters
Type Name Description
string path
Returns
Type Description
string[]
View Source

GetPathFromParameters(params string[])

Constructs a signal Id or DisplayPath from individual parts.

Declaration
public static string GetPathFromParameters(params string[] array)
Parameters
Type Name Description
string[] array
Returns
Type Description
string