github.com/blueinnovationsgroup/can-go@v0.0.0-20230518195432-d0567cda0028/pkg/generated/message.go (about)

     1  // Package generated provides primitives for working with code-generated CAN messages.
     2  package generated
     3  
     4  import (
     5  	"fmt"
     6  
     7  	"github.com/blueinnovationsgroup/can-go"
     8  	"github.com/blueinnovationsgroup/can-go/pkg/descriptor"
     9  )
    10  
    11  // Message represents a code-generated CAN message.
    12  type Message interface {
    13  	can.Message
    14  	fmt.Stringer
    15  
    16  	// Descriptor returns the message descriptor.
    17  	Descriptor() *descriptor.Message
    18  
    19  	// Reset the message signals to their default values.
    20  	Reset()
    21  
    22  	// Frame returns a CAN frame representing the message.
    23  	//
    24  	// A generated message ensures that its signals are valid and is always convertible to a CAN frame.
    25  	Frame() can.Frame
    26  }