org.rvpf.pap.dnp3.object

Interface ObjectInstance

All Known Subinterfaces:

ObjectInstance.Packed, ObjectInstance.WithFlags, ObjectInstance.WithStatus, ObjectInstance.WithTime, ObjectInstance.WithValue

All Known Implementing Classes:

G10V0, G10V1, G10V2, G11V0, G11V1, G11V2, G1V0, G1V1, G1V2, G20V0, G20V1, G20V2, G20V5, G20V6, G21V0, G21V1, G21V10, G21V2, G21V5, G21V6, G21V9, G22V0, G22V1, G22V2, G22V5, G22V6, G23V0, G23V1, G23V2, G23V5, G23V6, G2V0, G2V1, G2V2, G2V3, G30V0, G30V1, G30V2, G30V3, G30V4, G30V5, G30V6, G31V0, G31V1, G31V2, G31V3, G31V4, G31V5, G31V6, G31V7, G31V8, G32V0, G32V1, G32V2, G32V3, G32V4, G32V5, G32V6, G32V7, G32V8, G33V0, G33V1, G33V2, G33V3, G33V4, G33V5, G33V6, G33V7, G33V8, G34V0, G34V1, G34V2, G34V3, G3V0, G3V1, G3V2, G40V0, G40V1, G40V2, G40V3, G40V4, G41V0, G41V1, G41V2, G41V3, G41V4, G42V0, G42V1, G42V2, G42V3, G42V4, G42V5, G42V6, G42V7, G42V8, G43V0, G43V1, G43V2, G43V3, G43V4, G43V5, G43V6, G43V7, G43V8, G4V0, G4V1, G4V2, G4V3, G50V0, G50V1, G50V2, G50V3, G50V4, G51V0, G51V1, G51V2, G52V0, G52V1, G52V2, G60V0, G60V1, G60V2, G60V3, G60V4, G80V0, G80V1, ObjectInstance.Abstract

public interface ObjectInstance

Object instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectInstance.Abstract Abstract object instance.
static interface	ObjectInstance.Packed Object instance packed.
static interface	ObjectInstance.WithFlags Object instance with flags.
static interface	ObjectInstance.WithStatus Object instance with status.
static interface	ObjectInstance.WithTime Object instance with time.
static interface	ObjectInstance.WithValue Object instance with value.

Method Summary

Modifier and Type	Method and Description
void	dumpToBuffer(ByteBuffer buffer) Dumps itself into a buffer.
GroupCategory	getGroupCategory() Gets the group category.
int	getGroupCode() Gets the group code.
String	getGroupName() Gets the group name.
String	getGroupTitle() Gets the group title.
ObjectGroup	getObjectGroup() Gets the object group.
int	getObjectIndex() Gets the object index.
int	getObjectLength() Gets the object length in bytes.
ObjectVariation	getObjectVariation() Gets the object variation.
Optional<PointType>	getPointType() Gets the point type.
int	getValueCount() Gets the number of values represented.
int	getVariationCode() Gets the variation code.
String	getVariationName() Gets the variation name.
String	getVariationTitle() Gets the variation title.
void	loadFromBuffer(ByteBuffer buffer) Loads values from a buffer.
void	setObjectIndex(int index) Sets the object index.
void	setUp(int objectIndex, int indexLimit) Sets up this
void	setValueCount(int count) Sets the number of values represented.

Method Detail

dumpToBuffer

void dumpToBuffer(@Nonnull
                  ByteBuffer buffer)

Dumps itself into a buffer.

Parameters:

buffer - The buffer.

getGroupCategory

@Nonnull
 @CheckReturnValue
GroupCategory getGroupCategory()

Gets the group category.

Returns:

The group category.

getGroupCode

@CheckReturnValue
int getGroupCode()

Gets the group code.

Returns:

The group code.

getGroupName

@Nonnull
 @CheckReturnValue
String getGroupName()

Gets the group name.

Returns:

The group name.

getGroupTitle

@Nonnull
 @CheckReturnValue
String getGroupTitle()

Gets the group title.

Returns:

The group title.

getObjectGroup

@Nonnull
 @CheckReturnValue
ObjectGroup getObjectGroup()

Gets the object group.

Returns:

The object group.

getObjectIndex

@CheckReturnValue
int getObjectIndex()

Gets the object index.

Returns:

The object index.

getObjectLength

@CheckReturnValue
int getObjectLength()

Gets the object length in bytes.

Returns:

The object length in bytes.

getObjectVariation

@Nonnull
 @CheckReturnValue
ObjectVariation getObjectVariation()

Gets the object variation.

Returns:

The object variation.

getPointType

@Nonnull
 @CheckReturnValue
Optional<PointType> getPointType()

Gets the point type.

Returns:

The optional point type.

getValueCount

@CheckReturnValue
int getValueCount()

Gets the number of values represented.

Returns:

The number of values represented.

getVariationCode

@CheckReturnValue
int getVariationCode()

Gets the variation code.

Returns:

The variation code.

getVariationName

@Nonnull
 @CheckReturnValue
String getVariationName()

Gets the variation name.

Returns:

The variation name.

getVariationTitle

@Nonnull
 @CheckReturnValue
String getVariationTitle()

Gets the variation title.

Returns:

The variation title.

loadFromBuffer

void loadFromBuffer(@Nonnull
                    ByteBuffer buffer)

Loads values from a buffer.

Parameters:

buffer - The buffer.

setObjectIndex

void setObjectIndex(int index)

Sets the object index.

Parameters:

index - The object index.

setUp

void setUp(int objectIndex,
           int indexLimit)

Sets up this

Parameters:

objectIndex - The object index (or address).

indexLimit - The index limit.

setValueCount

void setValueCount(int count)

Sets the number of values represented.

Parameters:

count - The number of values represented.