View Javadoc
1   package org.metricshub.ipmi.core.coding.commands.sel;
2   
3   /*-
4    * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
5    * IPMI Java Client
6    * ჻჻჻჻჻჻
7    * Copyright 2023 MetricsHub
8    * ჻჻჻჻჻჻
9    * This program is free software: you can redistribute it and/or modify
10   * it under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation, either version 3 of the
12   * License, or (at your option) any later version.
13   *
14   * This program is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Lesser Public License for more details.
18   *
19   * You should have received a copy of the GNU General Lesser Public
20   * License along with this program.  If not, see
21   * <http://www.gnu.org/licenses/lgpl-3.0.html>.
22   * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
23   */
24  
25  import org.metricshub.ipmi.core.coding.commands.ResponseData;
26  
27  /**
28   * Wrapper for the Get SEL Time UTC Offset response.
29   */
30  public class GetSelTimeUtcOffsetResponseData implements ResponseData {
31  
32  	/** 07FFh: the offset is unspecified (IPMI 2.0 revision 1.1 section 31.11a), as after a Set SEL Time. */
33  	public static final int UNSPECIFIED = 0x07ff;
34  
35  	private int offsetMinutes;
36  
37  	/**
38  	 * @return the offset from UTC of the SEL time, in minutes (-1440 to 1440): local time = UTC + offset; or
39  	 *         {@link #UNSPECIFIED}
40  	 */
41  	public int getOffsetMinutes() {
42  		return offsetMinutes;
43  	}
44  
45  	/**
46  	 * @return whether the BMC leaves the offset unspecified (07FFh): the SEL time is then as good as UTC
47  	 */
48  	public boolean isUnspecified() {
49  		return offsetMinutes == UNSPECIFIED;
50  	}
51  
52  	/**
53  	 * @param offsetMinutes the offset from UTC of the SEL time, in minutes
54  	 */
55  	public void setOffsetMinutes(int offsetMinutes) {
56  		this.offsetMinutes = offsetMinutes;
57  	}
58  }