sdHierValue Class Reference

Inheritance diagram for sdHierValue:

sdValue sdBase


Public Methods

 sdHierValue (unsigned int id, const std::string &name, const std::string &description, sdNameSpace *nameSpace, const FieldVector &fields)
virtual ~sdHierValue ()
FieldConstIter begin () const
FieldConstIter end () const
virtual void accept (sdVisitor *visitor)

Public Types

typedef std::vector< sdField * > FieldVector
typedef FieldVector::const_iterator FieldConstIter

Detailed Description

An object of the sdHierValue class is instantiated to give the description of a composite type, such as an oaBox. An sdHierValue object is composed of one or more member sdField objects, which can be sdLeafValues or sdHierValues.

For example, an sdHierValue of an oaBox contains two fields, each of which is the sdHierValue object that describes an oaPoint.


Member Typedef Documentation

typedef FieldVector::const_iterator sdHierValue::FieldConstIter
 

typedef std::vector<sdField*> sdHierValue::FieldVector
 


Constructor & Destructor Documentation

sdHierValue::sdHierValue unsigned int    id,
const std::string &    name,
const std::string &    description,
sdNameSpace *    nameSpace,
const FieldVector &    fields
 

This is the sdHierValue constructor.

Parameters:
id An identifier for the value.
name The name for the value.
description The description for the value.
nameSpace The namespace for the value.
fields The fields for the composite type.

sdHierValue::~sdHierValue   [virtual]
 

This is the sdHierValue destructor.


Member Function Documentation

void sdHierValue::accept sdVisitor *    visitor [virtual]
 

This function calls the visit function of the specified visitor on the hierarchical value.

Parameters:
visitor A pointer to the visitor to call.

Implements sdBase.

FieldConstIter sdHierValue::begin   const
 

This function returns a constant iterator pointing to the first position of the fields of this schema value object.

FieldConstIter sdHierValue::end   const
 

This function returns a constant iterator pointing to the last position of the fields of this schema value object.


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

Return to top of page