usbdmx.com Home of the opto isolated, bus powered, DMX512 interface with both in and out universes. Cheap and simple to build. USBDMX logo

LOFixtureChannel Class Reference

A fixture channel is a named channel, offset from a base address. More...

#import <LOFixtureChannel.h>


Public Member Functions

(id) - initWithName:andOffset:fromBaseAddress:
 Initilise the Fixture Channel.
(NSXMLElement *) - XML
 Get the channel as an XML Element.
(NSString *) - name
 Get the name.
(void) - setName:
 Set the name.
(LOFixtureBaseAddress *) - baseAddress
 Get the base address.
(void) - setBaseAddress:
 Set the base address.
(unsigned) - offset
 Get the offset from the base address.
(void) - setOffset:
 set the offset from the base address
(unsigned) - softPatchOffset
 Get the offset for this channel in the fixtures softPatch.
(void) - setSoftPatchOffset:
 set the offset into the softPatch

Protected Attributes

NSString * name
LOFixtureBaseAddressbaseAddress
 The base address this channel belongs to.
unsigned offset
 The offset from the base address.
unsigned softPatchOffset
 The offset into the softpatch.


Detailed Description

A fixture channel is a named channel, offset from a base address.

All attributes use one or more fixture channels.


Member Function Documentation

Get the base address.

See also:
- setName:

- (id) initWithName: (NSString *)  aName
andOffset: (unsigned)  anOffset
fromBaseAddress: (LOFixtureBaseAddress *)  theBaseAddress 

Initilise the Fixture Channel.

- (NSString *) name  

Get the name.

See also:
- setName:

- (unsigned) offset  

Get the offset from the base address.

See also:
- setOffset:

- (void) setBaseAddress: (LOFixtureBaseAddress *)  aBaseAddress  

Set the base address.

See also:
name:

- (void) setName: (NSString *)  aName  

Set the name.

See also:
name:

- (void) setOffset: (unsigned)  anOffset  

set the offset from the base address

Parameters:
anOffset The offset (zero indexed)
See also:
offset:

- (void) setSoftPatchOffset: (unsigned)  anOffset  

set the offset into the softPatch

Parameters:
anOffset The offset (zero indexed)
See also:
softPatchOffset:

- (unsigned) softPatchOffset  

Get the offset for this channel in the fixtures softPatch.

On a fixture with only 1 base address, this will be the same as offset,

See also:
- setSoftPatchOffset:

- (NSXMLElement *) XML  

Get the channel as an XML Element.

  <channel name="name" offset="x"/>


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