cybergarage-upnp
org.cybergarage.upnp.StateVariable Class Reference
Inheritance diagram for org.cybergarage.upnp.StateVariable:
org.cybergarage.upnp.xml.NodeData

Public Member Functions

Node getServiceNode ()
 
Service getService ()
 
Node getStateVariableNode ()
 
 StateVariable ()
 
 StateVariable (Node serviceNode, Node stateVarNode)
 
void setName (String value)
 
String getName ()
 
void setDataType (String value)
 
String getDataType ()
 
void setSendEvents (boolean state)
 
boolean isSendEvents ()
 
void set (StateVariable stateVar)
 
StateVariableData getStateVariableData ()
 
void setValue (String value)
 
void setValue (int value)
 
void setValue (long value)
 
String getValue ()
 
AllowedValueList getAllowedValueList ()
 
void setAllowedValueList (AllowedValueList avl)
 
boolean hasAllowedValueList ()
 
AllowedValueRange getAllowedValueRange ()
 
void setAllowedValueRange (AllowedValueRange avr)
 
boolean hasAllowedValueRange ()
 
QueryListener getQueryListener ()
 
void setQueryListener (QueryListener listener)
 
boolean performQueryListener (QueryRequest queryReq)
 
QueryResponse getQueryResponse ()
 
UPnPStatus getQueryStatus ()
 
boolean postQuerylAction ()
 
void setStatus (int code, String descr)
 
void setStatus (int code)
 
UPnPStatus getStatus ()
 
String getDefaultValue ()
 
void setDefaultValue (String value)
 
void setUserData (Object data)
 
Object getUserData ()
 
- Public Member Functions inherited from org.cybergarage.upnp.xml.NodeData
 NodeData ()
 
void setNode (Node node)
 
Node getNode ()
 

Static Public Member Functions

static boolean isStateVariableNode (Node node)
 

Static Public Attributes

static final String ELEM_NAME = "stateVariable"
 

Private Member Functions

void setQueryResponse (QueryResponse res)
 

Private Attributes

Node stateVariableNode
 
Node serviceNode
 
UPnPStatus upnpStatus = new UPnPStatus()
 
Object userData = null
 

Static Private Attributes

static final String NAME = "name"
 
static final String DATATYPE = "dataType"
 
static final String SENDEVENTS = "sendEvents"
 
static final String SENDEVENTS_YES = "yes"
 
static final String SENDEVENTS_NO = "no"
 
static final String DEFAULT_VALUE = "defaultValue"
 

Constructor & Destructor Documentation

◆ StateVariable() [1/2]

org.cybergarage.upnp.StateVariable.StateVariable ( )
inline

◆ StateVariable() [2/2]

org.cybergarage.upnp.StateVariable.StateVariable ( Node serviceNode,
Node stateVarNode )
inline

Member Function Documentation

◆ getAllowedValueList()

AllowedValueList org.cybergarage.upnp.StateVariable.getAllowedValueList ( )
inline

◆ getAllowedValueRange()

AllowedValueRange org.cybergarage.upnp.StateVariable.getAllowedValueRange ( )
inline

◆ getDataType()

String org.cybergarage.upnp.StateVariable.getDataType ( )
inline

◆ getDefaultValue()

String org.cybergarage.upnp.StateVariable.getDefaultValue ( )
inline

◆ getName()

String org.cybergarage.upnp.StateVariable.getName ( )
inline

◆ getQueryListener()

QueryListener org.cybergarage.upnp.StateVariable.getQueryListener ( )
inline

◆ getQueryResponse()

QueryResponse org.cybergarage.upnp.StateVariable.getQueryResponse ( )
inline

◆ getQueryStatus()

UPnPStatus org.cybergarage.upnp.StateVariable.getQueryStatus ( )
inline

◆ getService()

Service org.cybergarage.upnp.StateVariable.getService ( )
inline

◆ getServiceNode()

Node org.cybergarage.upnp.StateVariable.getServiceNode ( )
inline

◆ getStateVariableData()

StateVariableData org.cybergarage.upnp.StateVariable.getStateVariableData ( )
inline

◆ getStateVariableNode()

Node org.cybergarage.upnp.StateVariable.getStateVariableNode ( )
inline

◆ getStatus()

UPnPStatus org.cybergarage.upnp.StateVariable.getStatus ( )
inline

◆ getUserData()

Object org.cybergarage.upnp.StateVariable.getUserData ( )
inline

◆ getValue()

String org.cybergarage.upnp.StateVariable.getValue ( )
inline

◆ hasAllowedValueList()

boolean org.cybergarage.upnp.StateVariable.hasAllowedValueList ( )
inline

◆ hasAllowedValueRange()

boolean org.cybergarage.upnp.StateVariable.hasAllowedValueRange ( )
inline

◆ isSendEvents()

boolean org.cybergarage.upnp.StateVariable.isSendEvents ( )
inline

◆ isStateVariableNode()

static boolean org.cybergarage.upnp.StateVariable.isStateVariableNode ( Node node)
inlinestatic

◆ performQueryListener()

boolean org.cybergarage.upnp.StateVariable.performQueryListener ( QueryRequest queryReq)
inline

◆ postQuerylAction()

boolean org.cybergarage.upnp.StateVariable.postQuerylAction ( )
inline

◆ set()

void org.cybergarage.upnp.StateVariable.set ( StateVariable stateVar)
inline

◆ setAllowedValueList()

void org.cybergarage.upnp.StateVariable.setAllowedValueList ( AllowedValueList avl)
inline

This method ovverride the value of the AllowedValueList Node
of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.
Note2: The enforce the constraint of the SCPD rule the
AllowedValueList and AllowedValueRange are mutal exclusive
the last set will be the only present

Parameters
avlThe new AllowedValueList
Author
Stefano "Kismet" Lenzi - kisme.nosp@m.t-sl.nosp@m.@user.nosp@m.s.so.nosp@m.urcef.nosp@m.orge.nosp@m..net - 2005

◆ setAllowedValueRange()

void org.cybergarage.upnp.StateVariable.setAllowedValueRange ( AllowedValueRange avr)
inline

This method ovverride the value of the AllowedValueRange Node
of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.
Note2: The enforce the constraint of the SCPD rule the
AllowedValueList and AllowedValueRange are mutal exclusive
the last set will be the only present

Parameters
avrThe new AllowedValueRange
Author
Stefano "Kismet" Lenzi - kisme.nosp@m.t-sl.nosp@m.@user.nosp@m.s.so.nosp@m.urcef.nosp@m.orge.nosp@m..net - 2005

◆ setDataType()

void org.cybergarage.upnp.StateVariable.setDataType ( String value)
inline

◆ setDefaultValue()

void org.cybergarage.upnp.StateVariable.setDefaultValue ( String value)
inline

This method ovverride the value of the DefaultValue of this object.

Note: This method should be used to create a dynamic
Device withtout writing any XML that describe the device
.

Parameters
valueThe new String value
Author
Stefano Lenzi kisme.nosp@m.t-sl.nosp@m.@user.nosp@m.s.so.nosp@m.urcef.nosp@m.orge.nosp@m..net

◆ setName()

void org.cybergarage.upnp.StateVariable.setName ( String value)
inline

◆ setQueryListener()

void org.cybergarage.upnp.StateVariable.setQueryListener ( QueryListener listener)
inline

◆ setQueryResponse()

void org.cybergarage.upnp.StateVariable.setQueryResponse ( QueryResponse res)
inlineprivate

◆ setSendEvents()

void org.cybergarage.upnp.StateVariable.setSendEvents ( boolean state)
inline

◆ setStatus() [1/2]

void org.cybergarage.upnp.StateVariable.setStatus ( int code)
inline

◆ setStatus() [2/2]

void org.cybergarage.upnp.StateVariable.setStatus ( int code,
String descr )
inline

◆ setUserData()

void org.cybergarage.upnp.StateVariable.setUserData ( Object data)
inline

◆ setValue() [1/3]

void org.cybergarage.upnp.StateVariable.setValue ( int value)
inline

◆ setValue() [2/3]

void org.cybergarage.upnp.StateVariable.setValue ( long value)
inline

◆ setValue() [3/3]

void org.cybergarage.upnp.StateVariable.setValue ( String value)
inline

Field Documentation

◆ DATATYPE

final String org.cybergarage.upnp.StateVariable.DATATYPE = "dataType"
staticprivate

◆ DEFAULT_VALUE

final String org.cybergarage.upnp.StateVariable.DEFAULT_VALUE = "defaultValue"
staticprivate

◆ ELEM_NAME

final String org.cybergarage.upnp.StateVariable.ELEM_NAME = "stateVariable"
static

◆ NAME

final String org.cybergarage.upnp.StateVariable.NAME = "name"
staticprivate

◆ SENDEVENTS

final String org.cybergarage.upnp.StateVariable.SENDEVENTS = "sendEvents"
staticprivate

◆ SENDEVENTS_NO

final String org.cybergarage.upnp.StateVariable.SENDEVENTS_NO = "no"
staticprivate

◆ SENDEVENTS_YES

final String org.cybergarage.upnp.StateVariable.SENDEVENTS_YES = "yes"
staticprivate

◆ serviceNode

Node org.cybergarage.upnp.StateVariable.serviceNode
private

◆ stateVariableNode

Node org.cybergarage.upnp.StateVariable.stateVariableNode
private

◆ upnpStatus

UPnPStatus org.cybergarage.upnp.StateVariable.upnpStatus = new UPnPStatus()
private

◆ userData

Object org.cybergarage.upnp.StateVariable.userData = null
private

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