LODMXResponse Class Reference

Encapsulation of a response from the hardware interface. More...

#import <LODMXResponse.h>

Inheritance diagram for LODMXResponse:

Public Member Functions
(id)	- initWithCode:onBridge:
	Initilise a DMX Response with the given response code.
(id)	- initWithCode:andChannel:onBridge:
	Initilise a DMX Response with the given response code and channel.
(id)	- initWithCode:andChannel:withValue:onBridge:
	Initilise a DMX Response with the given response code, channel and value.
(LOHWBridge *)	- hwBridge
	Returns the hwBridge.
(unsigned char)	- code
	Returns the code.
(unsigned int)	- channel
	Returns the channel.
(unsigned char)	- value
	Returns the value.
(NSString *)	- codeAsString
	Return the response code as a String.
Static Public Member Functions
(id)	+ responseWithCode:onBridge:
	Returns an allocated and initilised DMX Response with the given response code.
(id)	+ responseWithCode:andChannel:onBridge:
	Returns an allocated and initilised DMX Response with the given response code and channel.
(id)	+ responseWithCode:andChannel:withValue:onBridge:
	Returns an allocated and initilised DMX Response with the given response code, channel and value.
Protected Attributes
unsigned char	code
	The code value.
unsigned int	channel
	The related channel if present.
unsigned char	value
	The related value if present.
LOHWBridge *	hwBridge
	The hwBridge that generated the response.

---

Detailed Description

Encapsulation of a response from the hardware interface.

This object is created and submitted to the NSDefaultNotificationCenter by the the LOHWBridge.

---

Member Function Documentation

- (unsigned int) channel

Returns the channel.

Returns:

The channel number part of the response

- (unsigned char) code

Returns the code.

Returns:

The code part of the response

- (NSString *) codeAsString

Return the response code as a String.

Returns:

A String object containg a description of the respose code

- (LOHWBridge *) hwBridge

Returns the hwBridge.

Returns:

The hwBridge that sent this response

- (id) initWithCode:		(unsigned char)	theCode
andChannel:		(unsigned int)	theChannel
onBridge:		(LOHWBridge *)	theBridge

Initilise a DMX Response with the given response code and channel.

Parameters:

	theCode	The response code
	theChannel	The Channel number
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

- (id) initWithCode:		(unsigned char)	theCode
andChannel:		(unsigned int)	theChannel
withValue:		(unsigned char)	theValue
onBridge:		(LOHWBridge *)	theBridge

Initilise a DMX Response with the given response code, channel and value.

Parameters:

	theCode	The response code
	theChannel	The Channel number
	theValue	The value
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

- (id) initWithCode:		(unsigned char)	theCode
onBridge:		(LOHWBridge *)	theBridge

Initilise a DMX Response with the given response code.

Parameters:

	theCode	The response code
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

+ (id) responseWithCode:		(unsigned char)	theCode
andChannel:		(unsigned int)	theChannel
onBridge:		(LOHWBridge *)	theBridge

Returns an allocated and initilised DMX Response with the given response code and channel.

Parameters:

	theCode	The response code
	theChannel	The Channel number
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

+ (id) responseWithCode:		(unsigned char)	theCode
andChannel:		(unsigned int)	theChannel
withValue:		(unsigned char)	theValue
onBridge:		(LOHWBridge *)	theBridge

Returns an allocated and initilised DMX Response with the given response code, channel and value.

Parameters:

	theCode	The response code
	theChannel	The Channel number
	theValue	The value
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

+ (id) responseWithCode:		(unsigned char)	theCode
onBridge:		(LOHWBridge *)	theBridge

Returns an allocated and initilised DMX Response with the given response code.

Parameters:

	theCode	The response code
	theBridge	The hwBridge that is sending the response

Returns:

The DMX Response object

- (unsigned char) value

Returns the value.

Returns:

The value part of the response

---

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

• LODMXResponse.h
• LODMXResponse.m