Asn1TypeIF Interface Reference

Inheritance diagram for Asn1TypeIF:
Asn1Type Asn1ArrayType Asn1BigInteger Asn1BitString Asn1Boolean Asn1CharString Asn1Choice Asn1Enumerated Asn1Integer Asn1Null Asn1ObjectIdentifier Asn1OctetString Asn1OpenExt Asn1Real Asn1SeqOrSet Asn1SeqSetOf Asn1UniversalString Asn1X694OrderElement

List of all members.

Public Member Functions

void Decode (Asn1MderDecodeBuffer buffer)
void Decode (System.Object reader, System.IO.Stream byteStream)
void Decode (System.Object reader, System.String xmlURI)
void Decode (Asn1PerDecodeBuffer buffer)
void Decode (Asn1BerDecodeBuffer buffer, bool explicitTagging, int implicitLength)
void Encode (Asn1PerOutputStream outs)
void Encode (Asn1BerOutputStream outs, bool explicitTagging)
void Encode (Asn1MderOutputStream buffer)
void Encode (Asn1XmlEncoder buffer, System.String elemName, System.String nsPrefix)
void Encode (Asn1XmlEncoder buffer)
void Encode (Asn1XerEncoder buffer, System.String elemName)
void Encode (Asn1XerEncoder buffer)
void Encode (Asn1PerEncodeBuffer buffer)
int Encode (Asn1BerEncodeBuffer buffer, bool explicitTagging)
bool IsOpenType ()
void Print (System.IO.TextWriter outs, System.String varName, int level)
void SetOpenType ()

Detailed Description

This is the base interface for all ASN.1 built-in types.

Member Function Documentation

void Decode ( Asn1MderDecodeBuffer  buffer  ) 

This method decodes this object's data from an MDER encoding. When MDER code has not been generated, classes implementing this interface may simply throw an exception.

Implemented in Asn1OctetString, and Asn1Type.

void Decode ( System.Object  reader,
System.IO.Stream  byteStream 
)

This method declaration is the signature of the standard XML Encoding Rules (XER) Decode method.

Throws an IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

Parameters:
reader XML reader object
byteStream Input byte stream object
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1Type.

void Decode ( System.Object  reader,
System.String  xmlURI 
)

This method declaration is the signature of the standard XML Encoding Rules (XER) Decode method.

Throws an IO exception from the parser, possibly from a byte stream or character stream supplied by the application.

Parameters:
reader XML reader object
xmlURI URI of a source
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1Type.

void Decode ( Asn1PerDecodeBuffer  buffer  ) 

This method declaration is the signature of the standard Packed Encoding Rules (PER) Decode method.

Parameters:
buffer PER Encode message buffer object

Implemented in Asn18BitCharString, Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1Time, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTF8String, and Asn1VarWidthCharString.

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

This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) Decode method.

Parameters:
buffer Decode message buffer object
explicitTagging Flag indicating explicit tag should be parsed from the encoded type.
implicitLength Length of the contents field (only required if explicit is false).

Implemented in Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1GeneralizedTime, Asn1GeneralString, Asn1GraphicString, Asn1IA5String, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectDescriptor, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1PrintableString, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1T61String, Asn1Type, Asn1UniversalString, Asn1UTCTime, Asn1UTF8String, Asn1VideotexString, Asn1VisibleString, and Asn1X694OrderElement.

void Encode ( Asn1PerOutputStream  outs  ) 

This method declaration is the signature of the streaming oriented PER encode method.

Also throws any exception thrown by the Asn1PerOutputStream.

Parameters:
outs PER Output Stream object
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn18BitCharString, Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Integer, Asn1Null, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1Time, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTF8String, Asn1VarWidthCharString, and Asn1X694OrderElement.

void Encode ( Asn1BerOutputStream  outs,
bool  explicitTagging 
)

This method declaration is the signature of the streaming oriented BER encode method.

Throws, Exception thrown by C# System.IO.Stream for I/O error

Parameters:
outs BER Output Stream object
explicitTagging Flag indicating explicit tagging should be done
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Enumerated, Asn1GeneralizedTime, Asn1GeneralString, Asn1GraphicString, Asn1IA5String, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectDescriptor, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1PrintableString, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1T61String, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTCTime, Asn1UTF8String, Asn1VideotexString, Asn1VisibleString, and Asn1X694OrderElement.

void Encode ( Asn1MderOutputStream  buffer  ) 

This method encodes this object's data to an MDER encoding. When MDER code has not been generated, classes implementing this interface may simply throw an exception.

Implemented in Asn1OctetString, and Asn1Type.

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

This method declaration is the signature of the standard XML Encoding as specified in the XML schema standard(asn2xsd).

Also throws any exception thrown by the underlying stream.

Parameters:
buffer XML Encode message buffer object
elemName XML element name of item
nsPrefix Element namespace value
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1Base64BinaryString, Asn1BigInteger, Asn1BitString, Asn1Boolean, Asn1CharString, Asn1Enumerated, Asn1Integer, Asn1Null, Asn1ObjectIdentifier, Asn1OctetString, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1Time, Asn1Type, and Asn1UniversalString.

void Encode ( Asn1XmlEncoder  buffer  ) 

This method declaration is the signature of the standard XML Encoding as specified in the XML schema standard(asn2xsd). This method invokes the generated method with element name and attribute name set to null. This will cause the ASN.1 type name to be used as the top-level element name.

Also throws any exception thrown by the underlying stream.

Parameters:
buffer XML Encode message buffer object
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1OpenExt, Asn1OpenType, and Asn1Type.

void Encode ( Asn1XerEncoder  buffer,
System.String  elemName 
)

This method declaration is the signature of the standard XML Encoding Rules (XER) encode method.

Also throws any exception thrown by the underlying stream.

Parameters:
buffer XER Encode message buffer object
elemName XML element name of item
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1BigInteger, Asn1BitString, Asn1Boolean, Asn1CharString, Asn1Enumerated, Asn1Integer, Asn1Null, Asn1ObjectIdentifier, Asn1OctetString, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1Type, and Asn1UniversalString.

void Encode ( Asn1XerEncoder  buffer  ) 

This method declaration is the signature of the standard XML Encoding Rules (XER) encode method. This method invokes the generated method with element name set to null. This will cause the ASN.1 type name to be used as the top-level element name.

Also throws any exception thrown by the underlying stream.

Parameters:
buffer XER Encode message buffer object
Exceptions:
Asn1Exception Thrown, if operation is failed.

Implemented in Asn1OpenExt, Asn1OpenType, and Asn1Type.

void Encode ( Asn1PerEncodeBuffer  buffer  ) 

This method declaration is the signature of the standard Packed Encoding Rules (PER) encode method.

Parameters:
buffer PER Encode message buffer object

Implemented in Asn18BitCharString, Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1Time, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTF8String, and Asn1VarWidthCharString.

int Encode ( Asn1BerEncodeBuffer  buffer,
bool  explicitTagging 
)

This method declaration is the signature of the standard Basic Encoding Rules (BER) or Distinguished Encoding Rules (DER) encode method.

Parameters:
buffer Encode message buffer object
explicitTagging Flag indicating explicit tag should be added to the encoded type.
Returns:
Length of component or negative status value

Implemented in Asn1BigInteger, Asn1BitString, Asn1BMPString, Asn1Boolean, Asn1ChoiceExt, Asn1Date, Asn1DateTime, Asn1Duration, Asn1Enumerated, Asn1GeneralizedTime, Asn1GeneralString, Asn1GraphicString, Asn1IA5String, Asn1Integer, Asn1Null, Asn1NumericString, Asn1ObjectDescriptor, Asn1ObjectIdentifier, Asn1OctetString, Asn1OID_IRI, Asn1OpenExt, Asn1OpenType, Asn1PrintableString, Asn1Real, Asn1Real10, Asn1RelativeOID, Asn1T61String, Asn1TimeOfDay, Asn1Type, Asn1UniversalString, Asn1UTCTime, Asn1UTF8String, Asn1VideotexString, Asn1VisibleString, and Asn1X694OrderElement.

bool IsOpenType (  ) 

Returns open type mode for XML encoding/decoding.

Returns:
true if open type mode is on.

Implemented in Asn1Type.

void Print ( System.IO.TextWriter  outs,
System.String  varName,
int  level 
)

This method declaration is the signature of the standard print method used to print the contents of the object representing the ASN.1 type.

Parameters:
outs Output print stream
varName Name of the variable being printed
level Indentation level

Implemented in Asn1ArrayType, Asn1Type, and Asn1X694OrderElement.

void SetOpenType (  ) 

Sets open type mode for XML encoding/decoding.

Implemented in Asn1Type.