Documentation
¶
Index ¶
- func CIPEncapsulationPacketParse[T CIPEncapsulationPacket](ctx context.Context, theBytes []byte) (T, error)
- func CIPEncapsulationPacketParseWithBuffer[T CIPEncapsulationPacket](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func CIPEncapsulationPacketParseWithBufferProducer[T CIPEncapsulationPacket]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func DF1RequestCommandParse[T DF1RequestCommand](ctx context.Context, theBytes []byte) (T, error)
- func DF1RequestCommandParseWithBuffer[T DF1RequestCommand](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func DF1RequestCommandParseWithBufferProducer[T DF1RequestCommand]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func DF1RequestMessageParse[T DF1RequestMessage](ctx context.Context, theBytes []byte) (T, error)
- func DF1RequestMessageParseWithBuffer[T DF1RequestMessage](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func DF1RequestMessageParseWithBufferProducer[T DF1RequestMessage]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func DF1ResponseMessageParse[T DF1ResponseMessage](ctx context.Context, theBytes []byte, payloadLength uint16) (T, error)
- func DF1ResponseMessageParseWithBuffer[T DF1ResponseMessage](ctx context.Context, readBuffer utils.ReadBuffer, payloadLength uint16) (T, error)
- func DF1ResponseMessageParseWithBufferProducer[T DF1ResponseMessage](payloadLength uint16) func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
- func NewCIPEncapsulationConnectionRequest(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationConnectionRequest
- func NewCIPEncapsulationConnectionResponse(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationConnectionResponse
- func NewCIPEncapsulationPacket(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationPacket
- func NewCIPEncapsulationReadRequest(sessionHandle uint32, status uint32, senderContext []uint8, options uint32, ...) *_CIPEncapsulationReadRequest
- func NewCIPEncapsulationReadResponse(sessionHandle uint32, status uint32, senderContext []uint8, options uint32, ...) *_CIPEncapsulationReadResponse
- func NewDF1CommandRequestMessage(destinationAddress uint8, sourceAddress uint8, status uint8, ...) *_DF1CommandRequestMessage
- func NewDF1CommandResponseMessageProtectedTypedLogicalRead(destinationAddress uint8, sourceAddress uint8, status uint8, ...) *_DF1CommandResponseMessageProtectedTypedLogicalRead
- func NewDF1RequestCommand() *_DF1RequestCommand
- func NewDF1RequestMessage(destinationAddress uint8, sourceAddress uint8, status uint8, ...) *_DF1RequestMessage
- func NewDF1RequestProtectedTypedLogicalRead(byteSize uint8, fileNumber uint8, fileType uint8, elementNumber uint8, ...) *_DF1RequestProtectedTypedLogicalRead
- func NewDF1ResponseMessage(destinationAddress uint8, sourceAddress uint8, status uint8, ...) *_DF1ResponseMessage
- type CIPEncapsulationConnectionRequest
- type CIPEncapsulationConnectionRequestBuilder
- type CIPEncapsulationConnectionResponse
- type CIPEncapsulationConnectionResponseBuilder
- type CIPEncapsulationPacket
- type CIPEncapsulationPacketBuilder
- type CIPEncapsulationPacketContract
- type CIPEncapsulationPacketRequirements
- type CIPEncapsulationReadRequest
- type CIPEncapsulationReadRequestBuilder
- type CIPEncapsulationReadResponse
- type CIPEncapsulationReadResponseBuilder
- type DF1CommandRequestMessage
- type DF1CommandRequestMessageBuilder
- type DF1CommandResponseMessageProtectedTypedLogicalRead
- type DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
- type DF1RequestCommand
- type DF1RequestCommandBuilder
- type DF1RequestCommandContract
- type DF1RequestCommandRequirements
- type DF1RequestMessage
- type DF1RequestMessageBuilder
- type DF1RequestMessageContract
- type DF1RequestMessageRequirements
- type DF1RequestProtectedTypedLogicalRead
- type DF1RequestProtectedTypedLogicalReadBuilder
- type DF1ResponseMessage
- type DF1ResponseMessageBuilder
- type DF1ResponseMessageContract
- type DF1ResponseMessageRequirements
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CIPEncapsulationPacketParse ¶
func CIPEncapsulationPacketParse[T CIPEncapsulationPacket](ctx context.Context, theBytes []byte) (T, error)
func CIPEncapsulationPacketParseWithBuffer ¶
func CIPEncapsulationPacketParseWithBuffer[T CIPEncapsulationPacket](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func CIPEncapsulationPacketParseWithBufferProducer ¶
func CIPEncapsulationPacketParseWithBufferProducer[T CIPEncapsulationPacket]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func DF1RequestCommandParse ¶
func DF1RequestCommandParse[T DF1RequestCommand](ctx context.Context, theBytes []byte) (T, error)
func DF1RequestCommandParseWithBuffer ¶
func DF1RequestCommandParseWithBuffer[T DF1RequestCommand](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func DF1RequestCommandParseWithBufferProducer ¶
func DF1RequestCommandParseWithBufferProducer[T DF1RequestCommand]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func DF1RequestMessageParse ¶
func DF1RequestMessageParse[T DF1RequestMessage](ctx context.Context, theBytes []byte) (T, error)
func DF1RequestMessageParseWithBuffer ¶
func DF1RequestMessageParseWithBuffer[T DF1RequestMessage](ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func DF1RequestMessageParseWithBufferProducer ¶
func DF1RequestMessageParseWithBufferProducer[T DF1RequestMessage]() func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func DF1ResponseMessageParse ¶
func DF1ResponseMessageParseWithBuffer ¶
func DF1ResponseMessageParseWithBuffer[T DF1ResponseMessage](ctx context.Context, readBuffer utils.ReadBuffer, payloadLength uint16) (T, error)
func DF1ResponseMessageParseWithBufferProducer ¶
func DF1ResponseMessageParseWithBufferProducer[T DF1ResponseMessage](payloadLength uint16) func(ctx context.Context, readBuffer utils.ReadBuffer) (T, error)
func NewCIPEncapsulationConnectionRequest ¶
func NewCIPEncapsulationConnectionRequest(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationConnectionRequest
NewCIPEncapsulationConnectionRequest factory function for _CIPEncapsulationConnectionRequest
func NewCIPEncapsulationConnectionResponse ¶
func NewCIPEncapsulationConnectionResponse(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationConnectionResponse
NewCIPEncapsulationConnectionResponse factory function for _CIPEncapsulationConnectionResponse
func NewCIPEncapsulationPacket ¶
func NewCIPEncapsulationPacket(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) *_CIPEncapsulationPacket
NewCIPEncapsulationPacket factory function for _CIPEncapsulationPacket
func NewCIPEncapsulationReadRequest ¶
func NewCIPEncapsulationReadRequest(sessionHandle uint32, status uint32, senderContext []uint8, options uint32, request DF1RequestMessage) *_CIPEncapsulationReadRequest
NewCIPEncapsulationReadRequest factory function for _CIPEncapsulationReadRequest
func NewCIPEncapsulationReadResponse ¶
func NewCIPEncapsulationReadResponse(sessionHandle uint32, status uint32, senderContext []uint8, options uint32, response DF1ResponseMessage) *_CIPEncapsulationReadResponse
NewCIPEncapsulationReadResponse factory function for _CIPEncapsulationReadResponse
func NewDF1CommandRequestMessage ¶
func NewDF1CommandRequestMessage(destinationAddress uint8, sourceAddress uint8, status uint8, transactionCounter uint16, command DF1RequestCommand) *_DF1CommandRequestMessage
NewDF1CommandRequestMessage factory function for _DF1CommandRequestMessage
func NewDF1CommandResponseMessageProtectedTypedLogicalRead ¶
func NewDF1CommandResponseMessageProtectedTypedLogicalRead(destinationAddress uint8, sourceAddress uint8, status uint8, transactionCounter uint16, data []uint8) *_DF1CommandResponseMessageProtectedTypedLogicalRead
NewDF1CommandResponseMessageProtectedTypedLogicalRead factory function for _DF1CommandResponseMessageProtectedTypedLogicalRead
func NewDF1RequestCommand ¶
func NewDF1RequestCommand() *_DF1RequestCommand
NewDF1RequestCommand factory function for _DF1RequestCommand
func NewDF1RequestMessage ¶
func NewDF1RequestMessage(destinationAddress uint8, sourceAddress uint8, status uint8, transactionCounter uint16) *_DF1RequestMessage
NewDF1RequestMessage factory function for _DF1RequestMessage
func NewDF1RequestProtectedTypedLogicalRead ¶
func NewDF1RequestProtectedTypedLogicalRead(byteSize uint8, fileNumber uint8, fileType uint8, elementNumber uint8, subElementNumber uint8) *_DF1RequestProtectedTypedLogicalRead
NewDF1RequestProtectedTypedLogicalRead factory function for _DF1RequestProtectedTypedLogicalRead
Types ¶
type CIPEncapsulationConnectionRequest ¶
type CIPEncapsulationConnectionRequest interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
CIPEncapsulationPacket
// IsCIPEncapsulationConnectionRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationConnectionRequest()
// CreateBuilder creates a CIPEncapsulationConnectionRequestBuilder
CreateCIPEncapsulationConnectionRequestBuilder() CIPEncapsulationConnectionRequestBuilder
}
CIPEncapsulationConnectionRequest is the corresponding interface of CIPEncapsulationConnectionRequest
func CastCIPEncapsulationConnectionRequest
deprecated
func CastCIPEncapsulationConnectionRequest(structType any) CIPEncapsulationConnectionRequest
Deprecated: use the interface for direct cast
type CIPEncapsulationConnectionRequestBuilder ¶
type CIPEncapsulationConnectionRequestBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields() CIPEncapsulationConnectionRequestBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() CIPEncapsulationPacketBuilder
// Build builds the CIPEncapsulationConnectionRequest or returns an error if something is wrong
Build() (CIPEncapsulationConnectionRequest, error)
// MustBuild does the same as Build but panics on error
MustBuild() CIPEncapsulationConnectionRequest
}
CIPEncapsulationConnectionRequestBuilder is a builder for CIPEncapsulationConnectionRequest
func NewCIPEncapsulationConnectionRequestBuilder ¶
func NewCIPEncapsulationConnectionRequestBuilder() CIPEncapsulationConnectionRequestBuilder
NewCIPEncapsulationConnectionRequestBuilder() creates a CIPEncapsulationConnectionRequestBuilder
type CIPEncapsulationConnectionResponse ¶
type CIPEncapsulationConnectionResponse interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
CIPEncapsulationPacket
// IsCIPEncapsulationConnectionResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationConnectionResponse()
// CreateBuilder creates a CIPEncapsulationConnectionResponseBuilder
CreateCIPEncapsulationConnectionResponseBuilder() CIPEncapsulationConnectionResponseBuilder
}
CIPEncapsulationConnectionResponse is the corresponding interface of CIPEncapsulationConnectionResponse
func CastCIPEncapsulationConnectionResponse
deprecated
func CastCIPEncapsulationConnectionResponse(structType any) CIPEncapsulationConnectionResponse
Deprecated: use the interface for direct cast
type CIPEncapsulationConnectionResponseBuilder ¶
type CIPEncapsulationConnectionResponseBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields() CIPEncapsulationConnectionResponseBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() CIPEncapsulationPacketBuilder
// Build builds the CIPEncapsulationConnectionResponse or returns an error if something is wrong
Build() (CIPEncapsulationConnectionResponse, error)
// MustBuild does the same as Build but panics on error
MustBuild() CIPEncapsulationConnectionResponse
}
CIPEncapsulationConnectionResponseBuilder is a builder for CIPEncapsulationConnectionResponse
func NewCIPEncapsulationConnectionResponseBuilder ¶
func NewCIPEncapsulationConnectionResponseBuilder() CIPEncapsulationConnectionResponseBuilder
NewCIPEncapsulationConnectionResponseBuilder() creates a CIPEncapsulationConnectionResponseBuilder
type CIPEncapsulationPacket ¶
type CIPEncapsulationPacket interface {
CIPEncapsulationPacketContract
CIPEncapsulationPacketRequirements
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// IsCIPEncapsulationPacket is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationPacket()
// CreateBuilder creates a CIPEncapsulationPacketBuilder
CreateCIPEncapsulationPacketBuilder() CIPEncapsulationPacketBuilder
}
CIPEncapsulationPacket is the corresponding interface of CIPEncapsulationPacket
func CastCIPEncapsulationPacket
deprecated
func CastCIPEncapsulationPacket(structType any) CIPEncapsulationPacket
Deprecated: use the interface for direct cast
type CIPEncapsulationPacketBuilder ¶
type CIPEncapsulationPacketBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(sessionHandle uint32, status uint32, senderContext []uint8, options uint32) CIPEncapsulationPacketBuilder
// WithSessionHandle adds SessionHandle (property field)
WithSessionHandle(uint32) CIPEncapsulationPacketBuilder
// WithStatus adds Status (property field)
WithStatus(uint32) CIPEncapsulationPacketBuilder
// WithSenderContext adds SenderContext (property field)
WithSenderContext(...uint8) CIPEncapsulationPacketBuilder
// WithOptions adds Options (property field)
WithOptions(uint32) CIPEncapsulationPacketBuilder
// AsCIPEncapsulationConnectionRequest converts this build to a subType of CIPEncapsulationPacket. It is always possible to return to current builder using Done()
AsCIPEncapsulationConnectionRequest() CIPEncapsulationConnectionRequestBuilder
// AsCIPEncapsulationConnectionResponse converts this build to a subType of CIPEncapsulationPacket. It is always possible to return to current builder using Done()
AsCIPEncapsulationConnectionResponse() CIPEncapsulationConnectionResponseBuilder
// AsCIPEncapsulationReadRequest converts this build to a subType of CIPEncapsulationPacket. It is always possible to return to current builder using Done()
AsCIPEncapsulationReadRequest() CIPEncapsulationReadRequestBuilder
// AsCIPEncapsulationReadResponse converts this build to a subType of CIPEncapsulationPacket. It is always possible to return to current builder using Done()
AsCIPEncapsulationReadResponse() CIPEncapsulationReadResponseBuilder
// Build builds the CIPEncapsulationPacket or returns an error if something is wrong
PartialBuild() (CIPEncapsulationPacketContract, error)
// MustBuild does the same as Build but panics on error
PartialMustBuild() CIPEncapsulationPacketContract
// Build builds the CIPEncapsulationPacket or returns an error if something is wrong
Build() (CIPEncapsulationPacket, error)
// MustBuild does the same as Build but panics on error
MustBuild() CIPEncapsulationPacket
}
CIPEncapsulationPacketBuilder is a builder for CIPEncapsulationPacket
func NewCIPEncapsulationPacketBuilder ¶
func NewCIPEncapsulationPacketBuilder() CIPEncapsulationPacketBuilder
NewCIPEncapsulationPacketBuilder() creates a CIPEncapsulationPacketBuilder
type CIPEncapsulationPacketContract ¶
type CIPEncapsulationPacketContract interface {
// GetSessionHandle returns SessionHandle (property field)
GetSessionHandle() uint32
// GetStatus returns Status (property field)
GetStatus() uint32
// GetSenderContext returns SenderContext (property field)
GetSenderContext() []uint8
// GetOptions returns Options (property field)
GetOptions() uint32
// IsCIPEncapsulationPacket is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationPacket()
// CreateBuilder creates a CIPEncapsulationPacketBuilder
CreateCIPEncapsulationPacketBuilder() CIPEncapsulationPacketBuilder
}
CIPEncapsulationPacketContract provides a set of functions which can be overwritten by a sub struct
type CIPEncapsulationPacketRequirements ¶
type CIPEncapsulationPacketRequirements interface {
GetLengthInBits(ctx context.Context) uint16
GetLengthInBytes(ctx context.Context) uint16
// GetCommandType returns CommandType (discriminator field)
GetCommandType() uint16
}
CIPEncapsulationPacketRequirements provides a set of functions which need to be implemented by a sub struct
type CIPEncapsulationReadRequest ¶
type CIPEncapsulationReadRequest interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
CIPEncapsulationPacket
// GetRequest returns Request (property field)
GetRequest() DF1RequestMessage
// IsCIPEncapsulationReadRequest is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationReadRequest()
// CreateBuilder creates a CIPEncapsulationReadRequestBuilder
CreateCIPEncapsulationReadRequestBuilder() CIPEncapsulationReadRequestBuilder
}
CIPEncapsulationReadRequest is the corresponding interface of CIPEncapsulationReadRequest
func CastCIPEncapsulationReadRequest
deprecated
func CastCIPEncapsulationReadRequest(structType any) CIPEncapsulationReadRequest
Deprecated: use the interface for direct cast
type CIPEncapsulationReadRequestBuilder ¶
type CIPEncapsulationReadRequestBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(request DF1RequestMessage) CIPEncapsulationReadRequestBuilder
// WithRequest adds Request (property field)
WithRequest(DF1RequestMessage) CIPEncapsulationReadRequestBuilder
// WithRequestBuilder adds Request (property field) which is build by the builder
WithRequestBuilder(func(DF1RequestMessageBuilder) DF1RequestMessageBuilder) CIPEncapsulationReadRequestBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() CIPEncapsulationPacketBuilder
// Build builds the CIPEncapsulationReadRequest or returns an error if something is wrong
Build() (CIPEncapsulationReadRequest, error)
// MustBuild does the same as Build but panics on error
MustBuild() CIPEncapsulationReadRequest
}
CIPEncapsulationReadRequestBuilder is a builder for CIPEncapsulationReadRequest
func NewCIPEncapsulationReadRequestBuilder ¶
func NewCIPEncapsulationReadRequestBuilder() CIPEncapsulationReadRequestBuilder
NewCIPEncapsulationReadRequestBuilder() creates a CIPEncapsulationReadRequestBuilder
type CIPEncapsulationReadResponse ¶
type CIPEncapsulationReadResponse interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
CIPEncapsulationPacket
// GetResponse returns Response (property field)
GetResponse() DF1ResponseMessage
// IsCIPEncapsulationReadResponse is a marker method to prevent unintentional type checks (interfaces of same signature)
IsCIPEncapsulationReadResponse()
// CreateBuilder creates a CIPEncapsulationReadResponseBuilder
CreateCIPEncapsulationReadResponseBuilder() CIPEncapsulationReadResponseBuilder
}
CIPEncapsulationReadResponse is the corresponding interface of CIPEncapsulationReadResponse
func CastCIPEncapsulationReadResponse
deprecated
func CastCIPEncapsulationReadResponse(structType any) CIPEncapsulationReadResponse
Deprecated: use the interface for direct cast
type CIPEncapsulationReadResponseBuilder ¶
type CIPEncapsulationReadResponseBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(response DF1ResponseMessage) CIPEncapsulationReadResponseBuilder
// WithResponse adds Response (property field)
WithResponse(DF1ResponseMessage) CIPEncapsulationReadResponseBuilder
// WithResponseBuilder adds Response (property field) which is build by the builder
WithResponseBuilder(func(DF1ResponseMessageBuilder) DF1ResponseMessageBuilder) CIPEncapsulationReadResponseBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() CIPEncapsulationPacketBuilder
// Build builds the CIPEncapsulationReadResponse or returns an error if something is wrong
Build() (CIPEncapsulationReadResponse, error)
// MustBuild does the same as Build but panics on error
MustBuild() CIPEncapsulationReadResponse
}
CIPEncapsulationReadResponseBuilder is a builder for CIPEncapsulationReadResponse
func NewCIPEncapsulationReadResponseBuilder ¶
func NewCIPEncapsulationReadResponseBuilder() CIPEncapsulationReadResponseBuilder
NewCIPEncapsulationReadResponseBuilder() creates a CIPEncapsulationReadResponseBuilder
type DF1CommandRequestMessage ¶
type DF1CommandRequestMessage interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
DF1RequestMessage
// GetCommand returns Command (property field)
GetCommand() DF1RequestCommand
// IsDF1CommandRequestMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1CommandRequestMessage()
// CreateBuilder creates a DF1CommandRequestMessageBuilder
CreateDF1CommandRequestMessageBuilder() DF1CommandRequestMessageBuilder
}
DF1CommandRequestMessage is the corresponding interface of DF1CommandRequestMessage
func CastDF1CommandRequestMessage
deprecated
func CastDF1CommandRequestMessage(structType any) DF1CommandRequestMessage
Deprecated: use the interface for direct cast
type DF1CommandRequestMessageBuilder ¶
type DF1CommandRequestMessageBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(command DF1RequestCommand) DF1CommandRequestMessageBuilder
// WithCommand adds Command (property field)
WithCommand(DF1RequestCommand) DF1CommandRequestMessageBuilder
// WithCommandBuilder adds Command (property field) which is build by the builder
WithCommandBuilder(func(DF1RequestCommandBuilder) DF1RequestCommandBuilder) DF1CommandRequestMessageBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() DF1RequestMessageBuilder
// Build builds the DF1CommandRequestMessage or returns an error if something is wrong
Build() (DF1CommandRequestMessage, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1CommandRequestMessage
}
DF1CommandRequestMessageBuilder is a builder for DF1CommandRequestMessage
func NewDF1CommandRequestMessageBuilder ¶
func NewDF1CommandRequestMessageBuilder() DF1CommandRequestMessageBuilder
NewDF1CommandRequestMessageBuilder() creates a DF1CommandRequestMessageBuilder
type DF1CommandResponseMessageProtectedTypedLogicalRead ¶
type DF1CommandResponseMessageProtectedTypedLogicalRead interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
DF1ResponseMessage
// GetData returns Data (property field)
GetData() []uint8
// IsDF1CommandResponseMessageProtectedTypedLogicalRead is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1CommandResponseMessageProtectedTypedLogicalRead()
// CreateBuilder creates a DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
CreateDF1CommandResponseMessageProtectedTypedLogicalReadBuilder() DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
}
DF1CommandResponseMessageProtectedTypedLogicalRead is the corresponding interface of DF1CommandResponseMessageProtectedTypedLogicalRead
func CastDF1CommandResponseMessageProtectedTypedLogicalRead
deprecated
func CastDF1CommandResponseMessageProtectedTypedLogicalRead(structType any) DF1CommandResponseMessageProtectedTypedLogicalRead
Deprecated: use the interface for direct cast
type DF1CommandResponseMessageProtectedTypedLogicalReadBuilder ¶
type DF1CommandResponseMessageProtectedTypedLogicalReadBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(data []uint8) DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
// WithData adds Data (property field)
WithData(...uint8) DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() DF1ResponseMessageBuilder
// Build builds the DF1CommandResponseMessageProtectedTypedLogicalRead or returns an error if something is wrong
Build() (DF1CommandResponseMessageProtectedTypedLogicalRead, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1CommandResponseMessageProtectedTypedLogicalRead
}
DF1CommandResponseMessageProtectedTypedLogicalReadBuilder is a builder for DF1CommandResponseMessageProtectedTypedLogicalRead
func NewDF1CommandResponseMessageProtectedTypedLogicalReadBuilder ¶
func NewDF1CommandResponseMessageProtectedTypedLogicalReadBuilder() DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
NewDF1CommandResponseMessageProtectedTypedLogicalReadBuilder() creates a DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
type DF1RequestCommand ¶
type DF1RequestCommand interface {
DF1RequestCommandContract
DF1RequestCommandRequirements
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// IsDF1RequestCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1RequestCommand()
// CreateBuilder creates a DF1RequestCommandBuilder
CreateDF1RequestCommandBuilder() DF1RequestCommandBuilder
}
DF1RequestCommand is the corresponding interface of DF1RequestCommand
func CastDF1RequestCommand
deprecated
func CastDF1RequestCommand(structType any) DF1RequestCommand
Deprecated: use the interface for direct cast
type DF1RequestCommandBuilder ¶
type DF1RequestCommandBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields() DF1RequestCommandBuilder
// AsDF1RequestProtectedTypedLogicalRead converts this build to a subType of DF1RequestCommand. It is always possible to return to current builder using Done()
AsDF1RequestProtectedTypedLogicalRead() DF1RequestProtectedTypedLogicalReadBuilder
// Build builds the DF1RequestCommand or returns an error if something is wrong
PartialBuild() (DF1RequestCommandContract, error)
// MustBuild does the same as Build but panics on error
PartialMustBuild() DF1RequestCommandContract
// Build builds the DF1RequestCommand or returns an error if something is wrong
Build() (DF1RequestCommand, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1RequestCommand
}
DF1RequestCommandBuilder is a builder for DF1RequestCommand
func NewDF1RequestCommandBuilder ¶
func NewDF1RequestCommandBuilder() DF1RequestCommandBuilder
NewDF1RequestCommandBuilder() creates a DF1RequestCommandBuilder
type DF1RequestCommandContract ¶
type DF1RequestCommandContract interface {
// IsDF1RequestCommand is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1RequestCommand()
// CreateBuilder creates a DF1RequestCommandBuilder
CreateDF1RequestCommandBuilder() DF1RequestCommandBuilder
}
DF1RequestCommandContract provides a set of functions which can be overwritten by a sub struct
type DF1RequestCommandRequirements ¶
type DF1RequestCommandRequirements interface {
GetLengthInBits(ctx context.Context) uint16
GetLengthInBytes(ctx context.Context) uint16
// GetFunctionCode returns FunctionCode (discriminator field)
GetFunctionCode() uint8
}
DF1RequestCommandRequirements provides a set of functions which need to be implemented by a sub struct
type DF1RequestMessage ¶
type DF1RequestMessage interface {
DF1RequestMessageContract
DF1RequestMessageRequirements
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// IsDF1RequestMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1RequestMessage()
// CreateBuilder creates a DF1RequestMessageBuilder
CreateDF1RequestMessageBuilder() DF1RequestMessageBuilder
}
DF1RequestMessage is the corresponding interface of DF1RequestMessage
func CastDF1RequestMessage
deprecated
func CastDF1RequestMessage(structType any) DF1RequestMessage
Deprecated: use the interface for direct cast
type DF1RequestMessageBuilder ¶
type DF1RequestMessageBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(destinationAddress uint8, sourceAddress uint8, status uint8, transactionCounter uint16) DF1RequestMessageBuilder
// WithDestinationAddress adds DestinationAddress (property field)
WithDestinationAddress(uint8) DF1RequestMessageBuilder
// WithSourceAddress adds SourceAddress (property field)
WithSourceAddress(uint8) DF1RequestMessageBuilder
// WithStatus adds Status (property field)
WithStatus(uint8) DF1RequestMessageBuilder
// WithTransactionCounter adds TransactionCounter (property field)
WithTransactionCounter(uint16) DF1RequestMessageBuilder
// AsDF1CommandRequestMessage converts this build to a subType of DF1RequestMessage. It is always possible to return to current builder using Done()
AsDF1CommandRequestMessage() DF1CommandRequestMessageBuilder
// Build builds the DF1RequestMessage or returns an error if something is wrong
PartialBuild() (DF1RequestMessageContract, error)
// MustBuild does the same as Build but panics on error
PartialMustBuild() DF1RequestMessageContract
// Build builds the DF1RequestMessage or returns an error if something is wrong
Build() (DF1RequestMessage, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1RequestMessage
}
DF1RequestMessageBuilder is a builder for DF1RequestMessage
func NewDF1RequestMessageBuilder ¶
func NewDF1RequestMessageBuilder() DF1RequestMessageBuilder
NewDF1RequestMessageBuilder() creates a DF1RequestMessageBuilder
type DF1RequestMessageContract ¶
type DF1RequestMessageContract interface {
// GetDestinationAddress returns DestinationAddress (property field)
GetDestinationAddress() uint8
// GetSourceAddress returns SourceAddress (property field)
GetSourceAddress() uint8
// GetStatus returns Status (property field)
GetStatus() uint8
// GetTransactionCounter returns TransactionCounter (property field)
GetTransactionCounter() uint16
// IsDF1RequestMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1RequestMessage()
// CreateBuilder creates a DF1RequestMessageBuilder
CreateDF1RequestMessageBuilder() DF1RequestMessageBuilder
}
DF1RequestMessageContract provides a set of functions which can be overwritten by a sub struct
type DF1RequestMessageRequirements ¶
type DF1RequestMessageRequirements interface {
GetLengthInBits(ctx context.Context) uint16
GetLengthInBytes(ctx context.Context) uint16
// GetCommandCode returns CommandCode (discriminator field)
GetCommandCode() uint8
}
DF1RequestMessageRequirements provides a set of functions which need to be implemented by a sub struct
type DF1RequestProtectedTypedLogicalRead ¶
type DF1RequestProtectedTypedLogicalRead interface {
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
DF1RequestCommand
// GetByteSize returns ByteSize (property field)
GetByteSize() uint8
// GetFileNumber returns FileNumber (property field)
GetFileNumber() uint8
// GetFileType returns FileType (property field)
GetFileType() uint8
// GetElementNumber returns ElementNumber (property field)
GetElementNumber() uint8
// GetSubElementNumber returns SubElementNumber (property field)
GetSubElementNumber() uint8
// IsDF1RequestProtectedTypedLogicalRead is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1RequestProtectedTypedLogicalRead()
// CreateBuilder creates a DF1RequestProtectedTypedLogicalReadBuilder
CreateDF1RequestProtectedTypedLogicalReadBuilder() DF1RequestProtectedTypedLogicalReadBuilder
}
DF1RequestProtectedTypedLogicalRead is the corresponding interface of DF1RequestProtectedTypedLogicalRead
func CastDF1RequestProtectedTypedLogicalRead
deprecated
func CastDF1RequestProtectedTypedLogicalRead(structType any) DF1RequestProtectedTypedLogicalRead
Deprecated: use the interface for direct cast
type DF1RequestProtectedTypedLogicalReadBuilder ¶
type DF1RequestProtectedTypedLogicalReadBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(byteSize uint8, fileNumber uint8, fileType uint8, elementNumber uint8, subElementNumber uint8) DF1RequestProtectedTypedLogicalReadBuilder
// WithByteSize adds ByteSize (property field)
WithByteSize(uint8) DF1RequestProtectedTypedLogicalReadBuilder
// WithFileNumber adds FileNumber (property field)
WithFileNumber(uint8) DF1RequestProtectedTypedLogicalReadBuilder
// WithFileType adds FileType (property field)
WithFileType(uint8) DF1RequestProtectedTypedLogicalReadBuilder
// WithElementNumber adds ElementNumber (property field)
WithElementNumber(uint8) DF1RequestProtectedTypedLogicalReadBuilder
// WithSubElementNumber adds SubElementNumber (property field)
WithSubElementNumber(uint8) DF1RequestProtectedTypedLogicalReadBuilder
// Done is used to finish work on this child and return (or create one if none) to the parent builder
Done() DF1RequestCommandBuilder
// Build builds the DF1RequestProtectedTypedLogicalRead or returns an error if something is wrong
Build() (DF1RequestProtectedTypedLogicalRead, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1RequestProtectedTypedLogicalRead
}
DF1RequestProtectedTypedLogicalReadBuilder is a builder for DF1RequestProtectedTypedLogicalRead
func NewDF1RequestProtectedTypedLogicalReadBuilder ¶
func NewDF1RequestProtectedTypedLogicalReadBuilder() DF1RequestProtectedTypedLogicalReadBuilder
NewDF1RequestProtectedTypedLogicalReadBuilder() creates a DF1RequestProtectedTypedLogicalReadBuilder
type DF1ResponseMessage ¶
type DF1ResponseMessage interface {
DF1ResponseMessageContract
DF1ResponseMessageRequirements
fmt.Stringer
utils.LengthAware
utils.Serializable
utils.Copyable
// IsDF1ResponseMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1ResponseMessage()
// CreateBuilder creates a DF1ResponseMessageBuilder
CreateDF1ResponseMessageBuilder() DF1ResponseMessageBuilder
}
DF1ResponseMessage is the corresponding interface of DF1ResponseMessage
func CastDF1ResponseMessage
deprecated
func CastDF1ResponseMessage(structType any) DF1ResponseMessage
Deprecated: use the interface for direct cast
type DF1ResponseMessageBuilder ¶
type DF1ResponseMessageBuilder interface {
utils.Copyable
// WithMandatoryFields adds all mandatory fields (convenience for using multiple builder calls)
WithMandatoryFields(destinationAddress uint8, sourceAddress uint8, status uint8, transactionCounter uint16) DF1ResponseMessageBuilder
// WithDestinationAddress adds DestinationAddress (property field)
WithDestinationAddress(uint8) DF1ResponseMessageBuilder
// WithSourceAddress adds SourceAddress (property field)
WithSourceAddress(uint8) DF1ResponseMessageBuilder
// WithStatus adds Status (property field)
WithStatus(uint8) DF1ResponseMessageBuilder
// WithTransactionCounter adds TransactionCounter (property field)
WithTransactionCounter(uint16) DF1ResponseMessageBuilder
// AsDF1CommandResponseMessageProtectedTypedLogicalRead converts this build to a subType of DF1ResponseMessage. It is always possible to return to current builder using Done()
AsDF1CommandResponseMessageProtectedTypedLogicalRead() DF1CommandResponseMessageProtectedTypedLogicalReadBuilder
// Build builds the DF1ResponseMessage or returns an error if something is wrong
PartialBuild() (DF1ResponseMessageContract, error)
// MustBuild does the same as Build but panics on error
PartialMustBuild() DF1ResponseMessageContract
// Build builds the DF1ResponseMessage or returns an error if something is wrong
Build() (DF1ResponseMessage, error)
// MustBuild does the same as Build but panics on error
MustBuild() DF1ResponseMessage
}
DF1ResponseMessageBuilder is a builder for DF1ResponseMessage
func NewDF1ResponseMessageBuilder ¶
func NewDF1ResponseMessageBuilder() DF1ResponseMessageBuilder
NewDF1ResponseMessageBuilder() creates a DF1ResponseMessageBuilder
type DF1ResponseMessageContract ¶
type DF1ResponseMessageContract interface {
// GetDestinationAddress returns DestinationAddress (property field)
GetDestinationAddress() uint8
// GetSourceAddress returns SourceAddress (property field)
GetSourceAddress() uint8
// GetStatus returns Status (property field)
GetStatus() uint8
// GetTransactionCounter returns TransactionCounter (property field)
GetTransactionCounter() uint16
// IsDF1ResponseMessage is a marker method to prevent unintentional type checks (interfaces of same signature)
IsDF1ResponseMessage()
// CreateBuilder creates a DF1ResponseMessageBuilder
CreateDF1ResponseMessageBuilder() DF1ResponseMessageBuilder
}
DF1ResponseMessageContract provides a set of functions which can be overwritten by a sub struct
type DF1ResponseMessageRequirements ¶
type DF1ResponseMessageRequirements interface {
GetLengthInBits(ctx context.Context) uint16
GetLengthInBytes(ctx context.Context) uint16
// GetCommandCode returns CommandCode (discriminator field)
GetCommandCode() uint8
}
DF1ResponseMessageRequirements provides a set of functions which need to be implemented by a sub struct
Source Files
¶
- CIPEncapsulationConnectionRequest.go
- CIPEncapsulationConnectionResponse.go
- CIPEncapsulationPacket.go
- CIPEncapsulationReadRequest.go
- CIPEncapsulationReadResponse.go
- DF1CommandRequestMessage.go
- DF1CommandResponseMessageProtectedTypedLogicalRead.go
- DF1RequestCommand.go
- DF1RequestMessage.go
- DF1RequestProtectedTypedLogicalRead.go
- DF1ResponseMessage.go
- plc4x_common.go