genopt.lang

Class ObjectiveFunctionLocation

java.lang.Object

genopt.lang.ObjectiveFunctionLocation

public class ObjectiveFunctionLocation
extends java.lang.Object

Object representing the objective function location.

This project was carried out at:

• Lawrence Berkeley National Laboratory (LBNL), Simulation Research Group,

and supported by

• the U.S. Department of Energy (DOE),
• the Swiss Academy of Engineering Sciences (SATW),
• the Swiss National Energy Fund (NEFF), and
• the Swiss National Science Foundation (SNSF)

GenOpt Copyright (c) 1998-2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

Version:

GenOpt(R) 3.1.1 (March 24, 2016)

Author:

Michael Wetter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	Delimiter The delimiter of the objective function, or null
protected int	firstCharAt One-based index for the position where the first character of the delimiter starts, or 0 if unspecified
protected java.lang.String	Function The function defining the objective function, or null
protected boolean	IsFunction Flag whether this instance is a function or not
private static java.lang.String	LS Line separator
protected java.lang.String	Name The name of the objective function

Constructor Summary

Constructors

Constructor and Description
ObjectiveFunctionLocation(java.lang.String name, java.lang.String delimiter, int firstCharacterAt, java.lang.String function) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDelimiter()
int	getFirstCharAt()
java.lang.String	getFunction()
java.lang.String	getName()
boolean	isFunction()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LS

private static final java.lang.String LS

Line separator

Name

protected java.lang.String Name

The name of the objective function

Delimiter

protected java.lang.String Delimiter

The delimiter of the objective function, or null

Function

protected java.lang.String Function

The function defining the objective function, or null

firstCharAt

protected int firstCharAt

One-based index for the position where the first character of the delimiter starts, or 0 if unspecified

IsFunction

protected boolean IsFunction

Flag whether this instance is a function or not

Constructor Detail

ObjectiveFunctionLocation

public ObjectiveFunctionLocation(java.lang.String name,
                                 java.lang.String delimiter,
                                 int firstCharacterAt,
                                 java.lang.String function)

Constructor. Either delimiter or function must be null, but not both.

Parameters:

name - name of the function

delimiter - objective function delimiter, or null pointer

firstCharacterAt - one-based index for the position where the first character of the delimiter starts, or 0 if unspecified

function - string representation of the function, or null pointer

Method Detail

isFunction

public boolean isFunction()

getName

public java.lang.String getName()

getDelimiter

public java.lang.String getDelimiter()

getFunction

public java.lang.String getFunction()

getFirstCharAt

public int getFirstCharAt()