Initializing help system before first use

XPRMUnion

  • All Implemented Interfaces:
    XPRMTyped 

    public class XPRMUnion
extends XPRMValue
    A union object in Mosel.

    • Method Detail

      • asUnion

        public final XPRMUnion asUnion()
        Description copied from class: XPRMValue
        A union. This function is defined if the actual object is a union.
        Overrides:
        asUnion in class  XPRMValue
        Returns:
        The union as a XPRMUnion

      • isInitialised

        public final boolean isInitialised()
        Check whether the union 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 union has been created

      • isDefined

        public final boolean isDefined()
        Check whether the union is defined.
        Returns:
        true if the union is defined

      • types

        public XPRMUnionTypes types()
        Get an iterator to enumerate all compaible types of the union.
        Returns:
        A types iterator

      • getValue

        public XPRMValue getValue()
        Get the value stored in the union
        Returns:
        The value as an XPRMValue

      • getValueAsInteger

        public int getValueAsInteger()
        Get the value of the union as an integer
        Returns:
        The union value as an int

      • getValueAsReal

        public double getValueAsReal()
        Get the value of the union as a real
        Returns:
        The union value as a double

      • getValueAsString

        public java.lang.String getValueAsString()
        Get the value of the union as a string
        Returns:
        The union value as a String

      • getValueAsBoolean

        public boolean getValueAsBoolean()
        Get the value of the union as a boolean
        Returns:
        The union value as a boolean

      • 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 union.
        Overrides:
        toString in class  java.lang.Object
        Returns:
        String describing the union content
Parent Topic Class Summary

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.