Skip to content

Commit e718546

Browse files
committed
README Update
1 parent 173c540 commit e718546

1 file changed

Lines changed: 40 additions & 8 deletions

File tree

README.md

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ An [InterSystems ObjectScript](https://docs.intersystems.com/irislatest/csp/docb
4444
* `currentToFile`: When enabled the current property contains an absolute path to the current file. When disabled the current property contains the current file as a string.
4545
* `recievedLine`(optional): Holds a received string. (Used for *cleardata*)
4646
* `className`(will be set): The complete class name of the generated class.
47-
* `logClass`(will be set): The complete class name of the log class(will not be used!).
4847

4948
---
5049

@@ -90,20 +89,51 @@ A Business Operation, that builts an ObjectScript class based on a MTConnect pro
9089

9190
* `Name`: The name of the datatype.
9291
* `Unit`: The unit to display the datatype with.
93-
* `DataType`: The underlying ObjectScript type (Currently only works with *%String* and *%Double*).
92+
* `DataType`: The underlying ObjectScript type (Currently only works with *%String*, *%Integer* and *%Double*).
9493
* `AllowedStringValues`: Comma separated list for the allowed values. If left empty all values will be allowed. (only used when `DataType` is *%String*)
95-
* `AllowedNumericMaxValue`: The maximum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double*)
96-
* `AllowedNumericMinValue`: The minimum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double*)
94+
* `AllowedNumericMaxValue`: The maximum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double* or *%Integer*)
95+
* `AllowedNumericMinValue`: The minimum value that is allowed. If left empty all values will be allowed. (only used when `DataType` is *%Double* or *%Integer*)
9796

9897
---
9998

100-
## [MTConnect.DataTypesBuilder](cls/MTConnect/DataTypesBuilder.cls) / [Operation](cls/MTConnect/BO/DataTypesBuilderOperation.cls)
99+
## [MTConnect.DataTypesBuilder](cls/MTConnect/DataTypesBuilder.cls)
101100

102101
Builds MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls).
103102

104-
### Methods
103+
### Execute Method
105104

106-
* `Execute`: Builds the datatype.
105+
* `pRequest`: The [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls)
106+
* `pPackage`: The package name to store the datatypes (Default is *MTConnect.DataTypes*)
107+
* `pGenerateIsValid`: If enabled generates the *IsValid* method for the datatype (enabled by default)
108+
* `pGenerateNormalize`: If enabled generates the *Normalize* method for the datatype (enabled by default)
109+
* `pGenerateDisplayToLogical`: If enabled generates the *DisplayToLogical* method for the datatype (enabled by default)
110+
* `pGenerateLogicalToDisplay`: If enabled generates the *LogicalToDisplay* method for the datatype (enabled by default)
111+
112+
---
113+
114+
## [MTConnect.BO.DataTypesBuilderOperation](cls/MTConnect/BO/DataTypesBuilderOperation.cls)
115+
116+
A Business Operation to build MTConnect Datatypes based on a [MTConnect.MSG.CreateDataTypeRequest](cls/MTConnect/MSG/CreateDataTypeRequest.cls).
117+
118+
### Request
119+
120+
[MTConnect.MSG.CreateDataTypeRequest](cls\MTConnect\MSG\CreateDataTypeRequest.cls)
121+
122+
### Response
123+
124+
[Ens.StringResponse](https://docs.intersystems.com/irislatest/csp/documatic/%25CSP.Documatic.cls?LIBRARY=ENSLIB&CLASSNAME=Ens.StringResponse)
125+
126+
### Settings
127+
128+
#### DataType
129+
130+
* `Package`: The package name to store the datatypes (Default is *MTConnect.DataTypes*)
131+
* `IsValid`: If enabled generates the *IsValid* method for the datatype
132+
* `Normalize`: If enabled generates the *Normalize* method for the datatype
133+
* `DisplayToLogical`: If enabled generates the *DisplayToLogical* method for the datatype
134+
* `LogicalToDisplay`: If enabled generates the *LogicalToDisplay* method for the datatype
135+
136+
> Tip: Hava a look at [MTConnect.DataTypes](cls/MTConnect/DataTypes) for some default MTConnect DataTypes.
107137
108138
---
109139

@@ -130,6 +160,8 @@ An example for how to use the [DataTypesBuilder Operation](cls/MTConnect/BO/Data
130160
* Type in the `StringValue` field *String* to generate a String MTConnect DataType
131161
**OR**
132162
* Type in the `StringValue` field *Double* to generate a Double MTConnect DataType
163+
**OR**
164+
* Type in the `StringValue` field *Inetger* to generate a Integer MTConnect DataType
133165
* Click on `Invoke Testing Service`
134166
* You can follow the *Visual Trace* to see how the DataType was created
135167
* You will find the DataTypes under `MTConnect.ExampleProduction.DataTypes`
@@ -163,7 +195,7 @@ An example for how to use the [ClassBuilder Operation](cls/MTConnect/BO/ClassBui
163195

164196
### [v0.0.3](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.3)
165197

166-
### [v0.0.2](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.2)
198+
### [v0.0.2](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.2) ⚠️**BROKEN**⚠️
167199

168200
### [v0.0.1](https://github.com/phil1436/MTConnect-ObjectScript/tree/0.0.1)
169201

0 commit comments

Comments
 (0)