Class LabelNameComponent

NameComponent that applies a label to the path.

Inheritance

object

NameComponent

LabelNameComponent

Inherited Members

NameComponent.prefix

NameComponent.suffix

NameComponent.Reset()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Simulation

Assembly: Unity.Simulation.Core.dll

Syntax

[Serializable]
public class LabelNameComponent : NameComponent

Constructors

LabelNameComponent()

Default Constructor.

Declaration

public LabelNameComponent()

LabelNameComponent(string)

Constructor for passing in just the label.

Declaration

public LabelNameComponent(string label)

Parameters

Type	Name	Description
string	label	The label to be applied to the path.

LabelNameComponent(string, string, string)

Constructor to pass in the affixes.

Declaration

public LabelNameComponent(string label, string prefix = "", string suffix = "")

Parameters

Type	Name	Description
string	label	The label to be applied to the path.
string	prefix	This will be prepended to the output from this NameComponent
string	suffix	This will be appended to the output from this NameComponent

Fields

label

Label to be applied.

Declaration

public string label

Field Value

Type	Description
string

Methods

Generate(string, bool)

Returns the label assigned to this NameComponent.

Declaration

public override string Generate(string path, bool modify = true)

Parameters

Type	Name	Description
string	path	Base path used to generate a new path.
bool	modify	If false, the NameComponent will not modify its state. This is equivalent to Reset() followed by Generate().

Returns

Type	Description
string	The path component generated by this NameComponent

Overrides

NameComponent.Generate(string, bool)