Function Reference

getValue(jams.data.JAMSData)
public static java.lang.Object getValue(jams.data.JAMSData a)


Returns the value of a JAMSData Attribute
Parameters:
a - a variable of JAMSData
Returns:
the value of variable a
toCalendar(java.lang.String)
public static jams.data.Attribute.Calendar toCalendar(java.lang.String in)


returns the calendar object of a string representation
Parameters:
a - a string formatted in yyyy-mm-dd
Returns:
the calendar object
toTimeInterval(java.lang.String)
public static jams.data.Attribute.TimeInterval toTimeInterval(java.lang.String in)


returns the time interval object of a string representation
Parameters:
a - a string formatted in yyyy-mm-dd - yyyy-mm-dd T C, where T is the time periode unit (day=6, month=2, year=1) and C is the time periode unit count
Returns:
the time interval object
start(jams.data.Attribute.TimeInterval)
public static jams.data.Attribute.Calendar start(jams.data.Attribute.TimeInterval in)


returns the start date of a TimeInterval Object
Parameters:
a - a TimeInterval object
Returns:
the start date of that TimeInterval
end(jams.data.Attribute.TimeInterval)
public static jams.data.Attribute.Calendar end(jams.data.Attribute.TimeInterval in)


returns the end date of a TimeInterval Object
Parameters:
a - a TimeInterval object
Returns:
the end date of that TimeInterval
day(jams.data.Attribute.Calendar)
public static int day(jams.data.Attribute.Calendar c)


returns the dayOfMonth from a Calendar Object
Parameters:
a - a Calendar object
Returns:
the dayOfMonth property
month(jams.data.Attribute.Calendar)
public static int month(jams.data.Attribute.Calendar c)


returns the monthOfYear from a Calendar Object
Parameters:
a - a Calendar object
Returns:
the monthOfYear property
year(jams.data.Attribute.Calendar)
public static int year(jams.data.Attribute.Calendar c)


returns the year from a Calendar Object
Parameters:
a - a Calendar object
Returns:
the year property
lastDayInMonth(jams.data.Attribute.Calendar)
public static int lastDayInMonth(jams.data.Attribute.Calendar c)


returns the maximum day of the month
Parameters:
a - a Calendar object
Returns:
the maximum day of the month
isLastDayInMonth(jams.data.Attribute.Calendar)
public static int isLastDayInMonth(jams.data.Attribute.Calendar c)


returns if the day is the last of the current month
Parameters:
a - a Calendar object
Returns:
true if the day is the last of the current month
getAttribute(jams.model.Context, java.lang.String)
public static java.lang.Object getAttribute(jams.model.Context context, java.lang.String name)


returns the attribute with "name" from "context"
Parameters:
context - the name of a model context
name - the name of a attribute in context
Returns:
the value of that attribute
dateCompare(jams.data.Attribute.Calendar, jams.data.Attribute.Calendar, int)
public static int dateCompare(jams.data.Attribute.Calendar c1, jams.data.Attribute.Calendar c2, int accuracy)


compares two calendar objects
Parameters:
c1 - calendar 1
c2 - calendar 2
Returns:
-1 if c1 is before c2, 1 if c1 is after c2 and 0 otherwise

Examples

Example 1
Objective
Writing attributes only for settlement hrus (id=1 or id=2)
Solution
getAttribute(HRULoop,"landuse")==1 || getAttribute(HRULoop,"landuse")==2
Example 2
Objective
Writing attributes only at the first day of every month
Solution
day(getAttribute(TimeLoop,"time")==1)
Example 3
Objective
Writing attributes only at the last day of every month
Solution
isLastDayInMonthay(getAttribute(TimeLoop,"time"))