Class XBeeSettingButton

This class represents an XBee setting that can be interacted with through a button.

Inheritance
System.Object
AbstractXBeeSetting
XBeeSettingButton
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: XBeeLibrary.Core.Models
Assembly: XBeeLibrary.Core.dll
Syntax
public class XBeeSettingButton : AbstractXBeeSetting, ICloneable

Constructors

XBeeSettingButton(String, String, String, String, XBeeCategory, XBeeFirmware)

Class constructor. Instantiates a new XBeeSettingButton object with the provided parameters.

Declaration
public XBeeSettingButton(string atCommand, string name, string description, string defaultValue, XBeeCategory category, XBeeFirmware ownerFirmware)
Parameters
Type Name Description
System.String atCommand

The AT command corresponding to the setting.
System.String name

Name of the setting.
System.String description

Description of the setting.
System.String defaultValue

Default value of the setting.
XBeeCategory category

Parent category of the setting.
XBeeFirmware ownerFirmware

XBee firmware the setting belongs to.
See Also

XBeeSettingButton(String, String, String, String, XBeeCategory, XBeeFirmware, Int32)

Class constructor. Instantiates a new XBeeSettingButton object with the provided parameters.

Declaration
public XBeeSettingButton(string atCommand, string name, string description, string defaultValue, XBeeCategory category, XBeeFirmware ownerFirmware, int numNetworks)
Parameters
Type Name Description
System.String atCommand

The AT command corresponding to the setting.
System.String name

Name of the setting.
System.String description

Description of the setting.
System.String defaultValue

Default value of the setting.
XBeeCategory category

Parent category of the setting.
XBeeFirmware ownerFirmware

XBee firmware the setting belongs to.
System.Int32 numNetworks

The number of networks the setting can be configured for.
See Also

XBeeSettingButton(String, String, XBeeCategory, XBeeFirmware)

Class constructor. Instantiates a new XBeeSettingButton object with the provided parameters.

Declaration
public XBeeSettingButton(string name, string description, XBeeCategory category, XBeeFirmware ownerFirmware)
Parameters
Type Name Description
System.String name

Name of the setting.
System.String description

Description of the setting.
XBeeCategory category

Parent category of the setting.
XBeeFirmware ownerFirmware

XBee firmware the setting belongs to.
See Also

XBeeSettingButton(String, String, XBeeCategory, XBeeFirmware, Int32)

Class constructor. Instantiates a new XBeeSettingButton object with the provided parameters.

Declaration
public XBeeSettingButton(string name, string description, XBeeCategory category, XBeeFirmware ownerFirmware, int numNetworks)
Parameters
Type Name Description
System.String name

Name of the setting.
System.String description

Description of the setting.
XBeeCategory category

Parent category of the setting.
XBeeFirmware ownerFirmware

XBee firmware the setting belongs to.
System.Int32 numNetworks

The number of networks the setting can be configured for.
See Also

Properties

FunctionNumber

ID of the function (action) associated to the setting.

Declaration
public int FunctionNumber { get; set; }
Property Value
Type Description
System.Int32

Methods

CloneSetting(XBeeCategory, XBeeFirmware)

Clones and returns the setting object.

Declaration
public AbstractXBeeSetting CloneSetting(XBeeCategory parentCategory, XBeeFirmware ownerFirmware)
Parameters
Type Name Description
XBeeCategory parentCategory

The parent category where the cloned setting should be placed.
XBeeFirmware ownerFirmware

The owner firmware of the cloned setting.
Returns
Type Description
AbstractXBeeSetting

The cloned setting object.
See Also

ValidateSetting()

Returns whether or not the current value of the setting is valid.

Declaration
public override bool ValidateSetting()
Returns
Type Description
System.Boolean

true if the value of the setting is valid, false otherwise.
Overrides

ValidateSetting(Int32)

Returns whether or not the current value of the provided network index is valid.

Declaration
public override bool ValidateSetting(int networkIndex)
Parameters
Type Name Description
System.Int32 networkIndex
Returns
Type Description
System.Boolean

true if the value is valid, false otherwise.
Overrides

Implements

System.ICloneable