Class ReferenceProductSourceImpl

Class ReferenceProductSourceImpl.

Inheritance

Object

ReferenceProductSourceImpl

Namespace: Unity.Industrial.Forma.Core.AddressableSources

Syntax

public class ReferenceProductSourceImpl : object, IProductSource

Constructors

ReferenceProductSourceImpl(MonoBehaviour)

Initializes a new instance of the ReferenceProductSourceImpl class.

Declaration

public ReferenceProductSourceImpl(MonoBehaviour controller)

Parameters

Type	Name	Description
MonoBehaviour	controller	The controller.

Properties

IsFormaManaged

Check if the product source is managed by Forma code.

Declaration

public bool IsFormaManaged { get; set; }

Property Value

Type	Description
Boolean	true if this instance is loading; otherwise, false.

Implements

IProductSource.IsFormaManaged

IsLoaded

Gets or sets a value indicating whether this instance is loaded.

Declaration

public virtual bool IsLoaded { get; set; }

Property Value

Type	Description
Boolean	true if this instance is loaded; otherwise, false.

Implements

IProductSource.IsLoaded

IsLoading

Gets or sets a value indicating whether this instance is loading.

Declaration

public virtual bool IsLoading { get; set; }

Property Value

Type	Description
Boolean	true if this instance is loading; otherwise, false.

Implements

IProductSource.IsLoading

Products

Gets or sets the products.

Declaration

public List<AssetProductReference> Products { get; set; }

Property Value

Type	Description
List<AssetProductReference>	The products.

Implements

IProductSource.Products

Methods

AddProductReference(List<AssetProductReference>)

Adds the product reference.

Declaration

public void AddProductReference(List<AssetProductReference> products)

Parameters

Type	Name	Description
List<AssetProductReference>	products	The products.

AddProductReference(AssetProductReference, Boolean)

Adds the product reference.

Declaration

public void AddProductReference(AssetProductReference product, bool sendEvent = true)

Parameters

Type	Name	Description
AssetProductReference	product	The product.
Boolean	sendEvent	if set to true [send event].

ClearListeners()

Clears the listeners.

Declaration

public void ClearListeners()

Load()

Loads this instance.

Declaration

public virtual IEnumerator Load()

Returns

Type	Description
IEnumerator	IEnumerator.

Implements

IProductSource.Load()

RemoveAllProducts()

Removes all products.

Declaration

public void RemoveAllProducts()

RemoveProduct(List<AssetProductReference>)

Removes the product.

Declaration

public void RemoveProduct(List<AssetProductReference> products)

Parameters

Type	Name	Description
List<AssetProductReference>	products	The products.

RemoveProduct(String, Boolean)

Removes the product.

Declaration

public void RemoveProduct(string key, bool sendEvent = true)

Parameters

Type	Name	Description
String	key	The key.
Boolean	sendEvent	if set to true [send event].

Implements

IProductSource.RemoveProduct(String, Boolean)

Unload()

Unloads this instance.

Declaration

public virtual IEnumerator Unload()

Returns

Type	Description
IEnumerator	IEnumerator.

Implements

IProductSource.Unload()

Events

onProductAdded

Occurs when [on product added].

Declaration

public event ProductSource.ProductReferenceEvent onProductAdded

Event Type

Type	Description
ProductSource.ProductReferenceEvent

Implements

IProductSource.onProductAdded

onProductRemoved

Occurs when [on product removed].

Declaration

public event ProductSource.ProductGuidEvent onProductRemoved

Event Type

Type	Description
ProductSource.ProductGuidEvent

Implements

IProductSource.onProductRemoved