Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// SchemeBuilder for mission.cloudrobotics.com
	SchemeBuilder runtime.SchemeBuilder

	// AddToScheme for mission.cloudrobotics.com
	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{
	Group:   "mission.cloudrobotics.com",
	Version: "v1alpha1",
}

    SchemeGroupVersion for mission.cloudrobotics.com

    Functions

    func Resource

    func Resource(resource string) schema.GroupResource

      Resource takes an unqualified resource and returns a Group qualified GroupResource

      Types

      type Action

      type Action interface {
      	DeepCopyAction() Action
      	// contains filtered or unexported methods
      }

        Action is an interface to represent polymorphic array of actions in MissionSpec

        type ActiveAction

        type ActiveAction struct {
        	Status ActiveActionStatus `json:"status,omitempty"`
        }

          ActiveAction represents the ActiveAction of a Mission

          func (*ActiveAction) DeepCopy

          func (in *ActiveAction) DeepCopy() *ActiveAction

            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ActiveAction.

            func (*ActiveAction) DeepCopyInto

            func (in *ActiveAction) DeepCopyInto(out *ActiveAction)

              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

              type ActiveActionStatus

              type ActiveActionStatus string

                ActiveActionStatus describes the status of ActiveAction

                const (
                	ActiveActionSpace   ActiveActionStatus = ""
                	ActiveActionMoving  ActiveActionStatus = "MOVING"
                	ActiveActionDocking ActiveActionStatus = "DOCKING"
                )

                  Values for ActiveActionStatus

                  type Charge

                  type Charge struct {
                  	ChargerName             string `json:"chargerName"`
                  	ThresholdBatteryPercent int    `json:"thresholdBatteryPercent"`
                  	TargetBatteryPercent    int    `json:"targetBatteryPercent"`
                  }

                    Charge structure of corresponding action

                    func (*Charge) DeepCopy

                    func (in *Charge) DeepCopy() *Charge

                      DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Charge.

                      func (*Charge) DeepCopyInto

                      func (in *Charge) DeepCopyInto(out *Charge)

                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                        type ChargeAction

                        type ChargeAction struct {
                        	Charge Charge `json:"charge"`
                        }

                          ChargeAction of MissionSpec.Actions

                          func (*ChargeAction) DeepCopy

                          func (in *ChargeAction) DeepCopy() *ChargeAction

                            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ChargeAction.

                            func (*ChargeAction) DeepCopyAction

                            func (a *ChargeAction) DeepCopyAction() Action

                              DeepCopyAction represents the deepcopy method of the Action interface

                              func (*ChargeAction) DeepCopyInto

                              func (in *ChargeAction) DeepCopyInto(out *ChargeAction)

                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                type Dock

                                type Dock struct {
                                	DockName string `json:"dockName"`
                                }

                                  Dock structure of corresponding action

                                  func (*Dock) DeepCopy

                                  func (in *Dock) DeepCopy() *Dock

                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dock.

                                    func (*Dock) DeepCopyInto

                                    func (in *Dock) DeepCopyInto(out *Dock)

                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                      type GetTrolleyAction

                                      type GetTrolleyAction struct {
                                      	GetTrolley Dock `json:"getTrolley"`
                                      }

                                        GetTrolleyAction of MissionSpec.Actions

                                        func (*GetTrolleyAction) DeepCopy

                                        func (in *GetTrolleyAction) DeepCopy() *GetTrolleyAction

                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GetTrolleyAction.

                                          func (*GetTrolleyAction) DeepCopyAction

                                          func (a *GetTrolleyAction) DeepCopyAction() Action

                                            DeepCopyAction represents the deepcopy method of the Action interface

                                            func (*GetTrolleyAction) DeepCopyInto

                                            func (in *GetTrolleyAction) DeepCopyInto(out *GetTrolleyAction)

                                              DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                              type Mission

                                              type Mission struct {
                                              	metav1.TypeMeta `json:",inline"`
                                              	// +optional
                                              	metav1.ObjectMeta `json:"metadata,omitempty"`
                                              
                                              	Spec MissionSpec `json:"spec"`
                                              	// +optional
                                              	Status MissionStatus `json:"status,omitempty"`
                                              }

                                                Mission represents the Mission CRD

                                                func (*Mission) DeepCopy

                                                func (in *Mission) DeepCopy() *Mission

                                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Mission.

                                                  func (*Mission) DeepCopyInto

                                                  func (in *Mission) DeepCopyInto(out *Mission)

                                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                    func (*Mission) DeepCopyObject

                                                    func (in *Mission) DeepCopyObject() runtime.Object

                                                      DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                                      type MissionList

                                                      type MissionList struct {
                                                      	metav1.TypeMeta `json:",inline"`
                                                      	// +optional
                                                      	metav1.ListMeta `json:"metadata,omitempty"`
                                                      
                                                      	Items []Mission `json:"items"`
                                                      }

                                                        MissionList represents the array of Mission CRD

                                                        func (*MissionList) DeepCopy

                                                        func (in *MissionList) DeepCopy() *MissionList

                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MissionList.

                                                          func (*MissionList) DeepCopyInto

                                                          func (in *MissionList) DeepCopyInto(out *MissionList)

                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                            func (*MissionList) DeepCopyObject

                                                            func (in *MissionList) DeepCopyObject() runtime.Object

                                                              DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

                                                              type MissionSpec

                                                              type MissionSpec struct {
                                                              	Actions    []Action `json:"actions"`
                                                              	TimeOutSec int      `json:"timeOutSec,omitempty"`
                                                              }

                                                                MissionSpec represents the spec of Mission CRD

                                                                func (*MissionSpec) DeepCopy

                                                                func (in *MissionSpec) DeepCopy() *MissionSpec

                                                                  DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MissionSpec.

                                                                  func (*MissionSpec) DeepCopyInto

                                                                  func (in *MissionSpec) DeepCopyInto(out *MissionSpec)

                                                                    DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                    func (*MissionSpec) UnmarshalJSON

                                                                    func (m *MissionSpec) UnmarshalJSON(data []byte) error

                                                                      UnmarshalJSON is a JSON Unmarshaller supporting the polimorphic Actions array

                                                                      type MissionStatus

                                                                      type MissionStatus struct {
                                                                      	ActiveAction    ActiveAction        `json:"activeAction,omitempty"`
                                                                      	Message         string              `json:"message,omitempty"`
                                                                      	Status          MissionStatusStatus `json:"status,omitempty"`
                                                                      	TimeOfActuation metav1.Time         `json:"timeOfActuation,omitempty"`
                                                                      }

                                                                        MissionStatus represents the status of Mission CRD

                                                                        func (*MissionStatus) DeepCopy

                                                                        func (in *MissionStatus) DeepCopy() *MissionStatus

                                                                          DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MissionStatus.

                                                                          func (*MissionStatus) DeepCopyInto

                                                                          func (in *MissionStatus) DeepCopyInto(out *MissionStatus)

                                                                            DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                            type MissionStatusStatus

                                                                            type MissionStatusStatus string

                                                                              MissionStatusStatus describes the status of a Mission

                                                                              const (
                                                                              	// initial state
                                                                              	MissionStatusCreated MissionStatusStatus = "CREATED"
                                                                              	// mission has been validated on
                                                                              	MissionStatusAccepted MissionStatusStatus = "ACCEPTED"
                                                                              	// active state (processing)
                                                                              	MissionStatusRunning MissionStatusStatus = "RUNNING"
                                                                              	// terminal states
                                                                              	MissionStatusSucceeded MissionStatusStatus = "SUCCEEDED"
                                                                              	MissionStatusCanceled  MissionStatusStatus = "CANCELED"
                                                                              	MissionStatusFailed    MissionStatusStatus = "FAILED"
                                                                              )

                                                                                Values for MissionStatusStatus

                                                                                type MoveToNamedPositionAction

                                                                                type MoveToNamedPositionAction struct {
                                                                                	MoveToNamedPosition Target `json:"moveToNamedPosition"`
                                                                                }

                                                                                  MoveToNamedPositionAction of MissionSpec.Actions

                                                                                  func (*MoveToNamedPositionAction) DeepCopy

                                                                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MoveToNamedPositionAction.

                                                                                    func (*MoveToNamedPositionAction) DeepCopyAction

                                                                                    func (a *MoveToNamedPositionAction) DeepCopyAction() Action

                                                                                      DeepCopyAction represents the deepcopy method of the Action interface

                                                                                      func (*MoveToNamedPositionAction) DeepCopyInto

                                                                                        DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                                        type ReturnTrolleyAction

                                                                                        type ReturnTrolleyAction struct {
                                                                                        	ReturnTrolley Dock `json:"returnTrolley"`
                                                                                        }

                                                                                          ReturnTrolleyAction of MissionSpec.Actions

                                                                                          func (*ReturnTrolleyAction) DeepCopy

                                                                                          func (in *ReturnTrolleyAction) DeepCopy() *ReturnTrolleyAction

                                                                                            DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReturnTrolleyAction.

                                                                                            func (*ReturnTrolleyAction) DeepCopyAction

                                                                                            func (a *ReturnTrolleyAction) DeepCopyAction() Action

                                                                                              DeepCopyAction represents the deepcopy method of the Action interface

                                                                                              func (*ReturnTrolleyAction) DeepCopyInto

                                                                                              func (in *ReturnTrolleyAction) DeepCopyInto(out *ReturnTrolleyAction)

                                                                                                DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

                                                                                                type Target

                                                                                                type Target struct {
                                                                                                	TargetName string `json:"targetName"`
                                                                                                }

                                                                                                  Target structure of corresponding action

                                                                                                  func (*Target) DeepCopy

                                                                                                  func (in *Target) DeepCopy() *Target

                                                                                                    DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Target.

                                                                                                    func (*Target) DeepCopyInto

                                                                                                    func (in *Target) DeepCopyInto(out *Target)

                                                                                                      DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.