ASN1C C# Runtime Library  7.5
Public Member Functions | Properties | List of all members
Asn1PerBitFieldList Class Reference

Public Member Functions

virtual void AddElemName (System.String name, int arrayx)
 
virtual System.Collections.IEnumerator Iterator ()
 
virtual Asn1PerBitField NewBitField (System.String nameSuffix, int bitOffset, int bitCount)
 
virtual void RemoveLastElemName ()
 
void ReplaceLastFieldWithDetail (Asn1PerBitFieldList details)
 
virtual void Reset ()
 

Properties

virtual int BitOffset [set]
 
virtual Asn1PerBitField CurrBitField [get]
 

Detailed Description

This class is used to map all of the bit fields in a PER message. After encoding or decoding is complete, this object can be used to provide a formatted printout of all of the message fields.

Member Function Documentation

◆ AddElemName()

virtual void AddElemName ( System.String  name,
int  arrayx 
)
virtual

This method adds an element name to the current fully qualified name. The fully qualified name is a string of name components separated by dots (ex. a.b.c).

Parameters
nameName component to append to string
arrayxArray index if named item is an element in an array (set to -1 otherwise)

Referenced by Asn1PerTraceHandler.AddElemName().

◆ Iterator()

virtual System.Collections.IEnumerator Iterator ( )
virtual

This method returns an iterator to the encapsulated bit field linked list object.

Returns
System.Collections.IEnumerator value of this list

Referenced by Asn1PerBitFieldPrinter.Print(), and Asn1PerBitFieldList.ReplaceLastFieldWithDetail().

◆ NewBitField()

virtual Asn1PerBitField NewBitField ( System.String  nameSuffix,
int  bitOffset,
int  bitCount 
)
virtual

This method creates a new bit field object with the given properties and appends it to the bit field list. Also sets as current bit field.

Parameters
nameSuffixSuffix to add to fully qualified name for this field (for example, 'length')
bitOffsetOffset to the start of this field in bits from the beginning of the encode buffer.
bitCountNumber of bits in the field.
Returns
Created bit field

Referenced by Asn1PerTraceHandler.NewBitField().

◆ RemoveLastElemName()

virtual void RemoveLastElemName ( )
virtual

This method removes the last element name in the current fully qualified name string. For example, if the current string is 'a.b.c', it will be 'a.b' after calling this method.

Referenced by Asn1PerTraceHandler.RemoveLastElemName().

◆ ReplaceLastFieldWithDetail()

void ReplaceLastFieldWithDetail ( Asn1PerBitFieldList  details)

Replaces the last bit field in this bit trace handler with the fields from the given trace handler, which are assumed to be a breakdown of the last field.

Parameters
detailsfield list to take details from

References Asn1PerBitField.BitOffset, Asn1PerBitFieldList.Iterator(), and Asn1PerBitField.Name.

Referenced by Asn1PerTraceHandler.ReplaceLastFieldWithDetail().

◆ Reset()

virtual void Reset ( )
virtual

This method resets the object.

Property Documentation

◆ BitOffset

virtual int BitOffset
set

Set the current bit offset in the bit field.

Value: The bit offset

Referenced by Asn1PerTraceHandler.SetBitOffset().

◆ CurrBitField

virtual Asn1PerBitField CurrBitField
get

Gets a reference to the current bit field object (i.e. the one that was last created).

Value: Current bit field

Referenced by Asn1PerTraceHandler.SetBitCount().