Initializing help system before first use

XPRMList

  • All Implemented Interfaces:
    XPRMTyped


    public class XPRMList
    extends XPRMValue
    A list in Mosel.
    • Method Detail

      • asList

        public final XPRMList asList()
        Description copied from class: XPRMValue
        A list. This function is defined if the actual object is a list.
        Overrides:
        asList in class  XPRMValue
        Returns:
        The list as a XPRMList
      • isInitialised

        public final boolean isInitialised()
        Check whether the list has been initialised. Objects are initialised during model execution. Trying to access a Mosel object that has not been created will result on an exception.
        Returns:
        true if the list has been created
      • isDynamic

        public final boolean isDynamic()
        Check whether the list is dynamic.
        Returns:
        true if the list is dynamic
      • getSize

        public final int getSize()
        Get list size.
        Returns:
        Number of elements in the list
      • isEmpty

        public final boolean isEmpty()
        Check whether the list is empty.
        Returns:
        true if the list contains no element
      • elements

        public XPRMListElements elements()
        Get an iterator to enumerate all elements of the list.
        Returns:
        A list element iterator
      • getTypeCode

        public final int getTypeCode()
        Description copied from interface: XPRMTyped
        Type code. The code is one of the TYP_* values.
        Returns:
        Encoded type
      • getTypeName

        public final java.lang.String getTypeName()
        Description copied from interface: XPRMTyped
        String representation of type.
        Returns:
        Type name
      • getStructCode

        public final int getStructCode()
        Description copied from interface: XPRMTyped
        Structure code. The code is one of the STR_* values.
        Returns:
        Encoded structure
      • getStructName

        public final java.lang.String getStructName()
        Description copied from interface: XPRMTyped
        String representation of structure.
        Returns:
        Structure name
      • toString

        public final java.lang.String toString()
        Generate a string representation of the content of the list.
        Overrides:
        toString in class  java.lang.Object
        Returns:
        String describing the list content