Class XBeeSettingNumber

This class represents an XBee setting that can be interacted with through an input and its format is a number.

Inheritance
System.Object
AbstractXBeeSetting
XBeeSettingNumber
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 XBeeSettingNumber : AbstractXBeeSetting, ICloneable

Constructors

XBeeSettingNumber(String, String, String, String, XBeeCategory, XBeeFirmware)

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

Declaration
public XBeeSettingNumber(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

XBeeSettingNumber(String, String, String, String, XBeeCategory, XBeeFirmware, Int32)

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

Declaration
public XBeeSettingNumber(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

XBeeSettingNumber(String, String, String, XBeeCategory, XBeeFirmware)

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

Declaration
public XBeeSettingNumber(string name, string description, string defaultValue, XBeeCategory category, XBeeFirmware ownerFirmware)
Parameters
Type Name Description
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

XBeeSettingNumber(String, String, String, XBeeCategory, XBeeFirmware, Int32)

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

Declaration
public XBeeSettingNumber(string name, string description, string defaultValue, XBeeCategory category, XBeeFirmware ownerFirmware, int numNetworks)
Parameters
Type Name Description
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

Properties

AdditionalValues

List of additional allowed values for the setting.

Declaration
public List<string> AdditionalValues { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Units

Units of the setting.

Declaration
public string Units { get; set; }
Property Value
Type Description
System.String

Methods

AddRange(Range)

Adds a new range to the list of ranges.

Declaration
public void AddRange(Range range)
Parameters
Type Name Description
Range range

The range to add to the list.
See Also

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

GetRanges()

Returns the list of valid ranges for this numeric setting.

Declaration
public List<Range> GetRanges()
Returns
Type Description
System.Collections.Generic.List<Range>

The list of valid ranges.
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