AbstractList

Short summary

An abstract class to implement methods which are not dependent on the data structure.

Access	Abstract	Final	Extends	Implements
	Yes	No	AbstractCollection	CNM_CollectionInterfaces.IList, IListHelpers

UML Diagram

Properties

className

Type: CNM_AbstractObject.ClassName

This abstract property returns the class name of the concrete object, …

listChangeIndex

Type: __XWORD

…

sort

Type: CNM_CollectionInterfaces.ISortable

This property returns strategies to sort the list in a desired order.…

Methods

Abstract methods

append

• Parameters:
  • object (CNM_AbstractObject.IObject): The object to be appended
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method adds the given CNM_AbstractObject.IObject to the end of the list.…

appendCollection

• Parameters:
  • collectionToAppend (CNM_CollectionInterfaces.ICollection): The collection to be appended
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method adds all elements of the given collection to the end of this list.…

dequeue

• Return type: CNM_AbstractObject.IObject

This property returns the last object in the first and removes it from the list. Can be seen as opposite of prepend.…

instantSorting

• Parameters:
  • order (SortingOrder)
  • comparator (CNM_CollectionInterfaces.CNM_AbstractObject.IComparator): Optional: the comparator that should be used for the sort. Must not be changed while sort is in process
• Return type: CNM_ReturnTypes.SingleExecutionResult

…

invert

• Return type: VOID

Inverts the order of the elements inside the object. Does not apply any kind of sorting, only reverses.…

pop

• Return type: CNM_AbstractObject.IObject

This property returns the last object in the list and removes it from the list. Can be seen as opposite of append.…

prepend

• Parameters:
  • object (CNM_AbstractObject.IObject): The object to be prepended
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method adds the given obejct to the end of the list.…

prependCollection

• Parameters:
  • collectionToPrepend (CNM_CollectionInterfaces.ICollection): The collection to be prepended
• Return type: CNM_ReturnTypes.SingleExecutionResult

This method adds all elements of the given collection to the start of this list. …

remove

• Parameters:
  • object (CNM_AbstractObject.IObject): The object to be removed from the list
• Return type: VOID

This method removes the first instance of the given object from the list.…

sorting

• Parameters:
  • execute (BOOL)
  • order (SortingOrder)
  • comparator (CNM_CollectionInterfaces.CNM_AbstractObject.IComparator): Optional: the comparator that should be used for the sort. Must not be changed while sort is in process
• Return type: CNM_ReturnTypes.SingleExecutionState

…

Code

Declaration

FUNCTION_BLOCK ABSTRACT AbstractList EXTENDS AbstractCollection IMPLEMENTS CNM_CollectionInterfaces.IList, IListHelpers