LOFixtureBaseAddress Class Reference

A base address is the first channel in a series of channels that define a fixtures attributes. More...

#import <LOFixtureBaseAddress.h>

Public Member Functions
(id)	- initWithName:andChannelCount:
	Initilise with a name and the number of channels that can be offset.
(id)	- initWithXML:
	Initilise from an XML Element.
(NSXMLElement *)	- XML
	Get the base address as an XML Element.
(NSString *)	- name
	Get the name.
(void)	- setName:
	Set the name.
(LOFixture *)	- fixture
	Get the fixture this base address is associated with.
(void)	- setFixture:
	Set the fixture this base address is associated with.
(unsigned)	- startChannel
	Set the start channel.
(void)	- setStartChannel:
	Set the start channel, this is the channle number from the channel manager.
(NSString *)	- nameAtOffset:
	Get the name of the channel at offset.
(void)	- setName:atOffset:
	Set the name of the channel at offset.
(LOFixtureChannel *)	- channelAtOffset:
	Get the channel object at the given offset.
(unsigned)	- count
	Get the number of channels that can be offset from this base address.
Protected Attributes
LOFixture *	fixture
	The fixture this base address is associated with.
NSString *	name
NSMutableArray *	channels
	Array of LOFixtureChannel.
unsigned	startChannel
	The actual patched channel from the channel manager. 0 means no channel.

---

Detailed Description

A base address is the first channel in a series of channels that define a fixtures attributes.

---

Member Function Documentation

- (LOFixtureChannel *) channelAtOffset:

(unsigned)

offset

Get the channel object at the given offset.

Parameters:

offset

The offset from the base address (zero indexed)

- (unsigned) count

Get the number of channels that can be offset from this base address.

- (LOFixture *) fixture

Get the fixture this base address is associated with.

See also:

- setFixture:

- (id) initWithName:		(NSString *)	aName
andChannelCount:		(unsigned)	count

Initilise with a name and the number of channels that can be offset.

- (id) initWithXML:

(NSXMLElement *)

XMLElement

Initilise from an XML Element.

- (NSString *) name

Get the name.

See also:

- setName:

- (NSString *) nameAtOffset:

(unsigned)

offset

Get the name of the channel at offset.

Parameters:

offset

The offset from the base address (zero indexed)

- (void) setFixture:

(LOFixture *)

aFixture

Set the fixture this base address is associated with.

See also:

fixture:

- (void) setName:

(NSString *)

aName

Set the name.

See also:

name:

- (void) setName:		(NSString *)	theName
atOffset:		(unsigned)	offset

Set the name of the channel at offset.

Parameters:

	theName	The name of the channel at the given offset
	offset	The offset from the base address (zero indexed)

- (void) setStartChannel:

(unsigned)

theStartChannel

Set the start channel, this is the channle number from the channel manager.

See also:

startChannel:

- (unsigned) startChannel

Set the start channel.

This is the channel numbering as provided by the channel manager and is used during fixture patching.

Returns:

Channel number or 0 if not set.

See also:

- setStartChannel:

- (NSXMLElement *) XML

Get the base address as an XML Element.

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

---

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

• LOFixtureBaseAddress.h
• LOFixtureBaseAddress.m