PASN_Object Class Reference

Base class for ASN encoding/decoding. More...

#include <asner.h>

Inheritance diagram for PASN_Object:

Public Types
enum	TagClass {   UniversalTagClass, ApplicationTagClass, ContextSpecificTagClass, PrivateTagClass,   DefaultTagClass }
enum	UniversalTags {   InvalidUniversalTag, UniversalBoolean, UniversalInteger, UniversalBitString,   UniversalOctetString, UniversalNull, UniversalObjectId, UniversalObjectDescriptor,   UniversalExternalType, UniversalReal, UniversalEnumeration, UniversalEmbeddedPDV,   UniversalSequence = 16, UniversalSet, UniversalNumericString, UniversalPrintableString,   UniversalTeletexString, UniversalVideotexString, UniversalIA5String, UniversalUTCTime,   UniversalGeneralisedTime, UniversalGeneralizedTime = UniversalGeneralisedTime, UniversalGraphicString, UniversalVisibleString,   UniversalGeneralString, UniversalUniversalString, UniversalBMPString = 30 }
enum	ConstraintType { Unconstrained, PartiallyConstrained, FixedConstraint, ExtendableConstraint }
enum	MinimumValueTag { MinimumValue = INT_MIN }
enum	MaximumValueTag { MaximumValue = INT_MAX }
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...

Public Member Functions
virtual PString	GetTypeAsString () const =0
	Return a string giving the type of the object. More...
PINDEX	GetObjectLength () const
virtual PINDEX	GetDataLength () const =0
virtual PBoolean	IsPrimitive () const
virtual PBoolean	Decode (PASN_Stream &)=0
virtual void	Encode (PASN_Stream &) const =0
PBoolean	IsExtendable () const
void	SetExtendable (PBoolean ext=true)
TagClass	GetTagClass () const
unsigned	GetTag () const
virtual void	SetTag (unsigned newTag, TagClass tagClass=DefaultTagClass)
void	SetConstraints (ConstraintType type, int value)
void	SetConstraints (ConstraintType, int lower, MaximumValueTag)
void	SetConstraints (ConstraintType, MinimumValueTag lower, unsigned upper)
void	SetConstraints (ConstraintType, MinimumValueTag lower, MaximumValueTag upper)
void	SetConstraints (ConstraintType type, int lower, unsigned upper)
virtual void	SetConstraintBounds (ConstraintType type, int lower, unsigned upper)
virtual void	SetCharacterSet (ConstraintType ctype, const char *charSet)
virtual void	SetCharacterSet (ConstraintType ctype, unsigned firstChar, unsigned lastChar)
Public Member Functions inherited from PObject
virtual	~PObject ()
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Static Public Member Functions
static PINDEX	GetMaximumArraySize ()
static void	SetMaximumArraySize (PINDEX sz)
static PINDEX	GetMaximumStringSize ()
static void	SetMaximumStringSize (PINDEX sz)
Static Public Member Functions inherited from PObject
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
static const char *	Class ()
	Get the name of the class as a C string. More...

Protected Member Functions
	PASN_Object (unsigned tag, TagClass tagClass, PBoolean extend=false)
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PBoolean	extendable
	PER extension capability. More...
TagClass	tagClass
	BER tag class. More...
unsigned	tag
	ASN object tag. More...

Detailed Description

Base class for ASN encoding/decoding.

Member Enumeration Documentation

ConstraintType

enum PASN_Object::ConstraintType

Enumerator
Unconstrained
PartiallyConstrained
FixedConstraint
ExtendableConstraint

MaximumValueTag

enum PASN_Object::MaximumValueTag

Enumerator
MaximumValue

MinimumValueTag

enum PASN_Object::MinimumValueTag

Enumerator
MinimumValue

TagClass

enum PASN_Object::TagClass

Enumerator
UniversalTagClass
ApplicationTagClass
ContextSpecificTagClass
PrivateTagClass
DefaultTagClass

UniversalTags

enum PASN_Object::UniversalTags

Enumerator
InvalidUniversalTag
UniversalBoolean
UniversalInteger
UniversalBitString
UniversalOctetString
UniversalNull
UniversalObjectId
UniversalObjectDescriptor
UniversalExternalType
UniversalReal
UniversalEnumeration
UniversalEmbeddedPDV
UniversalSequence
UniversalSet
UniversalNumericString
UniversalPrintableString
UniversalTeletexString
UniversalVideotexString
UniversalIA5String
UniversalUTCTime
UniversalGeneralisedTime
UniversalGeneralizedTime
UniversalGraphicString
UniversalVisibleString
UniversalGeneralString
UniversalUniversalString
UniversalBMPString

Constructor & Destructor Documentation

PASN_Object()

PASN_Object::PASN_Object ( unsigned  tag, TagClass  tagClass, PBoolean  extend = false  )

protected

Referenced by SetConstraints().

Member Function Documentation

Decode()

virtual PBoolean PASN_Object::Decode ( PASN_Stream &  )

pure virtual

Implemented in PASN_Array, PASN_Sequence, PASN_Choice, PASN_BMPString, PASN_ConstrainedString, PASN_OctetString, PASN_BitString, PASN_ObjectId, PASN_Real, PASN_Enumeration, PSNMP_Message, PASN_Integer, PASN_Boolean, PASN_Null, PSNMP_Trap_PDU, PSNMP_PDU, PSNMP_VarBind, and PSNMP_PDUs.

Referenced by PASN_Enumeration::GetMaximum(), PASN_BitString::GetSize(), PASN_OctetString::GetSize(), PASN_ObjectId::GetValue(), IsPrimitive(), PASN_Choice::IsValid(), PASN_ConstrainedString::operator[](), PASN_Sequence::operator[](), PASN_Array::RemoveAll(), PASN_Boolean::SetValue(), PASN_Integer::SetValue(), PASN_Real::SetValue(), and PASN_BMPString::SetValueRaw().

Encode()

virtual void PASN_Object::Encode ( PASN_Stream &  ) const

pure virtual

Implemented in PASN_Array, PASN_Sequence, PASN_Choice, PASN_BMPString, PASN_ConstrainedString, PASN_OctetString, PASN_BitString, PASN_ObjectId, PASN_Real, PASN_Enumeration, PSNMP_Message, PASN_Integer, PASN_Boolean, PASN_Null, PSNMP_Trap_PDU, PSNMP_PDU, PSNMP_VarBind, and PSNMP_PDUs.

Referenced by PASN_Enumeration::GetMaximum(), PASN_BitString::GetSize(), PASN_OctetString::GetSize(), PASN_ObjectId::GetValue(), IsPrimitive(), PASN_Choice::IsValid(), PASN_ConstrainedString::operator[](), PASN_Sequence::operator[](), PASN_Array::RemoveAll(), PASN_Boolean::SetValue(), PASN_Integer::SetValue(), PASN_Real::SetValue(), and PASN_BMPString::SetValueRaw().

GetDataLength()

virtual PINDEX PASN_Object::GetDataLength ( ) const

pure virtual

Implemented in PASN_Array, PASN_Sequence, PASN_Choice, PASN_BMPString, PASN_ConstrainedString, PASN_OctetString, PASN_BitString, PASN_ObjectId, PASN_Real, PASN_Enumeration, PSNMP_Message, PASN_Integer, PASN_Boolean, PASN_Null, PSNMP_Trap_PDU, PSNMP_PDU, and PSNMP_VarBind.

Referenced by PASN_Enumeration::GetMaximum(), PASN_BitString::GetSize(), PASN_OctetString::GetSize(), PASN_ObjectId::GetValue(), PASN_Choice::IsValid(), PASN_ConstrainedString::operator[](), PASN_Sequence::operator[](), PASN_Array::RemoveAll(), PASN_Boolean::SetValue(), PASN_Integer::SetValue(), PASN_Real::SetValue(), and PASN_BMPString::SetValueRaw().

GetMaximumArraySize()

static PINDEX PASN_Object::GetMaximumArraySize ( )

static

Referenced by SetConstraints().

GetMaximumStringSize()

static PINDEX PASN_Object::GetMaximumStringSize ( )

static

Referenced by SetConstraints().

GetObjectLength()

PINDEX PASN_Object::GetObjectLength

(

)

const

GetTag()

unsigned PASN_Object::GetTag ( ) const

inline

References DefaultTagClass, SetTag(), tag, and tagClass.

GetTagClass()

TagClass PASN_Object::GetTagClass ( ) const

inline

References tagClass.

GetTypeAsString()

virtual PString PASN_Object::GetTypeAsString ( ) const

pure virtual

Return a string giving the type of the object.

Implemented in PASN_Array, PASN_Set, PASN_Sequence, PASN_Choice, PASN_BMPString, PASN_OctetString, PASN_BitString, PASN_ObjectId, PASN_Real, PASN_Enumeration, PASN_Integer, PASN_Boolean, and PASN_Null.

Referenced by PASN_Enumeration::GetMaximum(), PASN_BitString::GetSize(), PASN_OctetString::GetSize(), PASN_ObjectId::GetValue(), PASN_Choice::IsValid(), PASN_Sequence::operator[](), PASN_Array::RemoveAll(), PASN_Boolean::SetValue(), PASN_Integer::SetValue(), PASN_Real::SetValue(), and PASN_BMPString::SetValueRaw().

IsExtendable()

PBoolean PASN_Object::IsExtendable ( ) const

inline

References extendable.

IsPrimitive()

virtual PBoolean PASN_Object::IsPrimitive ( ) const

inlinevirtual

Reimplemented in PASN_Array, PASN_Sequence, and PASN_Choice.

References Decode(), and Encode().

Referenced by PASN_Choice::IsValid(), PASN_Sequence::operator[](), and PASN_Array::RemoveAll().

SetCharacterSet() [1/2]

virtual void PASN_Object::SetCharacterSet ( ConstraintType  ctype, const char *  charSet  )

virtual

Reimplemented in PASN_BMPString, and PASN_ConstrainedString.

Referenced by PASN_ConstrainedString::operator[](), SetConstraints(), and PASN_BMPString::SetValueRaw().

SetCharacterSet() [2/2]

virtual void PASN_Object::SetCharacterSet ( ConstraintType  ctype, unsigned  firstChar, unsigned  lastChar  )

virtual

Reimplemented in PASN_BMPString, and PASN_ConstrainedString.

SetConstraintBounds()

virtual void PASN_Object::SetConstraintBounds ( ConstraintType  type, int  lower, unsigned  upper  )

virtual

Reimplemented in PASN_Array, PASN_ConstrainedString, PASN_OctetString, PASN_BitString, PASN_Integer, and PASN_ConstrainedObject.

Referenced by PASN_BitString::GetSize(), PASN_OctetString::GetSize(), PASN_ConstrainedObject::GetUpperLimit(), PASN_ConstrainedString::operator[](), PASN_Array::RemoveAll(), SetConstraints(), and PASN_Integer::SetValue().

SetConstraints() [1/5]

void PASN_Object::SetConstraints ( ConstraintType  type, int  value  )

inline

References SetConstraintBounds().

SetConstraints() [2/5]

void PASN_Object::SetConstraints ( ConstraintType  , int  lower, MaximumValueTag    )

inline

References PartiallyConstrained, and SetConstraintBounds().

SetConstraints() [3/5]

void PASN_Object::SetConstraints ( ConstraintType  , MinimumValueTag  lower, unsigned  upper  )

inline

References PartiallyConstrained, and SetConstraintBounds().

SetConstraints() [4/5]

void PASN_Object::SetConstraints ( ConstraintType  , MinimumValueTag  lower, MaximumValueTag  upper  )

inline

References PartiallyConstrained, and SetConstraintBounds().

SetConstraints() [5/5]

void PASN_Object::SetConstraints ( ConstraintType  type, int  lower, unsigned  upper  )

inline

References GetMaximumArraySize(), GetMaximumStringSize(), PASN_Object(), SetCharacterSet(), SetConstraintBounds(), SetMaximumArraySize(), SetMaximumStringSize(), tag, and tagClass.

SetExtendable()

void PASN_Object::SetExtendable ( PBoolean  ext = true )

inline

References extendable.

SetMaximumArraySize()

static void PASN_Object::SetMaximumArraySize ( PINDEX  sz )

static

Referenced by SetConstraints().

SetMaximumStringSize()

static void PASN_Object::SetMaximumStringSize ( PINDEX  sz )

static

Referenced by SetConstraints().

SetTag()

virtual void PASN_Object::SetTag ( unsigned  newTag, TagClass  tagClass = DefaultTagClass  )

virtual

Reimplemented in PASN_Choice.

Referenced by GetTag().

Member Data Documentation

extendable

PBoolean PASN_Object::extendable

protected

PER extension capability.

Referenced by IsExtendable(), and SetExtendable().

tag

unsigned PASN_Object::tag

protected

ASN object tag.

Referenced by GetTag(), PASN_ConstrainedObject::GetUpperLimit(), PASN_Choice::IsValid(), PASN_ConstrainedString::operator[](), PASN_Array::RemoveAll(), and SetConstraints().

tagClass

TagClass PASN_Object::tagClass

protected

BER tag class.

Referenced by GetTag(), GetTagClass(), PASN_ConstrainedObject::GetUpperLimit(), PASN_Choice::IsValid(), PASN_ConstrainedString::operator[](), PASN_Array::RemoveAll(), and SetConstraints().

---

The documentation for this class was generated from the following file:

• asner.h