Class DataRecorderSignal
Represents a piece of information that can be recorder by a DataRecorder
Inherited Members
Namespace: ABB.Robotics.RobotStudio
Assembly: ABB.Robotics.RobotStudio.dll
Syntax
sistent("DataRecorderSignal")]
public sealed class DataRecorderSignal : ProjectObject
Constructors
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
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.
Id
Gets a string that uniquely identifies the signal.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
String |
Info
Gets a DataRecorderSignalInfo that provides information about the signal.
Declaration
public DataRecorderSignalInfo Info { get; }
Property Value
Type | Description |
---|---|
DataRecorderSignalInfo |
InitialValue
Gets or sets an initial value of the signal data.
Declaration
public object InitialValue { get; set; }
Property Value
Type | Description |
---|---|
Object |
SourceId
Gets the unique identifier of the DataRecorderSourceBase whence the signal originates.
Declaration
public string SourceId { get; }
Property Value
Type | Description |
---|---|
String |
Methods
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 |
---|---|
Boolean | True if Id is equal to the supplied identifier. |
Remarks
The comparison is case sensitive.
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[] |
GetPathFromParameters(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 |