Skip to content

Commit c046248

Browse files
Deduplicate indexed record entries in the HDF5 docs
There are multiple PVs that are instantiated up to 9 dimensions. Instead of listing them exhaustively, document them once with an N variable as done with NDArraySize parameter. This makes the documentation less bloated and easier to add more such PVs in a concise and less error-prone way. Improving the way such collapsed table entries are documented is out-of-the-scope of this patch, and it will be dealt with in future changes. While here, correct "posIndexDim" record names to use uppercase 'P'.
1 parent 96db85a commit c046248

File tree

1 file changed

+11
-119
lines changed

1 file changed

+11
-119
lines changed

docs/ADCore/NDFileHDF5.rst

Lines changed: 11 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -751,45 +751,9 @@ Parameters and Records
751751
- longout, longin
752752
* - asynInt32
753753
- r/w
754-
- Size of extra dimension 3
755-
- HDF5_extraDimSize3
756-
- $(P)$(R)ExtraDimSize3, $(P)$(R)ExtraDimSize3_RBV
757-
- longout, longin
758-
* - asynInt32
759-
- r/w
760-
- Size of extra dimension 4
761-
- HDF5_extraDimSize4
762-
- $(P)$(R)ExtraDimSize4, $(P)$(R)ExtraDimSize4_RBV
763-
- longout, longin
764-
* - asynInt32
765-
- r/w
766-
- Size of extra dimension 5
767-
- HDF5_extraDimSize5
768-
- $(P)$(R)ExtraDimSize5, $(P)$(R)ExtraDimSize5_RBV
769-
- longout, longin
770-
* - asynInt32
771-
- r/w
772-
- Size of extra dimension 6
773-
- HDF5_extraDimSize6
774-
- $(P)$(R)ExtraDimSize6, $(P)$(R)ExtraDimSize6_RBV
775-
- longout, longin
776-
* - asynInt32
777-
- r/w
778-
- Size of extra dimension 7
779-
- HDF5_extraDimSize7
780-
- $(P)$(R)ExtraDimSize7, $(P)$(R)ExtraDimSize7_RBV
781-
- longout, longin
782-
* - asynInt32
783-
- r/w
784-
- Size of extra dimension 8
785-
- HDF5_extraDimSize8
786-
- $(P)$(R)ExtraDimSize8, $(P)$(R)ExtraDimSize8_RBV
787-
- longout, longin
788-
* - asynInt32
789-
- r/w
790-
- Size of extra dimension 9
791-
- HDF5_extraDimSize9
792-
- $(P)$(R)ExtraDimSize9, $(P)$(R)ExtraDimSize9_RBV
754+
- Size of the N'th extra dimension, for N in [3..9]
755+
- HDF5_extraDimSize[N]
756+
- $(P)$(R)ExtraDimSize[N], $(P)$(R)ExtraDimSize[N]_RBV
793757
- longout, longin
794758
* -
795759
-
@@ -820,45 +784,9 @@ Parameters and Records
820784
- stringout, stringin
821785
* - asynOctet
822786
- r/w
823-
- Specify the NDAttribute name for the 3rd index
824-
- HDF5_posNameDim3
825-
- $(P)$(R)PosNameDim3, $(P)$(R)PosNameDim3_RBV
826-
- stringout, stringin
827-
* - asynOctet
828-
- r/w
829-
- Specify the NDAttribute name for the 4th index
830-
- HDF5_posNameDim4
831-
- $(P)$(R)PosNameDim4, $(P)$(R)PosNameDim4_RBV
832-
- stringout, stringin
833-
* - asynOctet
834-
- r/w
835-
- Specify the NDAttribute name for the 5th index
836-
- HDF5_posNameDim5
837-
- $(P)$(R)PosNameDim5, $(P)$(R)PosNameDim5_RBV
838-
- stringout, stringin
839-
* - asynOctet
840-
- r/w
841-
- Specify the NDAttribute name for the 6th index
842-
- HDF5_posNameDim6
843-
- $(P)$(R)PosNameDim6, $(P)$(R)PosNameDim6_RBV
844-
- stringout, stringin
845-
* - asynOctet
846-
- r/w
847-
- Specify the NDAttribute name for the 7th index
848-
- HDF5_posNameDim7
849-
- $(P)$(R)PosNameDim7, $(P)$(R)PosNameDim7_RBV
850-
- stringout, stringin
851-
* - asynOctet
852-
- r/w
853-
- Specify the NDAttribute name for the 8th index
854-
- HDF5_posNameDim8
855-
- $(P)$(R)PosNameDim8, $(P)$(R)PosNameDim8_RBV
856-
- stringout, stringin
857-
* - asynOctet
858-
- r/w
859-
- Specify the NDAttribute name for the 9th index
860-
- HDF5_posNameDim9
861-
- $(P)$(R)PosNameDim9, $(P)$(R)PosNameDim9_RBV
787+
- Specify the NDAttribute name for the N'th index, for N in [3..9]
788+
- HDF5_posNameDim[N]
789+
- $(P)$(R)PosNameDim[N], $(P)$(R)PosNameDim[N]_RBV
862790
- stringout, stringin
863791
* -
864792
-
@@ -873,55 +801,19 @@ Parameters and Records
873801
- r/w
874802
- Specify the NDAttribute index for the X dimension
875803
- HDF5_posIndexDimX
876-
- $(P)$(R)posIndexDimX, $(P)$(R)posIndexDimX_RBV
804+
- $(P)$(R)PosIndexDimX, $(P)$(R)PosIndexDimX_RBV
877805
- stringout, stringin
878806
* - asynOctet
879807
- r/w
880808
- Specify the NDAttribute index for the Y dimension
881809
- HDF5_posIndexDimY
882-
- $(P)$(R)posIndexDimY, $(P)$(R)posIndexDimY_RBV
883-
- stringout, stringin
884-
* - asynOctet
885-
- r/w
886-
- Specify the NDAttribute index for the 3rd dimension
887-
- HDF5_posIndexDim3
888-
- $(P)$(R)posIndexDim3, $(P)$(R)posIndexDim3_RBV
889-
- stringout, stringin
890-
* - asynOctet
891-
- r/w
892-
- Specify the NDAttribute index for the 4th dimension
893-
- HDF5_posIndexDim4
894-
- $(P)$(R)posIndexDim4, $(P)$(R)posIndexDim4_RBV
895-
- stringout, stringin
896-
* - asynOctet
897-
- r/w
898-
- Specify the NDAttribute index for the 5th dimension
899-
- HDF5_posIndexDim5
900-
- $(P)$(R)posIndexDim5, $(P)$(R)posIndexDim5_RBV
901-
- stringout, stringin
902-
* - asynOctet
903-
- r/w
904-
- Specify the NDAttribute index for the 6th dimension
905-
- HDF5_posIndexDim6
906-
- $(P)$(R)posIndexDim6, $(P)$(R)posIndexDim6_RBV
907-
- stringout, stringin
908-
* - asynOctet
909-
- r/w
910-
- Specify the NDAttribute index for the 7th dimension
911-
- HDF5_posIndexDim7
912-
- $(P)$(R)posIndexDim7, $(P)$(R)posIndexDim7_RBV
913-
- stringout, stringin
914-
* - asynOctet
915-
- r/w
916-
- Specify the NDAttribute index for the 8th dimension
917-
- HDF5_posIndexDim8
918-
- $(P)$(R)posIndexDim8, $(P)$(R)posIndexDim8_RBV
810+
- $(P)$(R)PosIndexDimY, $(P)$(R)PosIndexDimY_RBV
919811
- stringout, stringin
920812
* - asynOctet
921813
- r/w
922-
- Specify the NDAttribute index for the 9th dimension
923-
- HDF5_posIndexDim9
924-
- $(P)$(R)posIndexDim9, $(P)$(R)posIndexDim9_RBV
814+
- Specify the NDAttribute index for the N'th dimension, for N in [3..9]
815+
- HDF5_posIndexDim[N]
816+
- $(P)$(R)PosIndexDim[N], $(P)$(R)PosIndexDim[N]_RBV
925817
- stringout, stringin
926818
* -
927819
-

0 commit comments

Comments
 (0)