org.bimserver.models.ifc4

Interface IfcDocumentReference

All Superinterfaces:

org.eclipse.emf.ecore.EObject, IdEObject, IfcDocumentSelect, IfcExternalReference, IfcLightDistributionDataSourceSelect, IfcObjectReferenceSelect, IfcResourceObjectSelect, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

IfcDocumentReferenceImpl

public interface IfcDocumentReference
extends IfcExternalReference, IfcDocumentSelect

A representation of the model object 'Ifc Document Reference'.

The following features are supported:

• Description
• Referenced Document
• Document Ref For Objects

See Also:

Ifc4Package.getIfcDocumentReference()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the value of the 'Description' attribute.
org.eclipse.emf.common.util.EList<IfcRelAssociatesDocument>	getDocumentRefForObjects() Returns the value of the 'Document Ref For Objects' reference list.
IfcDocumentInformation	getReferencedDocument() Returns the value of the 'Referenced Document' reference.
boolean	isSetDescription() Returns whether the value of the 'Description' attribute is set.
boolean	isSetDocumentRefForObjects() Returns whether the value of the 'Document Ref For Objects' reference list is set.
boolean	isSetReferencedDocument() Returns whether the value of the 'Referenced Document' reference is set.
void	setDescription(String value) Sets the value of the 'Description' attribute.
void	setReferencedDocument(IfcDocumentInformation value) Sets the value of the 'Referenced Document' reference.
void	unsetDescription() Unsets the value of the 'Description' attribute.
void	unsetDocumentRefForObjects() Unsets the value of the 'Document Ref For Objects' reference list.
void	unsetReferencedDocument() Unsets the value of the 'Referenced Document' reference.

Methods inherited from interface org.bimserver.models.ifc4.IfcExternalReference

getExternalReferenceForResources, getIdentification, getLocation, getName, isSetExternalReferenceForResources, isSetIdentification, isSetLocation, isSetName, setIdentification, setLocation, setName, unsetExternalReferenceForResources, unsetIdentification, unsetLocation, unsetName

Methods inherited from interface org.bimserver.emf.IdEObject

forceLoad, getExpressId, getOid, getPid, getRid, isLoadedOrLoading, load, remove

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

getDescription

String getDescription()

Returns the value of the 'Description' attribute.

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

Returns:

the value of the 'Description' attribute.

See Also:

isSetDescription(), unsetDescription(), setDescription(String), Ifc4Package.getIfcDocumentReference_Description()

setDescription

void setDescription(String value)

Sets the value of the 'Description' attribute.

Parameters:

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

See Also:

isSetDescription(), unsetDescription(), getDescription()

unsetDescription

void unsetDescription()

Unsets the value of the 'Description' attribute.

See Also:

isSetDescription(), getDescription(), setDescription(String)

isSetDescription

boolean isSetDescription()

Returns whether the value of the 'Description' attribute is set.

Returns:

whether the value of the 'Description' attribute is set.

See Also:

unsetDescription(), getDescription(), setDescription(String)

getReferencedDocument

IfcDocumentInformation getReferencedDocument()

Returns the value of the 'Referenced Document' reference. It is bidirectional and its opposite is 'Has Document References'.

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

Returns:

the value of the 'Referenced Document' reference.

See Also:

isSetReferencedDocument(), unsetReferencedDocument(), setReferencedDocument(IfcDocumentInformation), Ifc4Package.getIfcDocumentReference_ReferencedDocument(), IfcDocumentInformation.getHasDocumentReferences()

setReferencedDocument

void setReferencedDocument(IfcDocumentInformation value)

Sets the value of the 'Referenced Document' reference.

Parameters:

value - the new value of the 'Referenced Document' reference.

See Also:

isSetReferencedDocument(), unsetReferencedDocument(), getReferencedDocument()

unsetReferencedDocument

void unsetReferencedDocument()

Unsets the value of the 'Referenced Document' reference.

See Also:

isSetReferencedDocument(), getReferencedDocument(), setReferencedDocument(IfcDocumentInformation)

isSetReferencedDocument

boolean isSetReferencedDocument()

Returns whether the value of the 'Referenced Document' reference is set.

Returns:

whether the value of the 'Referenced Document' reference is set.

See Also:

unsetReferencedDocument(), getReferencedDocument(), setReferencedDocument(IfcDocumentInformation)

getDocumentRefForObjects

org.eclipse.emf.common.util.EList<IfcRelAssociatesDocument> getDocumentRefForObjects()

Returns the value of the 'Document Ref For Objects' reference list. The list contents are of type IfcRelAssociatesDocument.

If the meaning of the 'Document Ref For Objects' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Document Ref For Objects' reference list.

See Also:

isSetDocumentRefForObjects(), unsetDocumentRefForObjects(), Ifc4Package.getIfcDocumentReference_DocumentRefForObjects()

unsetDocumentRefForObjects

void unsetDocumentRefForObjects()

Unsets the value of the 'Document Ref For Objects' reference list.

See Also:

isSetDocumentRefForObjects(), getDocumentRefForObjects()

isSetDocumentRefForObjects

boolean isSetDocumentRefForObjects()

Returns whether the value of the 'Document Ref For Objects' reference list is set.

Returns:

whether the value of the 'Document Ref For Objects' reference list is set.

See Also:

unsetDocumentRefForObjects(), getDocumentRefForObjects()