Struct ParameterId
Represents a Cam parameter identifier.
Implements
System.IEquatable<ParameterId>
Inherited Members
System.ValueType.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
Namespace: TopSolid.Cam.NC.Kernel.Automating
Assembly: TopSolid.Cam.NC.Kernel.Automating.dll
Syntax
public struct ParameterId : IEquatable<ParameterId>Constructors
ParameterId(ElementExId, String)
Initializes a new instance of the ParameterId structure.
Declaration
public ParameterId(ElementExId inElementId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| ElementExId | inElementId | Element owner of the parameter. |
| System.String | inName | Full name of the parameter, including operation type. |
Fields
Empty
Empty identifier.
Declaration
public static readonly ParameterId EmptyField Value
| Type | Description |
|---|---|
| ParameterId |
Properties
ElementId
Gets the identifier of the owner element. Id is empty in this ElementId is not empty.
Declaration
public readonly ElementExId ElementId { get; }Property Value
| Type | Description |
|---|---|
| ElementExId |
IsEmpty
Tells whether the parameter identifier is empty.
Declaration
public readonly bool IsEmpty { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Name
Gets the name of the parameter.
Declaration
public readonly string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Equals(Object)
Implements System.IEquatable<T>.Equals(T).
Declaration
public override bool Equals(object inObject)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | inObject |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.ValueType.Equals(System.Object)
Equals(ParameterId)
Implements System.Object.Equals(System.Object).
Declaration
public bool Equals(ParameterId other)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | other |
Returns
| Type | Description |
|---|---|
| System.Boolean |
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.ValueType.GetHashCode()
Operators
Equality(ParameterId, ParameterId)
Tells whether two parameter identifiers are equal.
Declaration
public static bool operator ==(ParameterId inParameterId1, ParameterId inParameterId2)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId1 | First parameter identifier. |
| ParameterId | inParameterId2 | Second parameter identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Parameter identifiers are equal. |
Inequality(ParameterId, ParameterId)
Tells whether two parameter identifiers are different.
Declaration
public static bool operator !=(ParameterId inParameterId1, ParameterId inParameterId2)Parameters
| Type | Name | Description |
|---|---|---|
| ParameterId | inParameterId1 | First parameter identifier. |
| ParameterId | inParameterId2 | Second parameter identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Parameter identifiers are different. |
Implements
System.IEquatable<T>