SnmpAdminString Class Reference

The class SnmpAdminString implements the textual convention SnmpAdminString as it is defined in the SNMP-FRAMEWORK-MIB: An octet string containing administrative information, preferably in human-readable form. More...

#include <snmp_textual_conventions.h>

Inheritance diagram for SnmpAdminString:

OctetStrMinMax MibLeaf MibEntry ThreadManager Synchronized

List of all members.

Public Member Functions

 SnmpAdminString (const Oidx &, mib_access, NS_SNMP OctetStr *)
 Construct a SnmpAdminString with initial value.
 SnmpAdminString (const Oidx &, mib_access, NS_SNMP OctetStr *, int)
 Construct a SnmpAdminString with initial value.
 SnmpAdminString (const Oidx &, mib_access, NS_SNMP OctetStr *, int, int, int)
 Construct a SnmpAdminString with initial value.
virtual ~SnmpAdminString ()
virtual MibEntryPtr clone ()
 Clone the receiver object.
NS_SNMP OctetStr get ()
 Return the AdminString.


Detailed Description

The class SnmpAdminString implements the textual convention SnmpAdminString as it is defined in the SNMP-FRAMEWORK-MIB: An octet string containing administrative information, preferably in human-readable form.

To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279].

Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited.

The use of control codes should be avoided.

When it is necessary to represent a newline, the control code sequence CR LF should be used.

The use of leading or trailing white space should be avoided.

For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided.

For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding.

UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding.

Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC1905].

Note that the size of an SnmpAdminString object is measured in octets, not characters.

Author:
Frank Fock
Version:
3.3

Constructor & Destructor Documentation

SnmpAdminString::SnmpAdminString ( const Oidx ,
mib_access  ,
NS_SNMP OctetStr *   
)

Construct a SnmpAdminString with initial value.

Parameters:
oid the oid of the leaf or the column of the columnar object.
access the max-access rights for the object.
octetstr a pointer to an OctetStr containing the initial value for the object.

SnmpAdminString::SnmpAdminString ( const Oidx ,
mib_access  ,
NS_SNMP OctetStr *  ,
int   
)

Construct a SnmpAdminString with initial value.

Parameters:
oid the oid of the leaf or the column of the columnar object.
access the max-access rights for the object.
octetstr a pointer to an OctetStr containing the initial value for the object.
valueMode contains an ored value of one or more of the following modes: VMODE_DEFAULT: the value of the object pointed by value will be used as default value, otherwise the managed object has no default value. VMODE_LOCKED: value is locked (cannot be modified) while the row status of the receiver's row is active(1). This mode has no effect, if the the leaf is a scalar or otherwise if the receiver's row has no snmpRowStatus.

SnmpAdminString::SnmpAdminString ( const Oidx ,
mib_access  ,
NS_SNMP OctetStr *  ,
int  ,
int  ,
int   
)

Construct a SnmpAdminString with initial value.

Parameters:
oid the oid of the leaf or the column of the columnar object.
access the max-access rights for the object.
octetstr a pointer to an OctetStr containing the initial value for the object.
valueMode contains an ored value of one or more of the following modes: VMODE_DEFAULT: the value of the object pointed by value will be used as default value, otherwise the managed object has no default value. VMODE_LOCKED: value is locked (cannot be modified) while the row status of the receiver's row is active(1). This mode has no effect, if the the leaf is a scalar or otherwise if the receiver's row has no snmpRowStatus.
min_size the minimum size of the SnmpAdminString.
max_size the maxmimum size of the SnmpAdminString.

virtual SnmpAdminString::~SnmpAdminString (  )  [virtual]


Member Function Documentation

virtual MibEntryPtr SnmpAdminString::clone (  )  [virtual]

Clone the receiver object.

Returns:
A pointer to the clone.

Reimplemented from OctetStrMinMax.

NS_SNMP OctetStr SnmpAdminString::get (  ) 

Return the AdminString.

Returns:
a OctetStr instance representing a SnmpAdminString.

Reimplemented from OctetStrMinMax.


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

Generated on Fri May 29 22:36:55 2009 for AGENT++ by  doxygen 1.5.6