Package nl.basjes.sunspec.model.entities
Class Point
-
- All Implemented Interfaces:
@Serializable() public final class Point
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumPoint.Accesspublic enumPoint.Mandatorypublic enumPoint.Mutablepublic enumPoint.Type
-
Field Summary
Fields Modifier and Type Field Description private final transient BooleanisModelHeaderprivate final IntegeroffsetInGroupprivate final Stringnameprivate Point.Typetypeprivate final Integervalueprivate final Integercountprivate final Integersizeprivate final StringscalingFactorprivate Stringunitsprivate final Point.Accessaccessprivate final Point.Mandatorymandatoryprivate final Point.Mutablemutableprivate Stringlabelprivate Stringdescriptionprivate final Stringdetailprivate final Stringnotesprivate final List<String>commentsprivate final List<Symbol>symbolsprivate final List<String>standards
-
Constructor Summary
Constructors Constructor Description Point(String name, Point.Type type, Integer value, Integer count, Integer size, String scalingFactor, String units, Point.Access access, Point.Mandatory mandatory, Point.Mutable mutable, String label, String description, String detail, String notes, List<String> comments, List<Symbol> symbols, List<String> standards)
-
Method Summary
Modifier and Type Method Description final BooleanisModelHeader()The SunSpec model has a problem that it treats the 2 registers that define the content (ID and L) as part of the structure instead of outside of it. final IntegergetOffsetInGroup()final StringgetName()final Point.TypegetType()final UnitsetType(@Required() @SerialName(value = "type") Point.Type type)final IntegergetValue()final IntegergetCount()final IntegergetSize()final StringgetScalingFactor()The NAME of the scaling factor point OR a -10;10 integer OR null final StringgetUnits()final UnitsetUnits(@SerialName(value = "units") String units)final Point.AccessgetAccess()final Point.MandatorygetMandatory()final Point.MutablegetMutable()Renamed statictomutablebecause 'static' is a reserved keyword in many languages and is confusing.final StringgetLabel()final UnitsetLabel(@SerialName(value = "label") String label)final StringgetDescription()final UnitsetDescription(@SerialName(value = "desc") String description)final StringgetDetail()final StringgetNotes()final List<String>getComments()final List<Symbol>getSymbols()final List<String>getStandards()final BooleanisImmutable()final BooleanisStatic()StringtoString()-
-
Constructor Detail
-
Point
Point(String name, Point.Type type, Integer value, Integer count, Integer size, String scalingFactor, String units, Point.Access access, Point.Mandatory mandatory, Point.Mutable mutable, String label, String description, String detail, String notes, List<String> comments, List<Symbol> symbols, List<String> standards)
-
-
Method Detail
-
isModelHeader
final Boolean isModelHeader()
The SunSpec model has a problem that it treats the 2 registers that define the content (ID and L) as part of the structure instead of outside of it. This flag is set to true on these 2 points.
-
getOffsetInGroup
final Integer getOffsetInGroup()
-
getType
final Point.Type getType()
-
setType
final Unit setType(@Required() @SerialName(value = "type") Point.Type type)
-
getScalingFactor
final String getScalingFactor()
The NAME of the scaling factor point OR a -10;10 integer OR null
-
getAccess
final Point.Access getAccess()
-
getMandatory
final Point.Mandatory getMandatory()
-
getMutable
final Point.Mutable getMutable()
Renamed
statictomutablebecause 'static' is a reserved keyword in many languages and is confusing.
-
getDescription
final String getDescription()
-
setDescription
final Unit setDescription(@SerialName(value = "desc") String description)
-
getComments
final List<String> getComments()
-
getSymbols
final List<Symbol> getSymbols()
-
getStandards
final List<String> getStandards()
-
isImmutable
final Boolean isImmutable()
-
-
-
-