1-Wire API for .NET Version 4.00
Public Member Functions | Public Attributes

TaggedDevice Class Reference

This class provides a default object for a tagged 1-Wire device. More...

Inherited by Contact, D2A, Event, Humidity, Level, Switch, and Thermal.

List of all members.

Public Member Functions

 TaggedDevice (DSPortAdapter adapter, String netAddress)
 Creates an object for the device with the supplied address and device type connected to the supplied port adapter.
 TaggedDevice ()
 Creates an object for the device.
void setDeviceContainer (DSPortAdapter adapter, String netAddress)
 Sets the 1-Wire Container for the tagged device.
void setDeviceType (String tType)
 Sets the device type for the tagged device.
void setLabel (String Label)
 Sets the label for the tagged device.
void setChannelFromString (String Channel)
 Sets the channel for the tagged device from a String.
void setChannel (int Channel)
 Sets the channel for the tagged device from an int.
void setInit (String Init)
 Sets the init (initialization String) for the tagged device.
void setClusterName (String cluster)
 Sets the cluster name for the tagged device.
void setBranches (Vector branches)
 Sets the vector of branches to get to the tagged device.
void setOWPath (OWPath branchOWPath)
 Sets the OWPath for the tagged device.
void setOWPath (DSPortAdapter adapter, Vector Branches)
 Sets the OWPath for the tagged device.
OneWireContainer getDeviceContainer ()
 Gets the 1-Wire Container for the tagged device.
String getDeviceType ()
 Gets the device type for the tagged device.
String getLabel ()
 Gets the label for the tagged device.
String getChannelAsString ()
 Gets the channel for the tagged device as a String.
int getChannel ()
 Gets the channel for the tagged device as an int.
String getInit ()
 Gets the init (Initialization String) for the tagged device.
String getMax ()
 Gets the max string for the tagged device.
String getMin ()
 Gets the min string for the tagged device.
String getClusterName ()
 Gets the cluster name for the tagged device.
Vector getBranches ()
 Gets a vector of branches (to get to) the tagged device.
OWPath getOWPath ()
 Gets the OWPath for the tagged device.

Public Attributes

OneWireContainer DeviceContainer
 ********* Properties (fields) for this object **********
String DeviceType
 Device type for the device (i.e., contact, switch, d2a, etc.).
String label
 Label for the "name" of the device.
Integer channel
 The channel on which to probe for info.
String max
 A string message representing a high or maximum value.
String min
 A string message representing a low or minimum value.
Boolean state
 A true or false describing the state of the tagged device.
String init
 An initialization parameter for the tagged device.
String clusterName
 The name of the cluster to which the tagged device is associated.
Vector branchVector
 A Vector of branches describing how to physically get to the tagged device through a set of 1-Wire switches.

Detailed Description

This class provides a default object for a tagged 1-Wire device.


Constructor & Destructor Documentation

TaggedDevice ( DSPortAdapter  adapter,
String  netAddress 
)

Creates an object for the device with the supplied address and device type connected to the supplied port adapter.

Parameters:
adapterThe adapter serving the sensor.
NetAddressThe 1-Wire network address of the sensor.
netAddress

Member Function Documentation

Vector getBranches ( )

Gets a vector of branches (to get to) the tagged device.

Returns:
The vector of branches to get to the tagged device.
int getChannel ( )

Gets the channel for the tagged device as an int.

Returns:
The channel for the tagged device as an int.
String getChannelAsString ( )

Gets the channel for the tagged device as a String.

Returns:
The channel for the tagged device as a String.
String getClusterName ( )

Gets the cluster name for the tagged device.

Returns:
The cluster name for the tagged device.
OneWireContainer getDeviceContainer ( )

Gets the 1-Wire Container for the tagged device.

Returns:
The 1-Wire container for the tagged device.
String getDeviceType ( )

Gets the device type for the tagged device.

Returns:
The device type for the tagged device.
String getInit ( )

Gets the init (Initialization String) for the tagged device.

Returns:
String init (Initialization String)
String getLabel ( )

Gets the label for the tagged device.

Returns:
The label for the tagged device.
String getMax ( )

Gets the max string for the tagged device.

Returns:
String Gets the max string
String getMin ( )

Gets the min string for the tagged device.

Returns:
String Gets the min string
OWPath getOWPath ( )

Gets the OWPath for the tagged device.

An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.

Returns:
The OWPath for the tagged device.
void setBranches ( Vector  branches)

Sets the vector of branches to get to the tagged device.

Parameters:
branches
void setChannel ( int  Channel)

Sets the channel for the tagged device from an int.

Parameters:
Channel
void setChannelFromString ( String  Channel)

Sets the channel for the tagged device from a String.

Parameters:
Channel
void setClusterName ( String  cluster)

Sets the cluster name for the tagged device.

Parameters:
cluster
void setDeviceType ( String  tType)

Sets the device type for the tagged device.

Parameters:
tType
void setInit ( String  Init)

Sets the init (initialization String) for the tagged device.

Parameters:
init
void setLabel ( String  Label)

Sets the label for the tagged device.

Parameters:
Label
void setOWPath ( DSPortAdapter  adapter,
Vector  Branches 
)

Sets the OWPath for the tagged device.

An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.

Parameters:
adapter
Branches
void setOWPath ( OWPath  branchOWPath)

Sets the OWPath for the tagged device.

An OWPath is a description of how to physically get to a 1-Wire device through a set of nested 1-Wire switches.

Parameters:
branchOWPath

Member Data Documentation

String clusterName

The name of the cluster to which the tagged device is associated.

Nested clusters will have a forward slash ("/") between each cluster, much like a path.

OneWireContainer DeviceContainer

********* Properties (fields) for this object **********

1-Wire Container for the tagged device.


The documentation for this class was generated from the following file: