org.cip4.jdflib.ifaces

Interface ICapabilityElement

All Known Implementing Classes:

JDFAbstractState, JDFBooleanState, JDFDateTimeState, JDFDevCap, JDFDevCaps, JDFDurationState, JDFEnumerationState, JDFIntegerState, JDFMatrixState, JDFNameState, JDFNumberState, JDFPDFPathState, JDFRectangleState, JDFShapeState, JDFStringState, JDFXYPairState

public interface ICapabilityElement

interface that connects the devcap classes that implement vapabilities, i.e. state and devcap

Author:

prosirai

Method Summary

Methods

Modifier and Type	Method and Description
JDFModuleCap	appendModuleRef(String id) append moduleRef to moduleRefs, if it does not exist, set the availability to module and ensure that the appropriate modulecap exists
JDFDeviceCap.EnumAvailability	getAvailability() getAvailability - gets typesafe enumerated attribute Availability
JDFModulePool	getCreateModulePool() get the ModulePool that contains ModuleCap elements referenced by this create one, if it does not exist
JDFTerm.EnumTerm	getEvaluationType() get the type of evaluation that is appropriate for this ICapabilityElement
JDFModulePool	getModulePool() get the ModulePool that contains ModuleCap elements referenced by this
VString	getModuleRefs() get VString attribute ModuleRefs
VString	getNamePathVector()
void	setAvailability(JDFDeviceCap.EnumAvailability module)

Method Detail

getModulePool

JDFModulePool getModulePool()

get the ModulePool that contains ModuleCap elements referenced by this

Returns:

JDFModulePool the pool

getCreateModulePool

JDFModulePool getCreateModulePool()

get the ModulePool that contains ModuleCap elements referenced by this create one, if it does not exist

Returns:

JDFModulePool the pool

getModuleRefs

VString getModuleRefs()

get VString attribute ModuleRefs

Returns:

VString the value of the attribute

getAvailability

JDFDeviceCap.EnumAvailability getAvailability()

getAvailability - gets typesafe enumerated attribute Availability

Returns:

EnumAvailability: the enumeration value of the attribute

appendModuleRef

JDFModuleCap appendModuleRef(String id)

append moduleRef to moduleRefs, if it does not exist, set the availability to module and ensure that the appropriate modulecap exists

Parameters:

id -

Returns:

JDFModuleCap the Modulecap that id refers tp

setAvailability

void setAvailability(JDFDeviceCap.EnumAvailability module)

Parameters:

module -

getEvaluationType

JDFTerm.EnumTerm getEvaluationType()

get the type of evaluation that is appropriate for this ICapabilityElement

Returns:

EnumTerm the type of evaluation

getNamePathVector

VString getNamePathVector()

Returns: