Class PinCollection
Inheritance
PinCollection
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public abstract class PinCollection : CorePropertyChanged, IPinCollection, IEnumerable<IPin>, IEnumerable
Constructors
PinCollection(INode, string)
Creates a new instance of the PinCollection class
Declaration
protected PinCollection(INode node, string name)
Parameters
Type | Name | Description |
---|---|---|
INode | node | The node the pin collection belongs to |
string | name | The name of the pin collection |
Properties
Direction
Gets the direction of the pin collection and all its pins
Declaration
public abstract PinDirection Direction { get; }
Property Value
Type | Description |
---|---|
PinDirection |
Name
Gets the name of the pin collection
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
string |
Node
Gets the node the pin collection belongs to
Declaration
public INode Node { get; }
Property Value
Type | Description |
---|---|
INode |
Pins
Gets a read only observable collection of the pins
Declaration
public ReadOnlyCollection<IPin> Pins { get; }
Property Value
Type | Description |
---|---|
ReadOnlyCollection<IPin> |
Type
Gets the type of values the pin collection and all its pins holds
Declaration
public abstract Type Type { get; }
Property Value
Type | Description |
---|---|
Type |
Methods
Add(IPin)
Adds the provided pin
to the collection
Declaration
public void Add(IPin pin)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin |
CreatePin()
Creates a new pin compatible with this collection
Declaration
public abstract IPin CreatePin()
Returns
Type | Description |
---|---|
IPin | The newly created pin |
GetEnumerator()
Declaration
public IEnumerator<IPin> GetEnumerator()
Returns
Type | Description |
---|---|
IEnumerator<IPin> |
Remove(IPin)
Removes the provided pin
from the collection
Declaration
public bool Remove(IPin pin)
Parameters
Type | Name | Description |
---|---|---|
IPin | pin | The pin to remove |
Returns
Type | Description |
---|---|
bool |
Reset()
Resets the pin collection, causing its pins to re-evaluate the next time its value is requested
Declaration
public void Reset()
Events
PinAdded
Occurs when a pin was added to the collection
Declaration
public event EventHandler<SingleValueEventArgs<IPin>>? PinAdded
Event Type
Type | Description |
---|---|
EventHandler<SingleValueEventArgs<IPin>> |
PinRemoved
Occurs when a pin was removed from the collection
Declaration
public event EventHandler<SingleValueEventArgs<IPin>>? PinRemoved
Event Type
Type | Description |
---|---|
EventHandler<SingleValueEventArgs<IPin>> |