AltEncoding class | QSYS API Reference Guide
Estimated reading time: 6 minutes
Represents a custom encoding that extends the base Encoding class, providing additional functionality for transforming data.
Namespace: ASNA.DataGate.DataLink.Text Assembly: ASNA.QSys.DataGate.Client.dll
Inheritance: Object –> Encoding
Constructors
| Name | Description |
|---|---|
| AltEncoding() | Initializes a new instance of the class with default encoder and decoder properties. |
AltEncoding()
Initializes a new instance of the class with default encoder and decoder properties.
AltEncoding()
Properties
| Type | Name | Description |
|---|---|---|
| IEnumerable<AltEncodingInfo> | AvailableEncodings | Gets a list of all available AltEncoding objects. |
| ITransformProperties | DecoderDefaultProps | Gets or sets the default properties for the decoder. |
| ITransformProperties | EncoderDefaultProps | Gets or sets the default properties for the encoder. |
Methods
| Signature | Description |
|---|---|
| DictionaryFromITransformProps(ITransformProperties) | Converts the given ITransformProperties object into a dictionary. |
| Equal(ITransformProperties, ITransformProperties) | Compares two ITransformProperties objects for equality. |
| GetAltDecoder(ITransformProperties) | Returns an AltDecoder object for this AltEncoding, using the specified properties. |
| GetAltEncoder(ITransformProperties) | Returns an AltEncoder object for this AltEncoding, using the specified properties. |
| GetAltEncoding(String) | Returns an AltEncoding object for the specified name. |
| GetAltEncodingInfo() | Gets information about the current AltEncoding instance. |
| GetDecoder() | Returns an AltDecoder object for this AltEncoding, using the default properties. |
| GetDecoderImpl() | When overridden in a derived class, returns an AltDecoder object for this AltEncoding. |
| GetEncoder() | Returns an AltEncoder object for this AltEncoding, using the default properties. |
| GetEncoderImpl() | When overridden in a derived class, returns an AltEncoder object for this AltEncoding. |
| TransformPropertiesFromDictionary(Dictionary<String, Object>) | Converts the given dictionary into an ITransformProperties object. |
| TransformPropertiesFromStream(BinaryReader) | When overridden in a derived class, reads the given BinaryReader stream and converts it into an ITransformProperties object. |
| TransformPropertiesToStream(ITransformProperties, BinaryWriter) | When overridden in a derived class, writes the given ITransformProperties object to the specified BinaryWriter stream. |
Dictionary<string, object> DictionaryFromITransformProps(ITransformProperties props)
Converts the given ITransformProperties object into a dictionary.
Dictionary<string, object> DictionaryFromITransformProps(ITransformProperties props)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ITransformProperties | props | The ITransformProperties object to convert. |
Returns
| Type | Description |
|---|---|
| Dictionary`2 | A dictionary representing the properties of the given ITransformProperties object. |
bool Equal(ITransformProperties lhs, ITransformProperties rhs)
Compares two ITransformProperties objects for equality.
bool Equal(ITransformProperties lhs, ITransformProperties rhs)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ITransformProperties | lhs | The first ITransformProperties object to compare. |
| ITransformProperties | rhs | The second ITransformProperties object to compare. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the two ITransformProperties objects are equal; otherwise, false. |
AltDecoder GetAltDecoder(ITransformProperties decProps)
Returns an AltDecoder object for this AltEncoding, using the specified properties.
AltDecoder GetAltDecoder(ITransformProperties decProps)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ITransformProperties | decProps | The properties to use for the AltDecoder. If null, the default properties are used. |
Returns
| Type | Description |
|---|---|
| AltDecoder | An AltDecoder object for this AltEncoding, using the specified properties. |
AltEncoder GetAltEncoder(ITransformProperties encProps)
Returns an AltEncoder object for this AltEncoding, using the specified properties.
AltEncoder GetAltEncoder(ITransformProperties encProps)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ITransformProperties | encProps | The properties to use for the AltEncoder. If null, the default properties are used. |
Returns
| Type | Description |
|---|---|
| AltEncoder | An AltEncoder object for this AltEncoding, using the specified properties. |
AltEncoding GetAltEncoding(string name)
Returns an AltEncoding object for the specified name.
AltEncoding GetAltEncoding(string name)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | name | The name for which to get an AltEncoding. |
Returns
| Type | Description |
|---|---|
| AltEncoding | An AltEncoding object for the specified name. |
AltEncodingInfo GetAltEncodingInfo()
Gets information about the current AltEncoding instance.
AltEncodingInfo GetAltEncodingInfo()
Decoder GetDecoder()
Returns an AltDecoder object for this AltEncoding, using the default properties.
Decoder GetDecoder()
AltDecoder GetDecoderImpl()
When overridden in a derived class, returns an AltDecoder object for this AltEncoding.
AltDecoder GetDecoderImpl()
Encoder GetEncoder()
Returns an AltEncoder object for this AltEncoding, using the default properties.
Encoder GetEncoder()
AltEncoder GetEncoderImpl()
When overridden in a derived class, returns an AltEncoder object for this AltEncoding.
AltEncoder GetEncoderImpl()
ITransformProperties TransformPropertiesFromDictionary(Dictionary<string, object> dict)
Converts the given dictionary into an ITransformProperties object.
ITransformProperties TransformPropertiesFromDictionary(Dictionary<string, object> dict)
ITransformProperties TransformPropertiesFromStream(BinaryReader br)
When overridden in a derived class, reads the given BinaryReader stream and converts it into an ITransformProperties object.
ITransformProperties TransformPropertiesFromStream(BinaryReader br)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| BinaryReader | br | The BinaryReader stream to read from. |
Returns
| Type | Description |
|---|---|
| ITransformProperties | An ITransformProperties object representing the properties read from the stream. |
void TransformPropertiesToStream(ITransformProperties t, BinaryWriter bw)
When overridden in a derived class, writes the given ITransformProperties object to the specified BinaryWriter stream.
void TransformPropertiesToStream(ITransformProperties t, BinaryWriter bw)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| ITransformProperties | t | The ITransformProperties object to write to the stream. |
| BinaryWriter | bw | The BinaryWriter stream to write to. |