Class XBeeSettingText

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

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

Constructors

XBeeSettingText(String, String, String, String, XBeeCategory, XBeeFirmware)

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

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

XBeeSettingText(String, String, String, String, XBeeCategory, XBeeFirmware, Int32)

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

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

XBeeSettingText(String, String, String, XBeeCategory, XBeeFirmware)

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

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

XBeeSettingText(String, String, String, XBeeCategory, XBeeFirmware, Int32)

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

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

Fields

IP_V4_PATTERN

Declaration
public const string IP_V4_PATTERN = "([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])"
Field Value
Type Description
System.String

IP_V6_PATTERN

Declaration
public const string IP_V6_PATTERN = "([0-9a-fA-F]){32}|([0-9a-fA-F]{4}:){7}([0-9a-fA-F]){4}|([0-9a-fA-F]){16}|([0-9a-fA-F]{4}:){3}([0-9a-fA-F]){4}"
Field Value
Type Description
System.String

PHONE_PATTERN

Declaration
public const string PHONE_PATTERN = "^\\+?[0-9]+$"
Field Value
Type Description
System.String

Properties

ExceptionValue

Exception value of the setting.

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

Format

Text format of the setting.

Declaration
public Format Format { get; set; }
Property Value
Type Description
Format
Remarks

One of:

  • Format.HEX
  • Format.ASCII
  • Format.IPV4
  • Format.IPV6
  • Format.PHONE
  • Format.NOFORMAT
  • Format.UNKNOWN

MaxChars

Maximum number of characters for the value of the setting.

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

MinChars

Minimum number of characters for the value of the setting.

Declaration
public int MinChars { 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