org.eclipse.ptp.pldt.common.editorHelp

Class FunctionSummaryImpl

java.lang.Object

org.eclipse.ptp.pldt.common.editorHelp.FunctionSummaryImpl

All Implemented Interfaces:

org.eclipse.cdt.ui.IFunctionSummary

public class FunctionSummaryImpl
extends java.lang.Object
implements org.eclipse.cdt.ui.IFunctionSummary

Used by all four PLDT types MPI, OpenMP, LAPI and UPC, to create the structures that hover help needs

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.cdt.ui.IFunctionSummary

org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary

Constructor Summary

Constructors

Constructor and Description
FunctionSummaryImpl()
FunctionSummaryImpl(java.lang.String name, java.lang.String namespace, java.lang.String description, org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary prototype, org.eclipse.cdt.ui.IRequiredInclude[] includes) Function information used in editor help

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription()
org.eclipse.cdt.ui.IRequiredInclude[]	getIncludes()
java.lang.String	getName()
java.lang.String	getNamespace()
org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary	getPrototype()
void	setDescription(java.lang.String description) Set description of this function
void	setIncludes(org.eclipse.cdt.ui.IRequiredInclude[] includes) Set the list of required includes for this function
void	setName(java.lang.String name) Set the name of this function
void	setNamespace(java.lang.String namespace) Set namespace
void	setPrototype(org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary prototype) Set Function prototype summary information for this object
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionSummaryImpl

public FunctionSummaryImpl()

FunctionSummaryImpl

public FunctionSummaryImpl(java.lang.String name,
                   java.lang.String namespace,
                   java.lang.String description,
                   org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary prototype,
                   org.eclipse.cdt.ui.IRequiredInclude[] includes)

Function information used in editor help

Parameters:

name - - used for the name of the html help file referenced by the F1 (dynamic help) function key. Other use too? assumed.

namespace -

description -

prototype -

includes -

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface org.eclipse.cdt.ui.IFunctionSummary

getNamespace

public java.lang.String getNamespace()

Specified by:

getNamespace in interface org.eclipse.cdt.ui.IFunctionSummary

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface org.eclipse.cdt.ui.IFunctionSummary

getPrototype

public org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary getPrototype()

Specified by:

getPrototype in interface org.eclipse.cdt.ui.IFunctionSummary

getIncludes

public org.eclipse.cdt.ui.IRequiredInclude[] getIncludes()

Specified by:

getIncludes in interface org.eclipse.cdt.ui.IFunctionSummary

setDescription

public void setDescription(java.lang.String description)

Set description of this function

Parameters:

description -

setIncludes

public void setIncludes(org.eclipse.cdt.ui.IRequiredInclude[] includes)

Set the list of required includes for this function

Parameters:

includes -

setName

public void setName(java.lang.String name)

Set the name of this function

Parameters:

name -

setNamespace

public void setNamespace(java.lang.String namespace)

Set namespace

Parameters:

namespace -

setPrototype

public void setPrototype(org.eclipse.cdt.ui.IFunctionSummary.IFunctionPrototypeSummary prototype)

Set Function prototype summary information for this object

Parameters:

prototype -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object