org.eclipse.ocl.examples.codegen.cgmodel
Interface CGValuedElement

All Superinterfaces:

CGElement, CGNamedElement, CGTypedElement, org.eclipse.emf.ecore.EObject, Nameable, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

CGBoolean, CGBoxExp, CGBuiltInIterationCallExp, CGCallExp, CGCastParameter, CGCatchExp, CGCollectionExp, CGCollectionPart, CGConstant, CGConstantExp, CGConstructorExp, CGConstructorPart, CGEcoreClassConstructorExp, CGEcoreDataTypeConstructorExp, CGEcoreOperationCallExp, CGEcorePropertyCallExp, CGElementId, CGEqualsExp, CGExecutorCompositionProperty, CGExecutorConstructorPart, CGExecutorNavigationProperty, CGExecutorOperation, CGExecutorOperationCallExp, CGExecutorOppositeProperty, CGExecutorProperty, CGExecutorPropertyCallExp, CGExecutorType, CGFinalVariable, CGGuardExp, CGIfExp, CGInfinity, CGInteger, CGInvalid, CGIsInvalidExp, CGIsUndefinedExp, CGIterationCallExp, CGIterator, CGLetExp, CGLibraryIterateCallExp, CGLibraryIterationCallExp, CGLibraryOperationCallExp, CGLibraryPropertyCallExp, CGLocalVariable, CGNull, CGOperation, CGOperationCallExp, CGParameter, CGProperty, CGPropertyCallExp, CGReal, CGSettableVariable, CGString, CGText, CGTextParameter, CGThrowExp, CGTupleExp, CGTuplePart, CGTuplePartCallExp, CGTypeExp, CGTypeId, CGUnboxExp, CGVariable, CGVariableExp

All Known Implementing Classes:

CGBooleanImpl, CGBoxExpImpl, CGBuiltInIterationCallExpImpl, CGCallExpImpl, CGCastParameterImpl, CGCatchExpImpl, CGCollectionExpImpl, CGCollectionPartImpl, CGConstantExpImpl, CGConstantImpl, CGConstructorExpImpl, CGConstructorPartImpl, CGEcoreClassConstructorExpImpl, CGEcoreDataTypeConstructorExpImpl, CGEcoreOperationCallExpImpl, CGEcorePropertyCallExpImpl, CGElementIdImpl, CGEqualsExpImpl, CGExecutorCompositionPropertyImpl, CGExecutorConstructorPartImpl, CGExecutorNavigationPropertyImpl, CGExecutorOperationCallExpImpl, CGExecutorOperationImpl, CGExecutorOppositePropertyImpl, CGExecutorPropertyCallExpImpl, CGExecutorPropertyImpl, CGExecutorTypeImpl, CGFinalVariableImpl, CGGuardExpImpl, CGIfExpImpl, CGInfinityImpl, CGIntegerImpl, CGInvalidImpl, CGIsInvalidExpImpl, CGIsUndefinedExpImpl, CGIterationCallExpImpl, CGIteratorImpl, CGLetExpImpl, CGLibraryIterateCallExpImpl, CGLibraryIterationCallExpImpl, CGLibraryOperationCallExpImpl, CGLibraryPropertyCallExpImpl, CGLocalVariableImpl, CGNullImpl, CGOperationCallExpImpl, CGOperationImpl, CGParameterImpl, CGPropertyCallExpImpl, CGPropertyImpl, CGRealImpl, CGSettableVariableImpl, CGStringImpl, CGTextImpl, CGTextParameterImpl, CGThrowExpImpl, CGTupleExpImpl, CGTuplePartCallExpImpl, CGTuplePartImpl, CGTypeExpImpl, CGTypeIdImpl, CGUnboxExpImpl, CGValuedElementImpl, CGVariableExpImpl, CGVariableImpl

public interface CGValuedElement
extends CGTypedElement

A representation of the model object 'CG Valued Element'.

The following features are supported:

• Boxed
• Caught
• Constant
• Depends On
• False
• Global
• Inlineable
• Invalid
• Null
• Non Invalid
• Non Null
• Referred Valued Element
• Settable
• True
• Unboxed
• Value
• Value Name

See Also:

CGModelPackage.getCGValuedElement()

Generated

Model

abstract="true"

Field Summary

Fields inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGElement

EMPTY_LIST

Method Summary

java.util.List<CGValuedElement>	getDependsOn() Returns the value of the 'Depends On' reference list.
CGValuedElement	getReferredValuedElement() Returns the value of the 'Referred Valued Element' reference.
CGValuedElement	getValue() Returns the value of the 'Value' reference.
java.lang.String	getValueName() Returns the value of the 'Value Name' attribute.
boolean	isBoxed() Returns the value of the 'Boxed' attribute.
boolean	isCaught() Returns the value of the 'Caught' attribute.
boolean	isConstant()
boolean	isFalse() Returns the value of the 'False' attribute.
boolean	isGlobal() Returns the value of the 'Global' attribute.
boolean	isInlineable() Returns the value of the 'Inlineable' attribute.
boolean	isInvalid() Returns the value of the 'Invalid' attribute.
boolean	isNonInvalid() Returns the value of the 'Non Invalid' attribute.
boolean	isNonNull() Returns the value of the 'Non Null' attribute.
boolean	isNull() Returns the value of the 'Null' attribute.
boolean	isSettable() Returns the value of the 'Settable' attribute.
boolean	isTrue() Returns the value of the 'True' attribute.
boolean	isUnboxed() Returns the value of the 'Unboxed' attribute.
void	setCaught(boolean value) Sets the value of the 'Caught' attribute.
void	setNonInvalid()
void	setNonNull()
void	setValueName(java.lang.String value) Sets the value of the 'Value Name' attribute.

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGTypedElement

getPivotTypeId, getTypeId, isRequired, setRequired, setTypeId

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGNamedElement

getName, getPivot, setName, setPivot

Methods inherited from interface org.eclipse.ocl.examples.codegen.cgmodel.CGElement

accept, getChildren, getParent

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

isBoxed

boolean isBoxed()

Returns the value of the 'Boxed' attribute.

If the meaning of the 'Boxed' attribute isn't clear, there really should be more of a description here...

Whether this element is represented using boxed values.

Returns:

the value of the 'Boxed' attribute.

See Also:

CGModelPackage.getCGValuedElement_Boxed()

Generated

Model

required="true" transient="true" changeable="false" volatile="true" derived="true"

isCaught

boolean isCaught()

Returns the value of the 'Caught' attribute. Whether an invalid value of this element is represented by an invalid value (true), an invalid exception (false). The value is null until determined by the FieldingAnalyzer.

Returns:

the value of the 'Caught' attribute.

See Also:

setCaught(boolean), CGModelPackage.getCGValuedElement_Caught()

Generated

Model

setCaught

void setCaught(boolean value)

Sets the value of the 'Caught' attribute.

Parameters:

value - the new value of the 'Caught' attribute.

See Also:

isCaught()

Generated

isInlineable

boolean isInlineable()

Returns the value of the 'Inlineable' attribute. The default value is "false".

If the meaning of the 'Inlineable' attribute isn't clear, there really should be more of a description here...

Whether this element is a constant that can be evaluated inline and so needs no declaration (e.g. null, true).

Returns:

the value of the 'Inlineable' attribute.

See Also:

CGModelPackage.getCGValuedElement_Inlineable()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isInvalid

boolean isInvalid()

Returns the value of the 'Invalid' attribute. The default value is "false".

If the meaning of the 'Invalid' attribute isn't clear, there really should be more of a description here...

Whether this element is constant and represents an invalid value (and nothing else).

Returns:

the value of the 'Invalid' attribute.

See Also:

CGModelPackage.getCGValuedElement_Invalid()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isNull

boolean isNull()

Returns the value of the 'Null' attribute. The default value is "false".

If the meaning of the 'Null' attribute isn't clear, there really should be more of a description here...

Whether this element is constant and represents the null value (and nothing else).

Returns:

the value of the 'Null' attribute.

See Also:

CGModelPackage.getCGValuedElement_Null()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isFalse

boolean isFalse()

Returns the value of the 'False' attribute. The default value is "false". Whether this element is constant and represents the false value (and nothing else).

Returns:

the value of the 'False' attribute.

See Also:

CGModelPackage.getCGValuedElement_False()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isGlobal

boolean isGlobal()

Returns the value of the 'Global' attribute. The default value is "false".

If the meaning of the 'Global' attribute isn't clear, there really should be more of a description here...

Whether this element is global (and constant). Global values may be statically computed and shared.

Returns:

the value of the 'Global' attribute.

See Also:

CGModelPackage.getCGValuedElement_Global()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isNonInvalid

boolean isNonInvalid()

Returns the value of the 'Non Invalid' attribute. The default value is "false".

If the meaning of the 'Non Invalid' attribute isn't clear, there really should be more of a description here...

Whether this element is constant and represents something other than an invalid value.

Returns:

the value of the 'Non Invalid' attribute.

See Also:

CGModelPackage.getCGValuedElement_NonInvalid()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isNonNull

boolean isNonNull()

Returns the value of the 'Non Null' attribute. The default value is "false".

If the meaning of the 'Non Null' attribute isn't clear, there really should be more of a description here...

Whether this element is constant and represents something other than the null value.

Returns:

the value of the 'Non Null' attribute.

See Also:

CGModelPackage.getCGValuedElement_NonNull()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

getReferredValuedElement

CGValuedElement getReferredValuedElement()

Returns the value of the 'Referred Valued Element' reference. The element from which this element's value is determined, which is this for a self-determining element such as a CGConstant or CGCatchExp, but may delegate for an element such as a CGBoxExp or CGVariableExp. Following the referredValuedElement daisy chain leads to the value.

Returns:

the value of the 'Referred Valued Element' reference.

See Also:

CGModelPackage.getCGValuedElement_ReferredValuedElement()

Generated

Model

resolveProxies="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isSettable

boolean isSettable()

Returns the value of the 'Settable' attribute. The default value is "false".

If the meaning of the 'Settable' attribute isn't clear, there really should be more of a description here...

Whether this element is subject to assignment from multiple sources. (e.g the then/else value of an if).

Returns:

the value of the 'Settable' attribute.

See Also:

CGModelPackage.getCGValuedElement_Settable()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

isTrue

boolean isTrue()

Returns the value of the 'True' attribute. The default value is "false". Whether this element is constant and represents the true value (and nothing else).

Returns:

the value of the 'True' attribute.

See Also:

CGModelPackage.getCGValuedElement_True()

Generated

Model

default="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

getValue

@NonNull
CGValuedElement getValue()

Returns the value of the 'Value' reference.

If the meaning of the 'Value' reference isn't clear, there really should be more of a description here...

The first valued element along the referredValuedElement daisy chain that has a reified value with a name. e.g. A CGCatchExp defines a variable which is what is referenced, but its underlying type is available by following the referredValuedElement daisy chain to its end.

Returns:

the value of the 'Value' reference.

See Also:

CGModelPackage.getCGValuedElement_Value()

Generated

Model

resolveProxies="false" required="true" transient="true" changeable="false" volatile="true" derived="true"

getValueName

java.lang.String getValueName()

Returns the value of the 'Value Name' attribute.

If the meaning of the 'Value Name' attribute isn't clear, there really should be more of a description here...

The declared name value of this element. The text is valid for use in the target language and unique within the context in which this element is declared.

Returns:

the value of the 'Value Name' attribute.

See Also:

setValueName(String), CGModelPackage.getCGValuedElement_ValueName()

Generated

Model

setValueName

void setValueName(java.lang.String value)

Sets the value of the 'Value Name' attribute.

Parameters:

value - the new value of the 'Value Name' attribute.

See Also:

getValueName()

Generated

isUnboxed

boolean isUnboxed()

Returns the value of the 'Unboxed' attribute.

If the meaning of the 'Unboxed' attribute isn't clear, there really should be more of a description here...

Whether this element is represented using unboxed values.

Returns:

the value of the 'Unboxed' attribute.

See Also:

CGModelPackage.getCGValuedElement_Unboxed()

Generated

Model

required="true" transient="true" changeable="false" volatile="true" derived="true"

setNonInvalid

void setNonInvalid()

Generated

Model

setNonNull

void setNonNull()

Generated

Model

isConstant

boolean isConstant()

getDependsOn

@NonNull
java.util.List<CGValuedElement> getDependsOn()

Returns the value of the 'Depends On' reference list. The list contents are of type CGValuedElement.

If the meaning of the 'Depends On' reference list isn't clear, there really should be more of a description here...

The elements that must be declared before this element.

Returns:

the value of the 'Depends On' reference list.

See Also:

CGModelPackage.getCGValuedElement_DependsOn()

Generated

Model

resolveProxies="false"