ZOS-API interface 2025 R2

ZOSAPI.Tools.Sequences.SequenceElement Class Reference

Last update: 16.07.2025

A single element of a sequence, consisting of the object and face numbers with optional diffraction orders. More...

Public Member Functions

 SequenceElement (int objectNumber, int faceNumber, int? diffractionOrderX=null, int? diffractionOrderY=null)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
override string ToString ()
 

Properties

int ObjectNumber [get]
 
int FaceNumber [get]
 
int? DiffractionOrderX [get]
 
int? DiffractionOrderY [get]
 
bool HasDiffraction [get]
 

Detailed Description

A single element of a sequence, consisting of the object and face numbers with optional diffraction orders.

Constructor & Destructor Documentation

◆ SequenceElement()

ZOSAPI.Tools.Sequences.SequenceElement.SequenceElement ( int  objectNumber,
int  faceNumber,
int?  diffractionOrderX = null,
int?  diffractionOrderY = null 
)
inline

Member Function Documentation

◆ Equals()

override bool ZOSAPI.Tools.Sequences.SequenceElement.Equals ( object  obj)
inline

◆ GetHashCode()

override int ZOSAPI.Tools.Sequences.SequenceElement.GetHashCode ( )
inline

◆ ToString()

override string ZOSAPI.Tools.Sequences.SequenceElement.ToString ( )
inline

Property Documentation

◆ DiffractionOrderX

int? ZOSAPI.Tools.Sequences.SequenceElement.DiffractionOrderX
get

◆ DiffractionOrderY

int? ZOSAPI.Tools.Sequences.SequenceElement.DiffractionOrderY
get

◆ FaceNumber

int ZOSAPI.Tools.Sequences.SequenceElement.FaceNumber
get

◆ HasDiffraction

bool ZOSAPI.Tools.Sequences.SequenceElement.HasDiffraction
get

◆ ObjectNumber

int ZOSAPI.Tools.Sequences.SequenceElement.ObjectNumber
get

Connect with Ansys