FeatureSet.FeatureSet Class Reference


Detailed Description

The FeatureSet is a collection of features.

A FeatureSet is used to instantiate a Document object, thereby defining the type of data that the document can hold.

#include <class_feature_set_1_1_feature_set.h>

List of all members.

Public Member Functions

  __init__ ()
  add ()
  Adds the given feature to this feature set.
  features ()
  Returns the ids of registered feature.
  dependencies ()
  Returns the dependences of the feature with the given id; None if the feature is not in this feature set.
  containerType ()
  Returns the container type of the feature with the given id; None if the feature is not in this feature set.
  defaultIOGenerator ()
  Returns the default IO Generator of the feature with the given id; None if the feature is not in this feature set.
  copy ()
  Copies this FeatureSet into a new one and returns the new FeatureSet.
  clear ()
  Clears all features of this feature set.

Member Function Documentation

FeatureSet.FeatureSet.__init__ ( )
FeatureSet.FeatureSet.add ( )

Adds the given feature to this feature set.

Once added, a feature cannot be re-added.

FeatureSet.FeatureSet.features ( )

Returns the ids of registered feature.

FeatureSet.FeatureSet.dependencies ( )

Returns the dependences of the feature with the given id; None if the feature is not in this feature set.

FeatureSet.FeatureSet.containerType ( )

Returns the container type of the feature with the given id; None if the feature is not in this feature set.

FeatureSet.FeatureSet.defaultIOGenerator ( )

Returns the default IO Generator of the feature with the given id; None if the feature is not in this feature set.

FeatureSet.FeatureSet.copy ( )

Copies this FeatureSet into a new one and returns the new FeatureSet.

If featureIDs is empty, then all the features from this FeatureSet will be added to the new FeatureSet.

Only those features that exist in this FeatureSet will be copied. Only those features whose dependence is complete will be copied.

If a feature to be copied has dependents that are NOT also specified, then None will be returned.

FeatureSet.FeatureSet.clear ( )

Clears all features of this feature set.


FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet
FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet FeatureSet.FeatureSet