StorageType Class Reference

The StorageType class describes the memory realization of a conceptual row. More...

#include <snmp_textual_conventions.h>

Inheritance diagram for StorageType:

MibLeaf MibEntry ThreadManager Synchronized

List of all members.

Public Member Functions

 StorageType (const Oidx &, int)
 Construct a storageType instance.
virtual boolean row_is_volatile ()
 Return whether the row of the receiver is volatile or permanent.
virtual long get_state ()
 Return the receiver's value.
virtual void set_state (long)
 Sets the type of this storage type.
virtual MibEntryPtr clone ()
 Clone the receiver object.
virtual boolean value_ok (const Vbx &)
 Check whether the receiver's value may be set to the given new value.


Detailed Description

The StorageType class describes the memory realization of a conceptual row.

A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.

If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be modified. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5).

Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable.

Version:
3.5.16

Constructor & Destructor Documentation

StorageType::StorageType ( const Oidx ,
int   
)

Construct a storageType instance.

Parameters:
o The storageType column subidentifier.
default A default storageType value, should be nonVolatile(3)


Member Function Documentation

virtual boolean StorageType::row_is_volatile (  )  [virtual]

Return whether the row of the receiver is volatile or permanent.

Returns:
TRUE, if the row is volatile, FALSE otherwise.

virtual long StorageType::get_state (  )  [virtual]

Return the receiver's value.

Returns:
A integer value between 1 and 5.

virtual void StorageType::set_state ( long   )  [virtual]

Sets the type of this storage type.

Allowed values are in range 1..5.

Parameters:
storageType a long integer value between 1 and 5.

virtual MibEntryPtr StorageType::clone (  )  [virtual]

Clone the receiver object.

Returns:
A pointer to the clone.

Reimplemented from MibLeaf.

virtual boolean StorageType::value_ok ( const Vbx  )  [virtual]

Check whether the receiver's value may be set to the given new value.

Note:
Override this mehtod in subclasses.
Parameters:
v - A new value.
Returns:
TRUE if the new value is valid, otherwise FALSE.

Reimplemented from MibLeaf.


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