ChannelType (prtg-xml 3.0.0 API)

java.lang.Object
- org.adeptnet.prtg.xml.ChannelType

All Implemented Interfaces:: Serializable

public class ChannelType
extends Object
implements Serializable

Java class for ChannelType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ChannelType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="channel" type="{http://www.w3.org/2001/XMLSchema}token"/>
         <element name="value" type="{http://xml.adeptnet.org/prtg/prtg.xsd}ValuePattern" minOccurs="0"/>
         <element name="unit" type="{http://xml.adeptnet.org/prtg/prtg.xsd}UnitType" minOccurs="0"/>
         <element name="customunit" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="speedsize" type="{http://xml.adeptnet.org/prtg/prtg.xsd}UnitSizeType" minOccurs="0"/>
         <element name="volumesize" type="{http://xml.adeptnet.org/prtg/prtg.xsd}UnitSizeType" minOccurs="0"/>
         <element name="speedtime" type="{http://xml.adeptnet.org/prtg/prtg.xsd}TimeType" minOccurs="0"/>
         <element name="mode" type="{http://xml.adeptnet.org/prtg/prtg.xsd}ModeType" minOccurs="0"/>
         <element name="float" type="{http://xml.adeptnet.org/prtg/prtg.xsd}BooleanType" minOccurs="0"/>
         <element name="decimalmode" type="{http://xml.adeptnet.org/prtg/prtg.xsd}DecimalModeType" minOccurs="0"/>
         <element name="warning" type="{http://xml.adeptnet.org/prtg/prtg.xsd}BooleanType" minOccurs="0"/>
         <element name="showchart" type="{http://xml.adeptnet.org/prtg/prtg.xsd}BooleanType" minOccurs="0"/>
         <element name="showtable" type="{http://xml.adeptnet.org/prtg/prtg.xsd}BooleanType" minOccurs="0"/>
         <element name="limitmaxerror" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="limitmaxwarning" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="limitminwarning" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="limitminerror" type="{http://www.w3.org/2001/XMLSchema}integer" minOccurs="0"/>
         <element name="limiterrormsg" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="limitwarningmsg" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
         <element name="limitmode" type="{http://xml.adeptnet.org/prtg/prtg.xsd}BooleanType" minOccurs="0"/>
         <element name="valuelookup" type="{http://www.w3.org/2001/XMLSchema}token" minOccurs="0"/>
       </sequence>
       <attribute ref="{http://www.w3.org/XML/1998/namespace}base"/>
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected BooleanType`	`_float`
`protected String`	`base`
`protected String`	`customUnit`
`protected DecimalModeType`	`decimalMode`
`protected String`	`limitErrorMessage`
`protected BigInteger`	`limitMaxError`
`protected BigInteger`	`limitMaxWarning`
`protected BigInteger`	`limitMinError`
`protected BigInteger`	`limitMinWarning`
`protected BooleanType`	`limitMode`
`protected String`	`limitWarningMessage`
`protected ModeType`	`mode`
`protected String`	`name`
`protected BooleanType`	`showChart`
`protected BooleanType`	`showtable`
`protected UnitSizeType`	`speedSize`
`protected TimeType`	`speedTime`
`protected UnitType`	`unit`
`protected String`	`value`
`protected String`	`valueLookup`
`protected UnitSizeType`	`volumeSize`
`protected BooleanType`	`warning`

Constructor Summary

Constructors
Constructor and Description

ChannelType()

ChannelType(String name, UnitType unit, Object value)

Constructors
Constructor and Description
`ChannelType()`
`ChannelType(String name, UnitType unit, Object value)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBase()` Gets the value of the base property.
`String`	`getCustomUnit()` If Custom is used as unit this is the text displayed behind the value.
`DecimalModeType`	`getDecimalMode()` Init value for the Decimal Places option.
`BooleanType`	`getFloat()` Define if the value is a float.
`String`	`getLimitErrorMessage()` Define an additional message.
`BigInteger`	`getLimitMaxError()` Define an upper error limit for the channel.
`BigInteger`	`getLimitMaxWarning()` Define an upper warning limit for the channel.
`BigInteger`	`getLimitMinError()` Define a lower error limit for the channel.
`BigInteger`	`getLimitMinWarning()` Define a lower warning limit for the channel.
`BooleanType`	`getLimitMode()` Define if the limit settings defined above will be active.
`String`	`getLimitWarningMessage()` Define an additional message.
`ModeType`	`getMode()` Selects if the value is a absolut value or counter.
`String`	`getName()` Name of the channel as displayed in user interfaces.
`BooleanType`	`getShowChart()` Init value for the Show in Chart option.
`BooleanType`	`getShowtable()` Init value for the Show in Table option.
`UnitSizeType`	`getSpeedSize()` Size used for the display value.
`TimeType`	`getSpeedTime()` See above, used when displaying the speed.
`UnitType`	`getUnit()` The unit of the value.
`String`	`getValue()` The value as integer or float.
`String`	`getValueLookup()` Define if you want to use a lookup file (e.g.
`UnitSizeType`	`getVolumeSize()` Size used for the display value.
`BooleanType`	`getWarning()` If enabled for at least one channel, the entire sensor is set to warning status.
`boolean`	`isSetBase()`
`boolean`	`isSetCustomUnit()`
`boolean`	`isSetDecimalMode()`
`boolean`	`isSetFloat()`
`boolean`	`isSetLimitErrorMessage()`
`boolean`	`isSetLimitMaxError()`
`boolean`	`isSetLimitMaxWarning()`
`boolean`	`isSetLimitMinError()`
`boolean`	`isSetLimitMinWarning()`
`boolean`	`isSetLimitMode()`
`boolean`	`isSetLimitWarningMessage()`
`boolean`	`isSetMode()`
`boolean`	`isSetName()`
`boolean`	`isSetShowChart()`
`boolean`	`isSetShowtable()`
`boolean`	`isSetSpeedSize()`
`boolean`	`isSetSpeedTime()`
`boolean`	`isSetUnit()`
`boolean`	`isSetValue()`
`boolean`	`isSetValueLookup()`
`boolean`	`isSetVolumeSize()`
`boolean`	`isSetWarning()`
`void`	`setBase(String value)` Sets the value of the base property.
`void`	`setCustomUnit(String value)` Sets the value of the customUnit property.
`void`	`setDecimalMode(DecimalModeType value)` Sets the value of the decimalMode property.
`void`	`setFloat(BooleanType value)` Sets the value of the float property.
`void`	`setLimitErrorMessage(String value)` Sets the value of the limitErrorMessage property.
`void`	`setLimitMaxError(BigInteger value)` Sets the value of the limitMaxError property.
`void`	`setLimitMaxWarning(BigInteger value)` Sets the value of the limitMaxWarning property.
`void`	`setLimitMinError(BigInteger value)` Sets the value of the limitMinError property.
`void`	`setLimitMinWarning(BigInteger value)` Sets the value of the limitMinWarning property.
`void`	`setLimitMode(BooleanType value)` Sets the value of the limitMode property.
`void`	`setLimitWarningMessage(String value)` Sets the value of the limitWarningMessage property.
`void`	`setMode(ModeType value)` Sets the value of the mode property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setShowChart(BooleanType value)` Sets the value of the showChart property.
`void`	`setShowtable(BooleanType value)` Sets the value of the showtable property.
`void`	`setSpeedSize(UnitSizeType value)` Sets the value of the speedSize property.
`void`	`setSpeedTime(TimeType value)` Sets the value of the speedTime property.
`void`	`setUnit(UnitType value)` Sets the value of the unit property.
`void`	`setValue(Object value)`
`void`	`setValue(String value)` Sets the value of the value property.
`void`	`setValueLookup(String value)` Sets the value of the valueLookup property.
`void`	`setVolumeSize(UnitSizeType value)` Sets the value of the volumeSize property.
`void`	`setWarning(BooleanType value)` Sets the value of the warning property.
`<F extends ChannelType> F`	`upCast(Class<F> clazz)`
`ChannelType`	`withValue(Object value)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - value
```
protected String value
```
  - unit
```
protected UnitType unit
```
  - customUnit
```
protected String customUnit
```
  - speedSize
```
protected UnitSizeType speedSize
```
  - volumeSize
```
protected UnitSizeType volumeSize
```
  - speedTime
```
protected TimeType speedTime
```
  - mode
```
protected ModeType mode
```
  - _float
```
protected BooleanType _float
```
  - decimalMode
```
protected DecimalModeType decimalMode
```
  - warning
```
protected BooleanType warning
```
  - showChart
```
protected BooleanType showChart
```
  - showtable
```
protected BooleanType showtable
```
  - limitMaxError
```
protected BigInteger limitMaxError
```
  - limitMaxWarning
```
protected BigInteger limitMaxWarning
```
  - limitMinWarning
```
protected BigInteger limitMinWarning
```
  - limitMinError
```
protected BigInteger limitMinError
```
  - limitErrorMessage
```
protected String limitErrorMessage
```
  - limitWarningMessage
```
protected String limitWarningMessage
```
  - limitMode
```
protected BooleanType limitMode
```
  - valueLookup
```
protected String valueLookup
```
  - base
```
protected String base
```
- Constructor Detail
  - ChannelType
```
public ChannelType()
```
  - ChannelType
```
public ChannelType(String name,
                   UnitType unit,
                   Object value)
```
- Method Detail
  - getName
```
public String getName()
```
    Name of the channel as displayed in user interfaces. This parameter is required and must be unique for the sensor.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - isSetName
```
public boolean isSetName()
```
  - getValue
```
public String getValue()
```
    The value as integer or float. Please make sure the <Float> setting matches the kind of value provided. Otherwise PRTG will show 0 values.
    
    Returns:
    
    possible object is String
  - setValue
```
public void setValue(String value)
```
    Sets the value of the value property.
    
    Parameters:
    
    value - allowed object is String
  - isSetValue
```
public boolean isSetValue()
```
  - getUnit
```
public UnitType getUnit()
```
    The unit of the value. Default is Custom. Useful for PRTG to be able to convert volumes and times.
    
    Returns:
    
    possible object is UnitType
  - setUnit
```
public void setUnit(UnitType value)
```
    Sets the value of the unit property.
    
    Parameters:
    
    value - allowed object is UnitType
  - isSetUnit
```
public boolean isSetUnit()
```
  - getCustomUnit
```
public String getCustomUnit()
```
    If Custom is used as unit this is the text displayed behind the value.
    
    Returns:
    
    possible object is String
  - setCustomUnit
```
public void setCustomUnit(String value)
```
    Sets the value of the customUnit property.
    
    Parameters:
    
    value - allowed object is String
  - isSetCustomUnit
```
public boolean isSetCustomUnit()
```
  - getSpeedSize
```
public UnitSizeType getSpeedSize()
```
    Size used for the display value. E.g. if you have a value of 50000 and use Kilo as size the display is 50 kilo #. Default is One (value used as returned). For the Bytes and Speed units this is overridden by the setting in the user interface.
    
    Returns:
    
    possible object is UnitSizeType
  - setSpeedSize
```
public void setSpeedSize(UnitSizeType value)
```
    Sets the value of the speedSize property.
    
    Parameters:
    
    value - allowed object is UnitSizeType
  - isSetSpeedSize
```
public boolean isSetSpeedSize()
```
  - getVolumeSize
```
public UnitSizeType getVolumeSize()
```
    Size used for the display value. E.g. if you have a value of 50000 and use Kilo as size the display is 50 kilo #. Default is One (value used as returned). For the Bytes and Speed units this is overridden by the setting in the user interface.
    
    Returns:
    
    possible object is UnitSizeType
  - setVolumeSize
```
public void setVolumeSize(UnitSizeType value)
```
    Sets the value of the volumeSize property.
    
    Parameters:
    
    value - allowed object is UnitSizeType
  - isSetVolumeSize
```
public boolean isSetVolumeSize()
```
  - getSpeedTime
```
public TimeType getSpeedTime()
```
    See above, used when displaying the speed. Default is Second.
    
    Returns:
    
    possible object is TimeType
  - setSpeedTime
```
public void setSpeedTime(TimeType value)
```
    Sets the value of the speedTime property.
    
    Parameters:
    
    value - allowed object is TimeType
  - isSetSpeedTime
```
public boolean isSetSpeedTime()
```
  - getMode
```
public ModeType getMode()
```
    Selects if the value is a absolut value or counter. Default is Absolute.
    
    Returns:
    
    possible object is ModeType
  - setMode
```
public void setMode(ModeType value)
```
    Sets the value of the mode property.
    
    Parameters:
    
    value - allowed object is ModeType
  - isSetMode
```
public boolean isSetMode()
```
  - getFloat
```
public BooleanType getFloat()
```
    Define if the value is a float. Default is 0 (no). If set to 1 (yes), use a dot as decimal seperator in values. Note: Define decimal places with the <DecimalMode> element.
    
    Returns:
    
    possible object is BooleanType
  - setFloat
```
public void setFloat(BooleanType value)
```
    Sets the value of the float property.
    
    Parameters:
    
    value - allowed object is BooleanType
  - isSetFloat
```
public boolean isSetFloat()
```
  - getDecimalMode
```
public DecimalModeType getDecimalMode()
```
    Init value for the Decimal Places option. If 0 is used in the <Float> element (i.e. use integer), the default is Auto; otherwise (i.e. for float) default is All. Note: In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is DecimalModeType
  - setDecimalMode
```
public void setDecimalMode(DecimalModeType value)
```
    Sets the value of the decimalMode property.
    
    Parameters:
    
    value - allowed object is DecimalModeType
  - isSetDecimalMode
```
public boolean isSetDecimalMode()
```
  - getWarning
```
public BooleanType getWarning()
```
    If enabled for at least one channel, the entire sensor is set to warning status. Default is 0 (no).
    
    Returns:
    
    possible object is BooleanType
  - setWarning
```
public void setWarning(BooleanType value)
```
    Sets the value of the warning property.
    
    Parameters:
    
    value - allowed object is BooleanType
  - isSetWarning
```
public boolean isSetWarning()
```
  - getShowChart
```
public BooleanType getShowChart()
```
    Init value for the Show in Chart option. Default is 1 (yes). Note: The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BooleanType
  - setShowChart
```
public void setShowChart(BooleanType value)
```
    Sets the value of the showChart property.
    
    Parameters:
    
    value - allowed object is BooleanType
  - isSetShowChart
```
public boolean isSetShowChart()
```
  - getShowtable
```
public BooleanType getShowtable()
```
    Init value for the Show in Table option. Default is 1 (yes). Note: The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BooleanType
  - setShowtable
```
public void setShowtable(BooleanType value)
```
    Sets the value of the showtable property.
    
    Parameters:
    
    value - allowed object is BooleanType
  - isSetShowtable
```
public boolean isSetShowtable()
```
  - getLimitMaxError
```
public BigInteger getLimitMaxError()
```
    Define an upper error limit for the channel. If enabled, the sensor will be set to a "Down" status if this value is overrun and the LimitMode is activated. Note: Please provide the limit value in the unit of the base data type, just as used in the <Value> element of this section. While a sensor shows a "Down" status triggered by a limit, it will still receive data in its channels. The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BigInteger
  - setLimitMaxError
```
public void setLimitMaxError(BigInteger value)
```
    Sets the value of the limitMaxError property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - isSetLimitMaxError
```
public boolean isSetLimitMaxError()
```
  - getLimitMaxWarning
```
public BigInteger getLimitMaxWarning()
```
    Define an upper warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if this value is overrun and the LimitMode is activated. Note: Please provide the limit value in the unit of the base data type, just as used in the <Value> element of this section. The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BigInteger
  - setLimitMaxWarning
```
public void setLimitMaxWarning(BigInteger value)
```
    Sets the value of the limitMaxWarning property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - isSetLimitMaxWarning
```
public boolean isSetLimitMaxWarning()
```
  - getLimitMinWarning
```
public BigInteger getLimitMinWarning()
```
    Define a lower warning limit for the channel. If enabled, the sensor will be set to a "Warning" status if this value is undercut and the LimitMode is activated. Note: Please provide the limit value in the unit of the base data type, just as used in the <Value> element of this section. The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BigInteger
  - setLimitMinWarning
```
public void setLimitMinWarning(BigInteger value)
```
    Sets the value of the limitMinWarning property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - isSetLimitMinWarning
```
public boolean isSetLimitMinWarning()
```
  - getLimitMinError
```
public BigInteger getLimitMinError()
```
    Define a lower error limit for the channel. If enabled, the sensor will be set to a "Down" status if this value is undercut and the LimitMode is activated. Note: Please provide the limit value in the unit of the base data type, just as used in the <Value> element of this section. While a sensor shows a "Down" status triggered by a limit, it will still receive data in its channels. The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BigInteger
  - setLimitMinError
```
public void setLimitMinError(BigInteger value)
```
    Sets the value of the limitMinError property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - isSetLimitMinError
```
public boolean isSetLimitMinError()
```
  - getLimitErrorMessage
```
public String getLimitErrorMessage()
```
    Define an additional message. It will be added to the sensor's message when entering a "Down" status that is triggered by a limit. Note: The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is String
  - setLimitErrorMessage
```
public void setLimitErrorMessage(String value)
```
    Sets the value of the limitErrorMessage property.
    
    Parameters:
    
    value - allowed object is String
  - isSetLimitErrorMessage
```
public boolean isSetLimitErrorMessage()
```
  - getLimitWarningMessage
```
public String getLimitWarningMessage()
```
    Define an additional message. It will be added to the sensor's message when entering a "Warning" status that is triggered by a limit. Note: The values defined with this element will be considered only on the first sensor scan, when the channel is newly created; they are ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is String
  - setLimitWarningMessage
```
public void setLimitWarningMessage(String value)
```
    Sets the value of the limitWarningMessage property.
    
    Parameters:
    
    value - allowed object is String
  - isSetLimitWarningMessage
```
public boolean isSetLimitWarningMessage()
```
  - getLimitMode
```
public BooleanType getLimitMode()
```
    Define if the limit settings defined above will be active. Default is 0 (no; limits inactive). If 0 is used the limits will be written to the sensor channel settings as predefined values, but limits will be disabled. Note: This setting will be considered only on the first sensor scan, when the channel is newly created; it is ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is BooleanType
  - setLimitMode
```
public void setLimitMode(BooleanType value)
```
    Sets the value of the limitMode property.
    
    Parameters:
    
    value - allowed object is BooleanType
  - isSetLimitMode
```
public boolean isSetLimitMode()
```
  - getValueLookup
```
public String getValueLookup()
```
    Define if you want to use a lookup file (e.g. to view integer values as status texts). Please enter the ID of the lookup file you want to use, or omit this element to not use lookups. Note: This setting will be considered only on the first sensor scan, when the channel is newly created; it is ignored on all further sensor scans (and may be omitted). In the sensor's Channels tab, you can change this initial setting later.
    
    Returns:
    
    possible object is String
  - setValueLookup
```
public void setValueLookup(String value)
```
    Sets the value of the valueLookup property.
    
    Parameters:
    
    value - allowed object is String
  - isSetValueLookup
```
public boolean isSetValueLookup()
```
  - getBase
```
public String getBase()
```
    Gets the value of the base property.
    
    Returns:
    
    possible object is String
  - setBase
```
public void setBase(String value)
```
    Sets the value of the base property.
    
    Parameters:
    
    value - allowed object is String
  - isSetBase
```
public boolean isSetBase()
```
  - setValue
```
public final void setValue(Object value)
```
  - withValue
```
public ChannelType withValue(Object value)
```
  - upCast
```
public <F extends ChannelType> F upCast(Class<F> clazz)
```

Class ChannelType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

value

unit

customUnit

speedSize

volumeSize

speedTime

mode

_float

decimalMode

warning

showChart

showtable

limitMaxError

limitMaxWarning

limitMinWarning

limitMinError

limitErrorMessage

limitWarningMessage

limitMode

valueLookup

base

Constructor Detail

ChannelType

ChannelType

Method Detail

getName

setName

isSetName

getValue

setValue

isSetValue

getUnit

setUnit

isSetUnit

getCustomUnit

setCustomUnit

isSetCustomUnit

getSpeedSize

setSpeedSize

isSetSpeedSize

getVolumeSize

setVolumeSize

isSetVolumeSize

getSpeedTime

setSpeedTime

isSetSpeedTime

getMode

setMode

isSetMode

getFloat

setFloat

isSetFloat

getDecimalMode

setDecimalMode

isSetDecimalMode

getWarning

setWarning

isSetWarning

getShowChart

setShowChart

isSetShowChart

getShowtable

setShowtable

isSetShowtable

getLimitMaxError

setLimitMaxError

isSetLimitMaxError

getLimitMaxWarning

setLimitMaxWarning

isSetLimitMaxWarning

getLimitMinWarning

setLimitMinWarning

isSetLimitMinWarning