C# Class CUE.NET.Groups.ListLedGroup

Represents a ledgroup containing arbitrary LEDs.
Inheritance: AbstractLedGroup
Show file Open project: DarthAffe/CUE.NET Class Usage Examples

Public Methods

Method Description
AddLed ( ) : void

Adds the given LED(s) to the ledgroup.

AddLeds ( IEnumerable leds ) : void

Adds the given LEDs to the ledgroup.

AddLeds ( IEnumerable ledIds ) : void

Adds the given LEDs to the ledgroup.

ContainsLed ( CorsairLed led ) : bool

Checks if a given LED is contained by this ledgroup.

ContainsLed ( CorsairLedId ledId ) : bool

Checks if a given LED is contained by this ledgroup.

GetLeds ( ) : IEnumerable

Gets a list containing the LEDs from this group.

ListLedGroup ( ICueDevice device ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

ListLedGroup ( ICueDevice device, IEnumerable leds ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

ListLedGroup ( ICueDevice device, IEnumerable leds ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

ListLedGroup ( ICueDevice device, bool autoAttach = true ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

ListLedGroup ( ICueDevice device, bool autoAttach, IEnumerable leds ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

ListLedGroup ( ICueDevice device, bool autoAttach, IEnumerable leds ) : System.Collections.Generic

Initializes a new instance of the ListLedGroup class.

MergeLeds ( ILedGroup groupToMerge ) : void

Merges the LEDs from the given ledgroup in this ledgroup.

RemoveLed ( ) : void

Removes the given LED(s) from the ledgroup.

RemoveLeds ( IEnumerable leds ) : void

Removes the given LEDs from the ledgroup.

RemoveLeds ( IEnumerable ledIds ) : void

Removes the given LEDs from the ledgroup.

Method Details

AddLed() public method

Adds the given LED(s) to the ledgroup.
public AddLed ( ) : void
return void

AddLeds() public method

Adds the given LEDs to the ledgroup.
public AddLeds ( IEnumerable leds ) : void
leds IEnumerable The LEDs to add.
return void

AddLeds() public method

Adds the given LEDs to the ledgroup.
public AddLeds ( IEnumerable ledIds ) : void
ledIds IEnumerable The IDs of the LEDs to add.
return void

ContainsLed() public method

Checks if a given LED is contained by this ledgroup.
public ContainsLed ( CorsairLed led ) : bool
led CUE.NET.Devices.Generic.CorsairLed The LED which should be checked.
return bool

ContainsLed() public method

Checks if a given LED is contained by this ledgroup.
public ContainsLed ( CorsairLedId ledId ) : bool
ledId CorsairLedId The ID of the LED which should be checked.
return bool

GetLeds() public method

Gets a list containing the LEDs from this group.
public GetLeds ( ) : IEnumerable
return IEnumerable

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
return System.Collections.Generic

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device, IEnumerable leds ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
leds IEnumerable The initial LEDs of this ledgroup.
return System.Collections.Generic

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device, IEnumerable leds ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
leds IEnumerable The IDs of the initial LEDs of this ledgroup.
return System.Collections.Generic

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device, bool autoAttach = true ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
autoAttach bool Specifies whether this ledgroup should be automatically attached or not.
return System.Collections.Generic

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device, bool autoAttach, IEnumerable leds ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
autoAttach bool Specifies whether this ledgroup should be automatically attached or not.
leds IEnumerable The initial LEDs of this ledgroup.
return System.Collections.Generic

ListLedGroup() public method

Initializes a new instance of the ListLedGroup class.
public ListLedGroup ( ICueDevice device, bool autoAttach, IEnumerable leds ) : System.Collections.Generic
device ICueDevice The device this ledgroup belongs to.
autoAttach bool Specifies whether this ledgroup should be automatically attached or not.
leds IEnumerable The IDs of the initial LEDs of this ledgroup.
return System.Collections.Generic

MergeLeds() public method

Merges the LEDs from the given ledgroup in this ledgroup.
public MergeLeds ( ILedGroup groupToMerge ) : void
groupToMerge ILedGroup The ledgroup to merge.
return void

RemoveLed() public method

Removes the given LED(s) from the ledgroup.
public RemoveLed ( ) : void
return void

RemoveLeds() public method

Removes the given LEDs from the ledgroup.
public RemoveLeds ( IEnumerable leds ) : void
leds IEnumerable The LEDs to remove.
return void

RemoveLeds() public method

Removes the given LEDs from the ledgroup.
public RemoveLeds ( IEnumerable ledIds ) : void
ledIds IEnumerable The IDs of the LEDs to remove.
return void