libsbmlcs.SBaseExtensionPoint Class Reference

Inheritance diagram for libsbmlcs.SBaseExtensionPoint:

Detailed Description

{core}

Representation of an extension point of SBML's package extension.

SBaseExtensionPoint represents an element to be extended (extension point) and the extension point is identified by a combination of a package name and a typecode of the element.

For example, an SBaseExtensionPoint object which represents an extension point of the model element defined in the core package can be created as follows:

      SBaseExtensionPoint  modelextp('core', SBML_MODEL);

Similarly, an SBaseExtensionPoint object which represents an extension point of the layout element defined in the layout extension can be created as follows:

      SBaseExtensionPoint  layoutextp('layout', SBML_LAYOUT_LAYOUT);

SBaseExtensionPoint object is required as one of arguments of the constructor of SBasePluginCreator<class SBasePluginType, class SBMLExtensionType> template class to identify an extension poitnt to which the plugin object created by the creator class is plugged in. For example, the SBasePluginCreator class which creates a LayoutModelPlugin object of the layout extension which is plugged in to the model element of the core package can be created with the corresponding SBaseExtensionPoint object as follows:

  // std::vector object that contains a list of URI (package versions) supported 
  // by the plugin object.
  std::vector<string> packageURIs;
  packageURIs.push_back(getXmlnsL3V1V1());
  packageURIs.push_back(getXmlnsL2());  

  // creates an extension point (model element of the 'core' package)
  SBaseExtensionPoint  modelExtPoint('core',SBML_MODEL);
   
  // creates an SBasePluginCreator object 
  SBasePluginCreator<LayoutModelPlugin, LayoutExtension>  modelPluginCreator(modelExtPoint,packageURIs);

This kind of code is implemented in init() function of each SBMLExtension derived classes.

Public Member Functions
SBaseExtensionPoint	clone ()
	Creates and returns a deep copy of this SBaseExtensionPoint. More...
virtual void	Dispose ()
string	getPackageName ()
	Returns the package name of this extension point. More...
int	getTypeCode ()
	Returns the typecode of this extension point. More...
	SBaseExtensionPoint (string pkgName, int typeCode)
	constructor More...
	SBaseExtensionPoint (SBaseExtensionPoint rhs)
	copy constructor More...

Protected Attributes
bool	swigCMemOwn

Constructor & Destructor Documentation

libsbmlcs.SBaseExtensionPoint.SBaseExtensionPoint	(	string	pkgName,
		int	typeCode
	)

constructor

libsbmlcs.SBaseExtensionPoint.SBaseExtensionPoint

(

SBaseExtensionPoint

rhs

)

copy constructor

Member Function Documentation

SBaseExtensionPoint libsbmlcs.SBaseExtensionPoint.clone

(

)

Creates and returns a deep copy of this SBaseExtensionPoint.

Returns

a (deep) copy of this SBaseExtensionPoint.

virtual void libsbmlcs.SBaseExtensionPoint.Dispose ( )

virtual

string libsbmlcs.SBaseExtensionPoint.getPackageName

(

)

Returns the package name of this extension point.

int libsbmlcs.SBaseExtensionPoint.getTypeCode

(

)

Returns the typecode of this extension point.

Member Data Documentation

bool libsbmlcs.SBaseExtensionPoint.swigCMemOwn

protected