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

Public Member Functions

 Asn1Boolean ()
 
 Asn1Boolean (bool value_)
 
override void Decode (Asn1BerDecodeBuffer buffer, bool explicitTagging, int implicitLength)
 
override void Decode (Asn1PerDecodeBuffer buffer)
 
override void Decode (Asn1OerDecodeBuffer buffer)
 
virtual void DecodeXER (System.String buffer, System.String attrs)
 
override void DecodeXML (System.String buffer, System.String attrs)
 
override int Encode (Asn1BerEncodeBuffer buffer, bool explicitTagging)
 
override void Encode (Asn1PerEncodeBuffer buffer)
 
override void Encode (Asn1OerEncodeBuffer buffer)
 
override void Encode (Asn1XerEncoder buffer, System.String elemName)
 
virtual void Encode (Asn1XerEncodeBuffer buffer)
 
override void Encode (Asn1XmlEncoder buffer, System.String elemName, System.String nsPrefix)
 
void Encode (Asn1XmlEncoder buffer, String elemName, String nsPrefix, bool asText)
 
override void Encode (Asn1BerOutputStream outs, bool explicitTagging)
 
override void Encode (Asn1PerOutputStream outs)
 
override void EncodeAttribute (Asn1XmlEncoder buffer, System.String attrName)
 
virtual bool Equals (bool value)
 
override bool Equals (System.Object value)
 
override int GetHashCode ()
 
override System.String ToString ()
 
- 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 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 ()
 

Static Public Member Functions

static void setTrueEncodedByte (byte b)
 
- 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)
 

Public Attributes

bool 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 readonly Asn1Boolean FALSE_VALUE = new Asn1Boolean(false)
 
static readonly Asn1Boolean TRUE_VALUE = new Asn1Boolean(true)
 
- Static Public Attributes inherited from Asn1Type
static readonly Asn1Tag _TAG
 

Additional Inherited Members

- Properties inherited from Asn1Type
virtual String AsnTypeName [get]
 
virtual int Length [get]
 

Detailed Description

This class represents the ASN.1 BOOLEAN built-in type.

Constructor & Destructor Documentation

◆ Asn1Boolean() [1/2]

The default constructor sets the boolean value to false.

◆ Asn1Boolean() [2/2]

Asn1Boolean ( bool  value_)

This constructor creates a boolean object from a boolean value.

Parameters
value_Boolean value

References Asn1Type.BOOLEAN, Asn1DecodeBuffer.Read(), and Asn1MessageBufferBase.TypeCode.

Member Function Documentation

◆ Decode() [1/3]

override void Decode ( Asn1BerDecodeBuffer  buffer,
bool  explicitTagging,
int  implicitLength 
)
virtual
This method decodes an ASN.1 boolean value including the UNIVERSAL
tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER) or the Distinguished Encoding Rules (DER).
The decoded result is stored in the public member mValue
in this object.
Parameters
bufferDecode message buffer object
explicitTaggingFlag indicating element is explicitly tagged
implicitLengthLength of contents if implicit
Returns
Decoded boolean value

Reimplemented from Asn1Type.

◆ Decode() [2/3]

override void Decode ( Asn1PerDecodeBuffer  buffer)
virtual
This method decodes an ASN.1 boolean value using
the Packed Encoding Rules (PER).
The decoded result is stored in the public member mValue
in this object.
Parameters
bufferPER Decode message buffer object

Reimplemented from Asn1Type.

◆ Decode() [3/3]

override void Decode ( Asn1OerDecodeBuffer  buffer)
virtual

Decode BOOLEAN value according to OER.

Reimplemented from Asn1Type.

◆ DecodeXER()

virtual void DecodeXER ( System.String  buffer,
System.String  attrs 
)
virtual

This method decodes an ASN.1 boolean value using the XML encoding rules (XER).

Parameters
bufferString containing data to be decoded
attrsAttributes string from element tag

References Asn1XmlEncoder.EncodeNamedValue().

◆ DecodeXML()

override void DecodeXML ( System.String  buffer,
System.String  attrs 
)

This method decodes an ASN.1 boolean value using the XML Schema encoding rules(asn2xsd).

Parameters
bufferString containing data to be decoded
attrsAttributes string from element tag

◆ Encode() [1/9]

override int Encode ( Asn1BerEncodeBuffer  buffer,
bool  explicitTagging 
)
virtual

This method encodes an ASN.1 boolean value including the UNIVERSAL tag value and length if explicit tagging is specified. This overloaded version uses the Basic Encoding Rules (BER) or the Distinguished Encoding Rules (DER).

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(), Asn1PerDecodeBuffer.DecodeBit(), and Asn1BerEncodeBuffer.EncodeTagAndLength().

◆ Encode() [2/9]

override void Encode ( Asn1PerEncodeBuffer  buffer)
virtual

This method encodes an ASN.1 boolean value using the Packed Encoding Rules (PER).

Parameters
bufferPER Encode message buffer object
Returns
Length of component or negative status value

Reimplemented from Asn1Type.

References Asn1DecodeBitBuffer.DecodeBitsToInt(), Asn1PerEncodeBuffer.EncodeBit(), and Asn1OerDecodeBuffer.GetCanonicalMode().

◆ Encode() [3/9]

override void Encode ( Asn1OerEncodeBuffer  buffer)
virtual

Encode BOOLEAN value according to OER.

Reimplemented from Asn1Type.

References Asn1XerEncoder.EncodeNamedValue().

◆ Encode() [4/9]

override void Encode ( Asn1XerEncoder  buffer,
System.String  elemName 
)
virtual

This method encodes an ASN.1 boolean value using the XML encoding rules (XER).

Parameters
bufferEncode message buffer object
elemNameElement name

Reimplemented from Asn1Type.

◆ Encode() [5/9]

virtual void Encode ( Asn1XerEncodeBuffer  buffer)
virtual

This method encodes an ASN.1 boolean value using the XML encoding rules (XER). This method does not add start and end tags (<tag> and </tag>), only value is encoded (<true/> or <false/>).

Parameters
bufferEncode message buffer object

References Asn1XerEncodeBuffer.EncodeNamedValueElement().

◆ Encode() [6/9]

override void Encode ( Asn1XmlEncoder  buffer,
System.String  elemName,
System.String  nsPrefix 
)
virtual

This method encodes an ASN.1 boolean value according to the Obj-Sys XML encoding rules. It encodes the value as XML text.

Parameters
bufferEncode message buffer object
elemNameElement name for optional surrounding element.
nsPrefixElement namespace prefix value

Reimplemented from Asn1Type.

◆ Encode() [7/9]

void Encode ( Asn1XmlEncoder  buffer,
String  elemName,
String  nsPrefix,
bool  asText 
)

This method encodes an ASN.1 boolean value. It is for use with extended-XER.

Parameters
bufferEncode message buffer object
elemNameElement name for optional surrounding element.
nsPrefixXML element name space prefix
asTextIf true, encode as text. Otherwise, encode as an empty element.

References Asn1XmlEncoder.EncodeEmptyElement(), Asn1XmlEncoder.EncodeEndElement(), Asn1XmlEncoder.EncodeNamedValue(), and Asn1XmlEncoder.EncodeStartElement().

◆ Encode() [8/9]

override void Encode ( Asn1BerOutputStream  outs,
bool  explicitTagging 
)
virtual

This method encodes and writes to the stream an ASN.1 boolean value 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() [9/9]

override void Encode ( Asn1PerOutputStream  outs)
virtual

This method encodes an ASN.1 boolean value using the Packed Encoding Rules (PER).

Also throws any exception thrown by the underlying Asn1PerOutputStream.

Parameters
outsPER Encode message stream object
Exceptions
Asn1ExceptionThrown, if operation is failed.

Reimplemented from Asn1Type.

◆ EncodeAttribute()

override void EncodeAttribute ( Asn1XmlEncoder  buffer,
System.String  attrName 
)
virtual

This method encodes an ASN.1 boolean value using the XML Encoding as specified in the W3C XML schema standard(asn2xsd).

Parameters
bufferEncode message buffer object
attrNameElement name

Reimplemented from Asn1Type.

References Asn1XmlXerEncoder.Copy().

◆ Equals() [1/2]

virtual bool Equals ( bool  value)
virtual

This method compares this boolean value to the given value for equality.

Parameters
valueThe bool value to compare with the current Object.
Returns
true if the specified bool value is equal to the current Object; otherwise, false.

◆ Equals() [2/2]

override bool Equals ( System.Object  value)

This method compares this boolean value to the given value for equality.

Parameters
valueThe Object to compare with the current Object. Object should be instance of Asn1Boolean.
Returns
true if the specified Object is equal to the current Object; otherwise, false.

References Asn1Boolean.mValue.

◆ GetHashCode()

override int GetHashCode ( )

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Returns
A hash code for the current Object.

◆ setTrueEncodedByte()

static void setTrueEncodedByte ( byte  b)
static

This method sets the byte value that represents the boolean value TRUE. If a zero byte (0x00) is passed, the value is transparently set to 0xFF, the valid representation for BER, CER, and DER.

Parameters
bThe byte value to set.

◆ ToString()

override System.String ToString ( )

This method will return a string representation of the boolean value. The format is the ASN.1 value format for this type.

Returns
Stringified representation of the value

References Asn1PerEncodeBuffer.EncodeBit(), Asn1BerOutputStream.EncodeLength(), Asn1BerOutputStream.EncodeTag(), Asn1Tag.PRIM, Asn1Tag.UNIV, and Asn1OutputStream.WriteByte().

Member Data Documentation

◆ _TAG

new readonly Asn1Tag _TAG
static

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

◆ FALSE_VALUE

readonly Asn1Boolean FALSE_VALUE = new Asn1Boolean(false)
static

The FALSE_VALUE constant represents a boolean FALSE value.

◆ mValue

bool mValue

This public member variable is where the boolean value is stored. This is the value that is encoded when one of the encode methods is called. It is also where the decoded result is stored when a Decode method is called.

Referenced by Asn1Boolean.Equals().

◆ TRUE_VALUE

readonly Asn1Boolean TRUE_VALUE = new Asn1Boolean(true)
static

The TRUE_VALUE constant represents a boolean TRUE value.