Sig Class |
public class Sig
The Sig type exposes the following members.
| Name | Description | |
|---|---|---|
| Sig(DeviceBasis, CrestronDevice, UInt32, String, Boolean) | Constructor called when creating a new Bool Sig. | |
| Sig(DeviceBasis, CrestronDevice, UInt32, String, UInt16) | Constructor called when creating a new UShort Sig. | |
| Sig(eSigType, DeviceBasis, CrestronDevice, UInt32, String) | Constructor to create a new Sig regardless of the type. | |
| Sig(DeviceBasis, CrestronDevice, UInt32, String, String, eStringEncoding) | Constructor called when create a new String Sig. | |
| Sig(DeviceBasis, CrestronDevice, UInt32, String, Char, Int32, eStringEncoding) | Constructor called when create a new String Sig. |
| Name | Description | |
|---|---|---|
| BoolValue | Get the bool representation of this Sig. | |
| Groups | Collection of SigGroups this sig is apart of. | |
| IsInput | Property to return if this is an input to the device or not. | |
| IsRamping | Property used to determine if this Sig is currently ramping. | |
| Name | Get/Set the name of this Sig. | |
| Number | Number of this sig. | |
| Owner | The owner of this signal. | |
| RampingInformation | Method to get Ramping information for this Sig. | |
| ShortValue | Get the signed Short representation of this Sig. | |
| StringEncoding | Get the string encoding being used for this Sig. This member is only valid for StringInputSig and StringOutputSig types. | |
| StringValue | Get the string representation of this Sig. | |
| Supported | Property used to determine if a sig is supported on a particular device. | |
| Type | Type of data this sig uses when communicating with the device. | |
| UserObject | Property that can be used to add information to this sig. | |
| UShortValue | Get the UShort representation of this Sig. |
| Name | Description | |
|---|---|---|
| Clear | Method to clear the current value of this sig. For input sig's this change is not sent to the device. | |
| CreateRamp | Function to ramp the UShort Sig. Does nothing when called from a Sig that has a Type != UShort. | |
| CreateSignedRamp | Function to ramp the UShort Sig with signed values. Does nothing when called from a Sig that has a Type != UShort. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| RemoveRampingInformation | Method to remove the ramping information for this Sig. | |
| SetValueDuringRamping | Used to update the current value for a Sig which is ramping. | |
| StopRamp | Method to stop this sig from ramping. | |
| ToString |
Override of the ToString method.
(Overrides ObjectToString) |
| Name | Description | |
|---|---|---|
| _BooleanValue | Internal storage of the boolean value for this sig. | |
| _IntegerValue | Internal storage of the integer value. | |
| _StringBuilderValue | Internal storage of the String Builder that holds the current string value of this sig. |
//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);