Class: BmpString
Hierarchy
-
LocalBmpStringValueBlock↳
BmpString
Constructors
constructor
• new BmpString(«destructured»?): BmpString
Parameters
| Name | Type |
|---|---|
«destructured» | LocalSimpleStringBlockParams |
Returns
Overrides
LocalBmpStringValueBlock.constructor
Properties
blockLength
• blockLength: number
Inherited from
LocalBmpStringValueBlock.blockLength
error
• error: string
Inherited from
LocalBmpStringValueBlock.error
idBlock
• idBlock: LocalIdentificationBlock
Inherited from
LocalBmpStringValueBlock.idBlock
lenBlock
• lenBlock: LocalLengthBlock
Inherited from
LocalBmpStringValueBlock.lenBlock
name
• name: string
Inherited from
LocalBmpStringValueBlock.name
optional
• optional: boolean
Inherited from
LocalBmpStringValueBlock.optional
primitiveSchema
• Optional primitiveSchema: BaseBlock<ValueBlock, LocalBaseBlockJson>
Inherited from
LocalBmpStringValueBlock.primitiveSchema
valueBeforeDecodeView
• valueBeforeDecodeView: Uint8Array
Since
3.0.0
Inherited from
LocalBmpStringValueBlock.valueBeforeDecodeView
valueBlock
• valueBlock: LocalSimpleStringValueBlock
Inherited from
LocalBmpStringValueBlock.valueBlock
warnings
• warnings: string[]
Inherited from
LocalBmpStringValueBlock.warnings
NAME
▪ Static NAME: string = "BMPString"
Overrides
LocalBmpStringValueBlock.NAME
Accessors
valueBeforeDecode
• get valueBeforeDecode(): ArrayBuffer
Returns
ArrayBuffer
Deprecated
since version 3.0.0
Inherited from
LocalBmpStringValueBlock.valueBeforeDecode
• set valueBeforeDecode(value): void
Parameters
| Name | Type |
|---|---|
value | ArrayBuffer |
Returns
void
Deprecated
since version 3.0.0
Inherited from
LocalBmpStringValueBlock.valueBeforeDecode
Methods
fromBER
▸ fromBER(inputBuffer, inputOffset, inputLength): number
Parameters
| Name | Type |
|---|---|
inputBuffer | Uint8Array | ArrayBuffer |
inputOffset | number |
inputLength | number |
Returns
number
Inherited from
LocalBmpStringValueBlock.fromBER
fromBuffer
▸ fromBuffer(inputBuffer): void
Parameters
| Name | Type |
|---|---|
inputBuffer | Uint8Array | ArrayBuffer |
Returns
void
Inherited from
LocalBmpStringValueBlock.fromBuffer
fromString
▸ fromString(inputString): void
Parameters
| Name | Type |
|---|---|
inputString | string |
Returns
void
Inherited from
LocalBmpStringValueBlock.fromString
getValue
▸ getValue(): string
String value
Returns
string
Since
3.0.0
Inherited from
LocalBmpStringValueBlock.getValue
isEqual
▸ isEqual(other): other is BmpString
Determines whether two object instances are equal
Parameters
| Name | Type | Description |
|---|---|---|
other | unknown | Object to compare with the current object |
Returns
other is BmpString
Inherited from
LocalBmpStringValueBlock.isEqual
onAsciiEncoding
▸ onAsciiEncoding(): string
Returns
string
Inherited from
LocalBmpStringValueBlock.onAsciiEncoding
setValue
▸ setValue(value): void
String value
Parameters
| Name | Type | Description |
|---|---|---|
value | string | String value |
Returns
void
Since
3.0.0
Inherited from
LocalBmpStringValueBlock.setValue
toBER
▸ toBER(sizeOnly?, writer?): ArrayBuffer
Parameters
| Name | Type |
|---|---|
sizeOnly? | boolean |
writer? | ViewWriter |
Returns
ArrayBuffer
Inherited from
LocalBmpStringValueBlock.toBER
toJSON
▸ toJSON(): BaseBlockJson<LocalStringValueBlockJson>
Returns
BaseBlockJson<LocalStringValueBlockJson>
Inherited from
LocalBmpStringValueBlock.toJSON
toString
▸ toString(encoding?): string
Parameters
| Name | Type | Default value |
|---|---|---|
encoding | StringEncoding | "ascii" |
Returns
string
Inherited from
LocalBmpStringValueBlock.toString
blockName
▸ blockName(): string
Aux function, need to get a block name. Need to have it here for inheritance
Returns
string
Returns name of the block
Inherited from
LocalBmpStringValueBlock.blockName