catalogdiagrams

README

package catalogdiagrams is a re-write of a whole bunch of internal sysl diagramming code but with fixes so that it can work better with the markdown generator, for example it can recursively get all types unlike the sysl datamodeldiagram package

Documentation

Index

• func GenerateDataModel(parentAppName string, t map[string]*sysl.Type) string
• func RecursivelyGetTypes(appName string, types map[string]*sysl.Type, m *sysl.Module) map[string]*sysl.Type
• func RecursivelyGetTypesHelper(appName string, t *sysl.Type, m *sysl.Module, ...) map[string]*sysl.Type
• func TypeFromRef(mod *sysl.Module, appName string, t *sysl.Type) (string, string, *sysl.Type)
• type DataModelParam
• type DataModelView
  • func (v *DataModelView) GenerateDataView(dataParam *DataModelParam, appName string, tMap map[string]*sysl.Type) string

Functions

func GenerateDataModel

func GenerateDataModel(parentAppName string, t map[string]*sysl.Type) string

GenerateDataModel takes all the types in parentAppName and generates data model diagrams for it

func RecursivelyGetTypes

func RecursivelyGetTypes(appName string, types map[string]*sysl.Type, m *sysl.Module) map[string]*sysl.Type

func RecursivelyGetTypesHelper

func RecursivelyGetTypesHelper(appName string, t *sysl.Type, m *sysl.Module, cummulative map[string]*sysl.Type) map[string]*sysl.Type

RecursivelyGetTypesHelper gets returns a type map of a type and all of its fields recursively.

func TypeFromRef

func TypeFromRef(mod *sysl.Module, appName string, t *sysl.Type) (string, string, *sysl.Type)

Types

type DataModelParam

type DataModelParam struct {
	datamodeldiagram.DataModelParam
}

type DataModelView

type DataModelView struct {
	datamodeldiagram.DataModelView
}

func (*DataModelView) GenerateDataView

func (v *DataModelView) GenerateDataView(dataParam *DataModelParam, appName string, tMap map[string]*sysl.Type) string