BCFMarkup

class Communicator.BCFMarkup()

Constructors

constructor()

Methods

addComment()
addViewpoint()
deleteComment()
export()
getBimDate()
getBimFilename()
getComments()
getFilename()
getIfcProject()
getIfcSpacialStructureElement()
getIsExternal()
getMarkupHeaderFiles()
getProjectGuid()
getReference()
getTopicAssignedTo()
getTopicCreationAuthor()
getTopicCreationDate()
getTopicDescription()
getTopicDueDate()
getTopicId()
getTopicIndex()
getTopicLabels()
getTopicModifiedAuthor()
getTopicModifiedDate()
getTopicPriority()
getTopicReferenceLink()
getTopicStage()
getTopicStatus()
getTopicTitle()
getTopicType()
getViewpoints()
setTopicAssignedTo()
setTopicCreationAuthor()
setTopicCreationDate()
setTopicDescription()
setTopicDueDate()
setTopicId()
setTopicIndex()
setTopicLabels()
setTopicModifiedAuthor()
setTopicModifiedDate()
setTopicPriority()
setTopicReferenceLink()
setTopicState()
setTopicStatus()
setTopicTitle()
setTopicType()
updateComment()

Constructors

constructor

Communicator.BCFMarkup.constructor(filename, document, bcfTopic)

Arguments

filename (string()) –
document ({ }()) –
bcfTopic (Communicator.BCFTopic()) –

Return type

Communicator.BCFMarkup

Methods

addComment

Communicator.BCFMarkup.addComment(date, author, text, viewpointGuid, modifiedDate, modifiedAuthor)

Adds a comment to the topic.

Arguments

date (Date()) –
author (string()) –
text (string()) –
viewpointGuid ({ }()) –
modifiedDate (Date()) –
modifiedAuthor ({ }()) –

Return type

Communicator.BCFComment

addViewpoint

Communicator.BCFMarkup.addViewpoint(guid, viewpointFilename, snapshotFilename, index)

Arguments

guid (Communicator.Uuid()) –
viewpointFilename ({ }()) –
snapshotFilename ({ }()) –
index ({ }()) –

Return type

void

deleteComment

Communicator.BCFMarkup.deleteComment(guid)

Deletes a comment from the topic..

Arguments

guid (Communicator.Uuid()) –

Return type

void

export

Communicator.BCFMarkup.export()

Return type: XMLDocument
Returns: XML document containing the markup data.

getBimDate

Communicator.BCFMarkup.getBimDate()

Note

getBimDate is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getBimFilename

Communicator.BCFMarkup.getBimFilename()

Note

getBimFilename is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getComments

Communicator.BCFMarkup.getComments()

Gets a map of GUIDs and corresponding comments.

Return type: Map[Communicator.Uuid, Communicator.BCFComment]

getFilename

Communicator.BCFMarkup.getFilename()

Gets the Markup filename.

Return type: string

getIfcProject

Communicator.BCFMarkup.getIfcProject()

Note

getIfcProject is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getIfcSpacialStructureElement

Communicator.BCFMarkup.getIfcSpacialStructureElement()

Note

getIfcSpacialStructureElement is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getIsExternal

Communicator.BCFMarkup.getIsExternal()

Note

getIsExternal is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getMarkupHeaderFiles

Communicator.BCFMarkup.getMarkupHeaderFiles()

Return type: [Communicator.BCFMarkupHeaderFile]
Returns: a list of BCFMarkupHeaderFile containing data related to IFC files.

getProjectGuid

Communicator.BCFMarkup.getProjectGuid()

Return type: { }
Returns: the project GUID.

getReference

Communicator.BCFMarkup.getReference()

Note

getReference is deprecated: Use getMarkupHeaderFiles instead.

Return type: { }

getTopicAssignedTo

Communicator.BCFMarkup.getTopicAssignedTo()

The user to whom this topic is assigned to. Recommended to be in email format. The list of possible values are defined in the extension schema.

Return type: { }

getTopicCreationAuthor

Communicator.BCFMarkup.getTopicCreationAuthor()

Gets the name of the user that created the markup topic.

Return type: string

getTopicCreationDate

Communicator.BCFMarkup.getTopicCreationDate()

Gets the creation date of the markup topic.

Return type: Date

getTopicDescription

Communicator.BCFMarkup.getTopicDescription()

Description of the topic.

Return type: { }

getTopicDueDate

Communicator.BCFMarkup.getTopicDueDate()

Date when the issue needs to be resolved by.

Return type: { }

getTopicId

Communicator.BCFMarkup.getTopicId()

Gets the topic id.

Return type: Communicator.Uuid

getTopicIndex

Communicator.BCFMarkup.getTopicIndex()

Number to maintain the order of the topics.

Return type: { }

getTopicLabels

Communicator.BCFMarkup.getTopicLabels()

Tags for grouping Topics.

Return type: [string]

getTopicModifiedAuthor

Communicator.BCFMarkup.getTopicModifiedAuthor()

User who modified the topic. Exists only when Topic has been modified after creation.

Return type: { }

getTopicModifiedDate

Communicator.BCFMarkup.getTopicModifiedDate()

Date when the topic was last modified. Exists only when Topic has been modified after creation.

Return type: { }

getTopicPriority

Communicator.BCFMarkup.getTopicPriority()

Gets the topic priority.

Return type: { }

getTopicReferenceLink

Communicator.BCFMarkup.getTopicReferenceLink()

List of references to the topic, for example, a work request management system or an URI to a model.

Return type: { }

getTopicStage

Communicator.BCFMarkup.getTopicStage()

Stage this topic is part of.

Return type: { }

getTopicStatus

Communicator.BCFMarkup.getTopicStatus()

Gets the topic status.

Return type: { }

getTopicTitle

Communicator.BCFMarkup.getTopicTitle()

Gets the title of the markup topic.

Return type: string

getTopicType

Communicator.BCFMarkup.getTopicType()

Gets the topic type.

Return type: { }

getViewpoints

Communicator.BCFMarkup.getViewpoints()

Gets a map of GUIDs and corresponding viewpoints.

Return type: Map[Communicator.Uuid, Communicator.BCFMarkupViewpoint]

setTopicAssignedTo

Communicator.BCFMarkup.setTopicAssignedTo(assignedTo)

Sets the user that the topic is assigned to.

Arguments

assignedTo ({ }()) –

Return type

void

setTopicCreationAuthor

Communicator.BCFMarkup.setTopicCreationAuthor(author)

Sets the name of the user that created the markup topic.

Arguments

author (string()) –

Return type

void

setTopicCreationDate

Communicator.BCFMarkup.setTopicCreationDate(date)

Sets the creation date of the markup topic;

Arguments

date (Date()) –

Return type

void

setTopicDescription

Communicator.BCFMarkup.setTopicDescription(description)

Sets the topic description;

Arguments

description ({ }()) –

Return type

void

setTopicDueDate

Communicator.BCFMarkup.setTopicDueDate(date)

Sets the topic due date.

Arguments

date ({ }()) –

Return type

void

setTopicId

Communicator.BCFMarkup.setTopicId(guid)

Sets the topic id.

Arguments

guid (Communicator.Uuid()) –

Return type

void

setTopicIndex

Communicator.BCFMarkup.setTopicIndex(index)

Sets the topic index.

Arguments

index ({ }()) –

Return type

void

setTopicLabels

Communicator.BCFMarkup.setTopicLabels(labels)

Sets the topic labels.

Arguments

labels ([string]()) –

Return type

void

setTopicModifiedAuthor

Communicator.BCFMarkup.setTopicModifiedAuthor(modifiedAuthor)

Sets the author that last modified the topic.

Arguments

modifiedAuthor ({ }()) –

Return type

void

setTopicModifiedDate

Communicator.BCFMarkup.setTopicModifiedDate(date)

Sets the topic modified date.

Arguments

date ({ }()) –

Return type

void

setTopicPriority

Communicator.BCFMarkup.setTopicPriority(priority)

Sets the topic priority.

Arguments

priority ({ }()) –

Return type

void

setTopicReferenceLink

Communicator.BCFMarkup.setTopicReferenceLink(referenceLink)

Sets the ReferenceLink.

Arguments

referenceLink ({ }()) –

Return type

void

setTopicState

Communicator.BCFMarkup.setTopicState(stage)

Sets the topic stage;

Arguments

stage ({ }()) –

Return type

void

setTopicStatus

Communicator.BCFMarkup.setTopicStatus(topicStatus)

Sets the topic status.

Arguments

topicStatus ({ }()) –

Return type

void

setTopicTitle

Communicator.BCFMarkup.setTopicTitle(title)

Sets the title of the markup topic.

Arguments

title (string()) –

Return type

void

setTopicType

Communicator.BCFMarkup.setTopicType(topicType)

Sets the topic type.

Arguments

topicType ({ }()) –

Return type

void

updateComment

Communicator.BCFMarkup.updateComment(comment)

Updates a topic comment.

Arguments

comment (Communicator.BCFComment()) –

Return type

void