Click or drag to resize

Sig Class

Sig object to represent communication with a device.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProSig
    More

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class Sig

The Sig type exposes the following members.

Constructors
 NameDescription
Protected methodSig(DeviceBasis, CrestronDevice, UInt32, String, Boolean) Constructor called when creating a new Bool Sig.
Protected methodSig(DeviceBasis, CrestronDevice, UInt32, String, UInt16) Constructor called when creating a new UShort Sig.
Protected methodSig(eSigType, DeviceBasis, CrestronDevice, UInt32, String) Constructor to create a new Sig regardless of the type.
Protected methodSig(DeviceBasis, CrestronDevice, UInt32, String, String, eStringEncoding) Constructor called when create a new String Sig.
Protected methodSig(DeviceBasis, CrestronDevice, UInt32, String, Char, Int32, eStringEncoding) Constructor called when create a new String Sig.
Top
Properties
 NameDescription
Public propertyBoolValue Get the bool representation of this Sig.
Public propertyGroups Collection of SigGroups this sig is apart of.
Public propertyIsInput Property to return if this is an input to the device or not.
Public propertyIsRamping Property used to determine if this Sig is currently ramping.
Public propertyName Get/Set the name of this Sig.
Public propertyNumber Number of this sig.
Public propertyOwner The owner of this signal.
Public propertyRampingInformation Method to get Ramping information for this Sig.
Public propertyShortValue Get the signed Short representation of this Sig.
Public propertyStringEncoding Get the string encoding being used for this Sig. This member is only valid for StringInputSig and StringOutputSig types.
Public propertyStringValue Get the string representation of this Sig.
Public propertySupported Property used to determine if a sig is supported on a particular device.
Public propertyType Type of data this sig uses when communicating with the device.
Public propertyUserObject Property that can be used to add information to this sig.
Public propertyUShortValue Get the UShort representation of this Sig.
Top
Methods
 NameDescription
Public methodClear Method to clear the current value of this sig. For input sig's this change is not sent to the device.
Public methodCreateRamp Function to ramp the UShort Sig. Does nothing when called from a Sig that has a Type != UShort.
Public methodCreateSignedRamp Function to ramp the UShort Sig with signed values. Does nothing when called from a Sig that has a Type != UShort.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodRemoveRampingInformation Method to remove the ramping information for this Sig.
Protected methodSetValueDuringRamping Used to update the current value for a Sig which is ramping.
Public methodStopRamp Method to stop this sig from ramping.
Public methodToString Override of the ToString method.
(Overrides ObjectToString)
Top
Fields
 NameDescription
Protected field_BooleanValue Internal storage of the boolean value for this sig.
Protected field_IntegerValue Internal storage of the integer value.
Protected field_StringBuilderValue Internal storage of the String Builder that holds the current string value of this sig.
Top
Example
Basic example showing how to access a Sig's data using an Xpanel.
C#
//Sigs that can be set are "inputs" to the device
       xPanel.BooleanInput[15].BoolValue = true;
       xPanel.UShortInput[24].UShortValue = 100;
       xPanel.StringInput[11].StringValue = "Send this string to the device.";

//Sigs that can be read are "outputs" from the device. 
//Output values should be read based on event information
//received from the particular device.
      if (xPanel.BooleanOutput[2].BoolValue)
       {
           //Some operation
       }

       if (xPanel.UShortOutput[4].UShortValue == 150)
       {
           //Some operation
       }

       CrestronConsole.PrintLine(xPanel.StringOutput[11].StringValue);

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also
Inheritance Hierarchy