me.legrange.panstamp.definition

Interface EndpointDefinition

public interface EndpointDefinition

Definition of an endpoint as defined by XML.

Since:

1.0

Author:

Gideon le Grange https://github.com/GideonLeGrange *

Method Summary

Modifier and Type	Method and Description
Direction	getDirection() Get the direction of data flow for this endpoint.
String	getName() Get the name of the endpoint.
Position	getPosition() Get the position of the endpoint data within the register.
RegisterDefinition	getRegister() Get the register definition to which this endpoint definition applies.
Size	getSize() Get the size of the endpoint data within the register.
Type	getType() Get the data type for this endpoint.
List<Unit>	getUnits() Get the data units supported by the endpoint.

Method Detail

getRegister

RegisterDefinition getRegister()

Get the register definition to which this endpoint definition applies.

Returns:

The Register definition.

getName

String getName()

Get the name of the endpoint.

Returns:

The endpoint name.

getDirection

Direction getDirection()

Get the direction of data flow for this endpoint.

Returns:

The direction.

getType

Type getType()

Get the data type for this endpoint.

Returns:

The type.

getPosition

Position getPosition()

Get the position of the endpoint data within the register.

Returns:

The position object.

getSize

Size getSize()

Get the size of the endpoint data within the register.

Returns:

The size object.

getUnits

List<Unit> getUnits()

Get the data units supported by the endpoint.

Returns:

The list of units.