PTLib  Version 2.10.11
PASN_ObjectId Class Reference

Class for ASN Object Identifier type. More...

#include <asner.h>

Inheritance diagram for PASN_ObjectId:
PASN_Object PObject PRFC1155_ObjectName

Public Member Functions

 PASN_ObjectId (const char *dotstr=NULL)
 
 PASN_ObjectId (unsigned tag, TagClass tagClass)
 
 PASN_ObjectId (const PASN_ObjectId &other)
 
PASN_ObjectIdoperator= (const PASN_ObjectId &other)
 
PASN_ObjectIdoperator= (const char *dotstr)
 
PASN_ObjectIdoperator= (const PString &dotstr)
 
PASN_ObjectIdoperator= (const PUnsignedArray &numbers)
 
void SetValue (const PString &dotstr)
 
void SetValue (const PUnsignedArray &numbers)
 
void SetValue (const unsigned *numbers, PINDEX size)
 
bool operator== (const char *dotstr) const
 
bool operator!= (const char *dotstr) const
 
bool operator== (const PString &dotstr) const
 
bool operator!= (const PString &dotstr) const
 
bool operator== (const PASN_ObjectId &id) const
 
PINDEX GetSize () const
 
unsigned operator[] (PINDEX idx) const
 
const PUnsignedArrayGetValue () const
 
PString AsString () const
 
virtual Comparison Compare (const PObject &obj) const
 Compare the two objects and return their relative rank. More...
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
virtual void PrintOn (ostream &strm) const
 Output the contents of the object to the stream. More...
 
virtual PString GetTypeAsString () const
 Return a string giving the type of the object. More...
 
virtual PINDEX GetDataLength () const
 
virtual PBoolean Decode (PASN_Stream &)
 
virtual void Encode (PASN_Stream &) const
 
PBoolean CommonDecode (PASN_Stream &strm, unsigned dataLen)
 
void CommonEncode (PBYTEArray &eObjId) 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. 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 ReadFrom (istream &strm)
 Input the contents of the object from the stream. More...
 

Protected Attributes

PUnsignedArray value
 
- Protected Attributes inherited from PASN_Object
PBoolean extendable
 PER extension capability. More...
 
TagClass tagClass
 BER tag class. More...
 
unsigned tag
 ASN object tag. More...
 

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 }
 
- Public Types inherited from PObject
enum  Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
 Result of the comparison operation performed by the Compare() function. More...
 
- Static Public Member Functions inherited from PASN_Object
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 inherited from PASN_Object
 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...
 

Detailed Description

Class for ASN Object Identifier type.

Constructor & Destructor Documentation

PASN_ObjectId::PASN_ObjectId ( const char *  dotstr = NULL)
PASN_ObjectId::PASN_ObjectId ( unsigned  tag,
TagClass  tagClass 
)
PASN_ObjectId::PASN_ObjectId ( const PASN_ObjectId other)

Member Function Documentation

PString PASN_ObjectId::AsString ( ) const
virtual PObject* PASN_ObjectId::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.

Reimplemented in PRFC1155_ObjectName.

PBoolean PASN_ObjectId::CommonDecode ( PASN_Stream strm,
unsigned  dataLen 
)
void PASN_ObjectId::CommonEncode ( PBYTEArray eObjId) const
virtual Comparison PASN_ObjectId::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_ObjectId::Decode ( PASN_Stream )
virtual

Implements PASN_Object.

virtual void PASN_ObjectId::Encode ( PASN_Stream ) const
virtual

Implements PASN_Object.

virtual PINDEX PASN_ObjectId::GetDataLength ( ) const
virtual

Implements PASN_Object.

PINDEX PASN_ObjectId::GetSize ( ) const
inline

References PContainer::GetSize(), and value.

virtual PString PASN_ObjectId::GetTypeAsString ( ) const
virtual

Return a string giving the type of the object.

Implements PASN_Object.

const PUnsignedArray& PASN_ObjectId::GetValue ( ) const
inline

References value.

bool PASN_ObjectId::operator!= ( const char *  dotstr) const
inline

References operator==().

bool PASN_ObjectId::operator!= ( const PString dotstr) const
inline

References operator==().

PASN_ObjectId& PASN_ObjectId::operator= ( const PASN_ObjectId other)
PASN_ObjectId& PASN_ObjectId::operator= ( const char *  dotstr)
PASN_ObjectId& PASN_ObjectId::operator= ( const PString dotstr)
PASN_ObjectId& PASN_ObjectId::operator= ( const PUnsignedArray numbers)
bool PASN_ObjectId::operator== ( const char *  dotstr) const

Referenced by operator!=().

bool PASN_ObjectId::operator== ( const PString dotstr) const
inline

References operator==().

Referenced by operator==().

bool PASN_ObjectId::operator== ( const PASN_ObjectId id) const
inline

References value.

unsigned PASN_ObjectId::operator[] ( PINDEX  idx) const
inline

References value.

virtual void PASN_ObjectId::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_ObjectId::SetValue ( const PString dotstr)
void PASN_ObjectId::SetValue ( const PUnsignedArray numbers)
inline

References value.

void PASN_ObjectId::SetValue ( const unsigned *  numbers,
PINDEX  size 
)

Member Data Documentation

PUnsignedArray PASN_ObjectId::value
protected

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