PASN_Enumeration Class Reference

Class for ASN Enumerated type. More...

#include <asner.h>

Inheritance diagram for PASN_Enumeration:

Public Member Functions
	PASN_Enumeration (unsigned val=0)
	PASN_Enumeration (unsigned tag, TagClass tagClass, unsigned nEnums=P_MAX_INDEX, PBoolean extendable=false, unsigned val=0)
	PASN_Enumeration (unsigned tag, TagClass tagClass, unsigned nEnums, PBoolean extendable, const PASN_Names *nameSpec, unsigned namesCnt, unsigned val=0)
PASN_Enumeration &	operator= (unsigned v)
	operator unsigned () const
unsigned	GetValue () const
void	SetValue (unsigned v)
unsigned	GetMaximum () const
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank.
virtual PObject *	Clone () const
	Create a copy of the class on the heap.
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream.
virtual PString	GetTypeAsString () const
	Return a string giving the type of the object.
virtual PINDEX	GetDataLength () const
virtual PBoolean	Decode (PASN_Stream &)
virtual void	Encode (PASN_Stream &) const
PBoolean	DecodePER (PPER_Stream &strm)
void	EncodePER (PPER_Stream &strm) const
virtual PBoolean	DecodeXER (PXER_Stream &strm)
virtual void	EncodeXER (PXER_Stream &strm) const
PINDEX	GetValueByName (PString name) const
Public Member Functions inherited from PASN_Object
PINDEX	GetObjectLength () const
virtual PBoolean	IsPrimitive () const
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 PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class.
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects.
bool	operator== (const PObject &obj) const
	Compare the two objects.
bool	operator!= (const PObject &obj) const
	Compare the two objects.
bool	operator< (const PObject &obj) const
	Compare the two objects.
bool	operator> (const PObject &obj) const
	Compare the two objects.
bool	operator<= (const PObject &obj) const
	Compare the two objects.
bool	operator>= (const PObject &obj) const
	Compare the two objects.
virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance.
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.
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream.

Protected Attributes
unsigned	maxEnumValue
unsigned	value
const PASN_Names *	names
unsigned	namesCount
Protected Attributes inherited from PASN_Object
PBoolean	extendable
	PER extension capability.
TagClass	tagClass
	BER tag class.
unsigned	tag
	ASN object tag.

Additional Inherited Members
Public Types inherited from PASN_Object
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 }
Static Public Member Functions inherited from PASN_Object
static PINDEX	GetMaximumArraySize ()
static void	SetMaximumArraySize (PINDEX sz)
static PINDEX	GetMaximumStringSize ()
static void	SetMaximumStringSize (PINDEX sz)
Protected Member Functions inherited from PASN_Object
	PASN_Object (unsigned tag, TagClass tagClass, PBoolean extend=false)
Friends inherited from PObject

Detailed Description

Class for ASN Enumerated type.

Constructor & Destructor Documentation

PASN_Enumeration::PASN_Enumeration

(

unsigned

val = 0

)

PASN_Enumeration::PASN_Enumeration	(	unsigned	tag,
		TagClass	tagClass,
		unsigned	nEnums = P_MAX_INDEX,
		PBoolean	extendable = false,
		unsigned	val = 0
	)

PASN_Enumeration::PASN_Enumeration	(	unsigned	tag,
		TagClass	tagClass,
		unsigned	nEnums,
		PBoolean	extendable,
		const PASN_Names *	nameSpec,
		unsigned	namesCnt,
		unsigned	val = 0
	)

Member Function Documentation

virtual PObject* PASN_Enumeration::Clone ( ) const

virtual

Create a copy of the class on the heap.

The exact semantics of the descendent class determine what is required to make a duplicate of the instance. Not all classes can even do a clone operation.

The main user of the clone function is the PDictionary class as it requires copies of the dictionary keys.

The default behaviour is for this function to assert.

Returns

pointer to new copy of the class instance.

Reimplemented from PObject.

virtual Comparison PASN_Enumeration::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PObject.

virtual PBoolean PASN_Enumeration::Decode ( PASN_Stream &  )

virtual

Implements PASN_Object.

PBoolean PASN_Enumeration::DecodePER

(

PPER_Stream &

strm

)

virtual PBoolean PASN_Enumeration::DecodeXER ( PXER_Stream &  strm )

virtual

virtual void PASN_Enumeration::Encode ( PASN_Stream &  ) const

virtual

Implements PASN_Object.

void PASN_Enumeration::EncodePER

(

PPER_Stream &

strm

)

const

virtual void PASN_Enumeration::EncodeXER ( PXER_Stream &  strm ) const

virtual

virtual PINDEX PASN_Enumeration::GetDataLength ( ) const

virtual

Implements PASN_Object.

unsigned PASN_Enumeration::GetMaximum ( ) const

inline

References maxEnumValue.

virtual PString PASN_Enumeration::GetTypeAsString ( ) const

virtual

Return a string giving the type of the object.

Implements PASN_Object.

unsigned PASN_Enumeration::GetValue ( ) const

inline

References value.

PINDEX PASN_Enumeration::GetValueByName

(

PString

name

)

const

PASN_Enumeration::operator unsigned ( ) const

inline

References value.

PASN_Enumeration& PASN_Enumeration::operator= ( unsigned  v )

inline

References value.

virtual void PASN_Enumeration::PrintOn ( ostream &  strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

void PASN_Enumeration::SetValue ( unsigned  v )

inline

References value.

Member Data Documentation

unsigned PASN_Enumeration::maxEnumValue

protected

Referenced by GetMaximum().

const PASN_Names* PASN_Enumeration::names

protected

unsigned PASN_Enumeration::namesCount

protected

unsigned PASN_Enumeration::value

protected

Referenced by GetValue(), operator unsigned(), operator=(), and SetValue().

---

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

• asner.h