ASN1C C# Runtime Library  7.7
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
Asn1BMPString Class Reference
Inheritance diagram for Asn1BMPString:
Asn1CharString Asn1Type Asn1TypeIF

Public Member Functions

 Asn1BMPString ()
 
 Asn1BMPString (System.String data)
 
override void Decode (Asn1BerDecodeBuffer buffer, bool explicitTagging, int implicitLength)
 
override void Decode (Asn1PerDecodeBuffer buffer)
 
virtual void Decode (Asn1PerDecodeBuffer buffer, Asn1CharSet charSet)
 
virtual void Decode (Asn1PerDecodeBuffer buffer, Asn1CharSet charSet, long lower, long upper)
 
override void Decode (Asn1OerDecodeBuffer buffer)
 
void Decode (Asn1OerDecodeBuffer buffer, int length)
 
override int Encode (Asn1BerEncodeBuffer buffer, bool explicitTagging)
 
override void Encode (Asn1PerEncodeBuffer buffer)
 
virtual void Encode (Asn1PerEncodeBuffer buffer, Asn1CharSet charSet)
 
virtual void Encode (Asn1PerEncodeBuffer buffer, Asn1CharSet charSet, long lower, long upper)
 
override void Encode (Asn1OerEncodeBuffer buffer)
 
virtual void Encode (Asn1OerEncodeBuffer buffer, bool withLength)
 
override void Encode (Asn1BerOutputStream outs, bool explicitTagging)
 
override void Encode (Asn1PerOutputStream outs)
 
virtual void Encode (Asn1PerOutputStream outs, Asn1CharSet charSet)
 
virtual void Encode (Asn1PerOutputStream outs, Asn1CharSet charSet, long lower, long upper)
 
- Public Member Functions inherited from Asn1CharString
void DecodeByteToChar (Asn1OerDecodeBuffer buffer, int length)
 
virtual void DecodeXER (System.String buffer, System.String attrs)
 
override void DecodeXML (System.String buffer, System.String attrs)
 
override void Encode (Asn1XerEncoder buffer, System.String elemName)
 
override void Encode (Asn1XmlEncoder buffer, System.String elemName, System.String nsPrefix)
 
bool Equals (System.String value)
 
override bool Equals (System.Object value)
 
override int GetHashCode ()
 
override System.String ToString ()
 
bool validate (Asn1CharSet charSet)
 
- Public Member Functions inherited from Asn1Type
void _SetKey (byte[] rtkey)
 
virtual void Decode (Asn1BerDecodeBuffer buffer)
 
virtual void Decode (System.Object reader, System.String xmlURI)
 
virtual void Decode (System.Object reader, System.IO.Stream byteStream)
 
virtual void Decode (Asn1MderDecodeBuffer buffer)
 
virtual void DecodeXML (String buffer, String attrs)
 
virtual int Encode (Asn1BerEncodeBuffer buffer)
 
virtual void Encode (Asn1XerEncoder buffer)
 
virtual void Encode (Asn1XmlEncoder buffer)
 
virtual void Encode (Asn1XmlEncodeBuffer buffer)
 
virtual void Encode (Asn1MderOutputStream buffer)
 
virtual void Encode (Asn1MderOutputStream buffer, bool useCachedLength)
 
virtual void Encode (Asn1CerOutputStream outs, bool explicitTagging)
 
void EncodeAsOpenType (Asn1OerEncodeBuffer buffer)
 
virtual void EncodeAttribute (Asn1XmlEncoder buffer, System.String attrName)
 
virtual bool Equals (Asn1Type obj)
 
String GetNonParameterizedTypeName ()
 
virtual void Indent (System.IO.TextWriter outs, int level)
 
virtual bool IsOpenType ()
 
virtual bool MatchTypeName (System.String typeName)
 
virtual void Pdiag (System.String s)
 
virtual void Print (System.IO.TextWriter outs, System.String varName, int level)
 
virtual void Print (System.String varName)
 
void SetNonParameterizedTypeName (String value)
 
virtual void SetOpenType ()
 

Public Attributes

const int BITSPERCHAR = 16
 
- Public Attributes inherited from Asn1CharString
System.String mValue
 
- Public Attributes inherited from Asn1Type
const short BIT_STRING = 3
 
const short BMPString = 30
 
const short BOOLEAN = 1
 
const short DATE = 31
 
const short ENUMERATED = 10
 
const short EOC = 0
 
const short EXTERNAL = 8
 
const short GeneralString = 27
 
const short GeneralTime = 24
 
const short GraphicString = 25
 
const short IA5String = 22
 
const short INTEGER = 2
 
const short NULL = 5
 
const short NumericString = 18
 
const short OBJECT_IDENTIFIER = 6
 
const short ObjectDescriptor = 7
 
const short OCTET_STRING = 4
 
const short OpenType = 99
 
const short PrintableString = 19
 
const short REAL = 9
 
const short RELATIVE_OID_IRI = 36
 
const short RelativeOID = 13
 
const short SEQUENCE = 16
 
const short SET = 17
 
const short T61String = TeletexString
 
const short TeletexString = 20
 
const short TIME = 14
 
const short UniversalString = 28
 
const short UTCTime = 23
 
const short UTF8String = 12
 
const short VideotexString = 21
 
const short VisibleString = 26
 

Static Public Attributes

static new readonly Asn1Tag _TAG
 
- Static Public Attributes inherited from Asn1Type
static readonly Asn1Tag _TAG
 

Additional Inherited Members

- Static Public Member Functions inherited from Asn1Type
static void _SetKey2 (byte[] rtkey)
 
static void _SetLicLocation (String path)
 
static Asn1Type Decode (Asn1BerDecodeBuffer buffer, Asn1OpenTypeField openTypeField, bool explicitTag, int implicitLength)
 
static Asn1Type Decode (Asn1OerDecodeBuffer buffer, Asn1OpenTypeField openTypeField)
 
static Asn1Type Decode (Asn1PerDecodeBuffer buffer, Asn1OpenTypeField openTypeField)
 
static System.String GetTypeName (short typeCode)
 
- Static Protected Member Functions inherited from Asn1CharString
static void DecodeInternal (Asn1PerDecodeBuffer buffer, System.Text.StringBuilder stringBuffer, int abpc, int ubpc, Asn1CharSet charSet)
 
static int Encode (Asn1BerEncodeBuffer buffer, String val, bool explicitTagging, Asn1Tag tag)
 
- Properties inherited from Asn1CharString
override int Length [get]
 
- Properties inherited from Asn1Type
virtual String AsnTypeName [get]
 
virtual int Length [get]
 

Detailed Description

This is a container class for holding the components of an ASN.1 BMP string value.

Constructor & Destructor Documentation

◆ Asn1BMPString() [1/2]

The default constructor creates an empty string object.

◆ Asn1BMPString() [2/2]

Asn1BMPString ( System.String  data)

This version of the constructor can be used to set the string mValue member variable to the given string value.

Parameters
datastring representation of BMPString

References Asn1DecodeBuffer.Read().

Member Function Documentation

◆ Decode() [1/6]

override void Decode ( Asn1BerDecodeBuffer  buffer,
bool  explicitTagging,
int  implicitLength 
)
virtual

This method decodes an ASN.1 BMP string value including the UNIVERSAL tag value and length if explicit tagging is specified. This string type uses 16-bit characters.

Parameters
bufferDecode message buffer object
explicitTaggingFlag indicating element is explicitly tagged
implicitLengthLength of contents if implicit

Reimplemented from Asn1Type.

References Asn1OctetString._TAG, Asn1Type.BMPString, Asn1Tag.Constructed, Asn1Tag.EOC, Asn1BerDecodeContext.Expired(), Asn1Status.INDEFLEN, Asn1BerDecodeBuffer.LastTag, and Asn1MessageBufferBase.TypeCode.

◆ Decode() [2/6]

override void Decode ( Asn1PerDecodeBuffer  buffer)
virtual

This method decodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public mValue member variable in the Asn1CharString base class.

Parameters
bufferDecode message buffer object

Reimplemented from Asn1Type.

◆ Decode() [3/6]

virtual void Decode ( Asn1PerDecodeBuffer  buffer,
Asn1CharSet  charSet 
)
virtual

This method decodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but allows a permitted alphabet character set to be specified. Decoded characters are assigned as-is to the output string. The decoded result is stored in the public mValue member variable in the Asn1CharString base class.

Parameters
bufferDecode message buffer object
charSetObject representing permitted alphabet constraint character set (optional)

◆ Decode() [4/6]

virtual void Decode ( Asn1PerDecodeBuffer  buffer,
Asn1CharSet  charSet,
long  lower,
long  upper 
)
virtual

This overloaded version of the Decode method decodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes both a size constraint and permitted alphabet constraint are present.

The decoded result is stored in the public mValue member variable in the Asn1CharString base class.

Parameters
bufferDecode message buffer object
charSetObject representing permitted alphabet constraint character set (optional)
lowerEffective size constraint lower bound
upperEffective size constraint upper bound

◆ Decode() [5/6]

override void Decode ( Asn1OerDecodeBuffer  buffer)
virtual

Decode the value in accordance with OER.

This class's implementation decodes the string with a length determinant. If a subclass should be decoded without a length determinant, it should override this method to invoke decode(buffer, length). Subclasses may override this to add constraint checks after invoking this method to decode the string.

Reimplemented from Asn1Type.

◆ Decode() [6/6]

void Decode ( Asn1OerDecodeBuffer  buffer,
int  length 
)

Decode the value in accordance with OER.

This class's implementation decodes a string of the given length. This method is non-virtual as I don't see any reason for overriding it.

Parameters
lengthLength of string to decode, in characters.

References Asn1DecodeBuffer.Read().

◆ Encode() [1/10]

override int Encode ( Asn1BerEncodeBuffer  buffer,
bool  explicitTagging 
)
virtual

This method encodes an ASN.1 string type. The UNIVERSAL tag value and length is also encoded if explicit tagging is specified.

Parameters
bufferEncode message buffer object
explicitTaggingFlag indicating explicit tagging should be done
Returns
Length in octets of encoded component

Reimplemented from Asn1Type.

References Asn1EncodeBuffer.Copy(), and Asn1BerEncodeBuffer.EncodeTagAndLength().

◆ Encode() [2/10]

override void Encode ( Asn1PerEncodeBuffer  buffer)
virtual

This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints.

The value to encode is stored in the public mValue member variable in the Asn1CharString base class.

Parameters
bufferEncode message buffer object

Reimplemented from Asn1Type.

◆ Encode() [3/10]

virtual void Encode ( Asn1PerEncodeBuffer  buffer,
Asn1CharSet  charSet 
)
virtual

This method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but does allow a permitted alphabet character set to be specified.

The value to encode is stored in the public mValue member variable in the Asn1CharString base class.

Parameters
bufferEncode message buffer object
charSetObject representing permitted alphabet constraint character set (optional)

◆ Encode() [4/10]

virtual void Encode ( Asn1PerEncodeBuffer  buffer,
Asn1CharSet  charSet,
long  lower,
long  upper 
)
virtual

This overloaded version of the encode method encodes an ASN.1 character string value in accordance with the packed encoding rules (PER). This version of the method assumes both a size constraint and permitted alphabet constraint are present.

The value to encode is stored in the public mValue member variable.

Parameters
bufferEncode message buffer object
charSetObject representing the permitted alphabet constraint character set
lowerEffective size constraint lower bound
upperEffective size constraint upper bound

References Asn1OerDecodeBuffer.DecodeLength().

◆ Encode() [5/10]

override void Encode ( Asn1OerEncodeBuffer  buffer)
virtual

Encode the value in accordance with OER.

This class's implementation invokes encode(buffer, true) to encode the string with a length determinant. If a subclass should be encoded without a length determinant, it should override this to invoke encode(buffer, false).

Reimplemented from Asn1Type.

◆ Encode() [6/10]

virtual void Encode ( Asn1OerEncodeBuffer  buffer,
bool  withLength 
)
virtual

Encode the string, with or without a length determinant.

Subclasses may override this (e.g. to add constraint checks) and invoke this method to perform the encoding.

Parameters
withLengthtrue if a length determinant should be encoded.

References Asn1EncodeBuffer.Copy(), Asn1BerOutputStream.EncodeBMPString(), and Asn1OerEncodeBuffer.EncodeLength().

◆ Encode() [7/10]

override void Encode ( Asn1BerOutputStream  outs,
bool  explicitTagging 
)
virtual

This method encodes and writes to the stream an ASN.1 BMP string including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER).

Throws, exception thrown by the underlying System.IO.Stream object.

Parameters
outsBER Output Stream object
explicitTaggingFlag indicating explicit tagging should be done
Exceptions
Asn1ExceptionThrown, if operation is failed.

Reimplemented from Asn1Type.

◆ Encode() [8/10]

override void Encode ( Asn1PerOutputStream  outs)
virtual

This method encodes an ASN.1 BMP string value in accordance with the packed encoding rules (PER). This version of the method assumes no permitted alphabet or size constraints.

The value to encode is stored in the public mValue member variable in the Asn1CharString base class.

Also throws any exception thrown by the underlying Asn1PerOutputStream.

Parameters
outsPER Output Stream object
Exceptions
Asn1ExceptionThrown, if operation is failed.

Reimplemented from Asn1Type.

◆ Encode() [9/10]

virtual void Encode ( Asn1PerOutputStream  outs,
Asn1CharSet  charSet 
)
virtual

This method encodes an ASN.1 BMP string value in accordance with the packed encoding rules (PER). This version of the method assumes no size constraints but does allow a permitted alphabet character set to be specified.

The value to encode is stored in the public mValue member variable in the Asn1CharString base class.

Also throws any exception thrown by the underlying Asn1PerOutputStream.

Parameters
outsPER Output Stream object
charSetObject representing permitted alphabet constraint character set (optional)
Exceptions
Asn1ExceptionThrown, if operation is failed.

◆ Encode() [10/10]

virtual void Encode ( Asn1PerOutputStream  outs,
Asn1CharSet  charSet,
long  lower,
long  upper 
)
virtual

This overloaded version of the encode method encodes an ASN.1 BMP string value in accordance with the packed encoding rules (PER). This version of the method assumes both a size constraint and permitted alphabet constraint are present.

The value to encode is stored in the public mValue member variable.

Also throws any exception thrown by the underlying Asn1PerOutputStream.

Parameters
outsPER Output Stream object
charSetObject representing the permitted alphabet constraint character set (optional)
lowerEffective size constraint lower bound
upperEffective size constraint upper bound
Exceptions
Asn1ExceptionThrown, if operation is failed.

References Asn1Type.BMPString, Asn1Tag.PRIM, and Asn1Tag.UNIV.

Member Data Documentation

◆ _TAG

new readonly Asn1Tag _TAG
static

The _TAG constant describes the universal tag for this data type (UNIVERSAL 30).

Referenced by Asn1CerOutputStream.EncodeBMPString().

◆ BITSPERCHAR

const int BITSPERCHAR = 16

The BITSPERCHAR constant specifies the number of bits per character for PER (aligned or unaligned).