public interface PackageDoc extends ObjectDoc
Here the layout you may use for "regular" package, with
PlaceholderSpec.Kind.PACKAGE
:
getHeadingText() getGenHeadingText() getDescription() getDiagramDocs() // loop getClassDocs() // loop getChildPackageDocs() // loopThis kind of documentation is needed for printing the full content of the relevant packages in both CIM and IEC61850 domains.
If the package has been configured to print data index in place of
PlaceholderSpec.Kind.DATA_INDEX
(i.e.,
Config.getValidationPackagesDataIndex()
is not empty), then getDataIndexDoc()
will be non-null and can be used. This kind of documentation is needed for data index clauses in
IEC61850-7-4 and IEC61850-7-3.
If the package has been configured to print enums as XML in place of
PlaceholderSpec.Kind.SCL_ENUMS
(i.e.,
Config.getValidationIec61850PackagesEnumsXml()
is not empty), then
getEnumsPackageScl()
will be non-null and can be used. This kind of documentation is
needed for annexes listing enums as XML in IEC61850-7-4 and IEC61850-7-3.
If the package has been configured to print the functional constraints table in place of
PlaceholderSpec.Kind.FCS
(i.e.,
Config.getValidationIec61850PackageFc()
is not null), then getFcPackageDoc()
will be non-null and can be used. This kind of documentation is needed for a subclause in
IEC61850-7-2 and an annex in IEC61850-7-3.
If the package has been configured to print the trigger options table in place of
PlaceholderSpec.Kind.TRGOPS
(i.e.,
Config.getValidationIec61850PackageTrgOp()
is not null), then
getTrgOpPackageDoc()
will be non-null and can be used. This kind of documentation is
needed for a subclause in IEC61850-7-2.
If the package has been configured to print data object abbreviations in place of
PlaceholderSpec.Kind.ABBREVIATIONS
(i.e.,
Config.getValidationIec61850PackagesDoAbbr()
is not null), then
getAbbrPackageDoc()
will be non-null and can be used. This kind of documentation is
needed for Abbreviations clause in IEC61850-7-4.
If the package has been configured to print presence conditions in place of
PlaceholderSpec.Kind.PRES_CONDITIONS
(i.e.,
Config.getValidationIec61850PackagePresCond()
is not null), then
getPresCondPackageDoc()
will be non-null and can be used. This kind of documentation is
needed for Presence conditions clause in IEC61850-7-3.
If the package has been configured to print LN mapings in place of
PlaceholderSpec.Kind.LNMAP_PACKAGE
(i.e.,
Config.getValidationIec61850PackageLnMaps()
is not null), then
getLnMapPackageDoc()
will be non-null and can be used. This kind of documentation is
needed for one clause in IEC61850-7-4 (where we have to show tables of "mappings" between
requirements LNs of IEC61850-5, and real LNs of IEC61850-7-4).
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
HANGING_PARA_TITLE
IEC does not allow hanging paragraphs, so we include a sub-clause per package.
|
static java.lang.String |
LNPKG_HEADING_FORMAT
(IEC 61850) Format to use for logical node packages: alias (UML name).
|
Modifier and Type | Method and Description |
---|---|
PropertiesDoc |
getAbbrPackageDoc() |
java.util.List<PackageDoc> |
getChildPackageDocs()
Returns documentation for all the child packages of this package.
|
java.util.List<ClassDoc> |
getClassDocs()
Returns documentation for all the classes in this package.
|
PropertiesDoc |
getDataIndexDoc() |
PackageScl |
getEnumsPackageScl() |
PropertiesDoc |
getFcPackageDoc() |
java.util.List<FigureDoc> |
getFigureDocs()
Returns documentation for all the figures in this package.
|
java.lang.String |
getGenHeadingText()
To avoid hanging paragraphs (i.e., those with some text but without title), ensure to include
a "general" heading and print the doc and diagrams of the package under it.
|
PropertiesDoc |
getLnMapPackageDoc() |
java.lang.String |
getModelName()
Returns name of the model package (the one with nature) to which it belongs.
|
NamespaceInfo |
getNamespaceInfo()
Returns name space information if it is defined for the package, null otherwise.
|
Nature |
getNature()
Returns nature of the package.
|
java.lang.String |
getPackageName()
Returns the name of the package.
|
PropertiesDoc |
getPresCondPackageDoc() |
PropertiesDoc |
getTrgOpPackageDoc() |
getBmRegistry, getBookmarkID, getDescription, getDocgenCfg, getHeadingText
copyCell, copyNonEmptyCell, getCell, getCells, hasKey, putCell, putCellNonEmpty
static final java.lang.String HANGING_PARA_TITLE
static final java.lang.String LNPKG_HEADING_FORMAT
java.lang.String getPackageName()
NamespaceInfo getNamespaceInfo()
java.lang.String getModelName()
Nature getNature()
java.lang.String getGenHeadingText()
java.util.List<FigureDoc> getFigureDocs()
java.util.List<ClassDoc> getClassDocs()
java.util.List<PackageDoc> getChildPackageDocs()
PropertiesDoc getDataIndexDoc()
PropertiesDoc getLnMapPackageDoc()
PropertiesDoc getPresCondPackageDoc()
PropertiesDoc getFcPackageDoc()
PropertiesDoc getTrgOpPackageDoc()
PropertiesDoc getAbbrPackageDoc()
PackageScl getEnumsPackageScl()
Copyright 2009-2016 Tatjana (Tanja) Kostic