BCFMarkup

class Bcf.BCFMarkup()

Constructors

Methods

Constructors

BCFMarkup.constructor(filename, document, bcfTopic)
Arguments

  • filename (string()) – None

  • document (null | Document()) – None

  • bcfTopic (BCFTopic()) – None

Return type

BCFMarkup

Methods

addComment

BCFMarkup.addComment(date, author, text[, viewpointGuid[, modifiedDate[, modifiedAuthor]]])
Arguments

  • date (Date()) – None

  • author (string()) – None

  • text (string()) – None

  • viewpointGuid (string()) – optional None

  • modifiedDate (Date()) – optional None

  • modifiedAuthor (string()) – optional None

Adds a comment to the topic.

Return type

BCFComment

addViewpoint

BCFMarkup.addViewpoint(guid[, viewpointFilename[, snapshotFilename[, index]]])
Arguments

  • guid (string()) – None

  • viewpointFilename (string()) – optional None

  • snapshotFilename (string()) – optional None

  • index (string()) – optional None

Return type

void

deleteComment

BCFMarkup.deleteComment(guid)
Arguments

  • guid (string()) – None

Deletes a comment from the topic..

Return type

void

export

BCFMarkup.export()
Returns

XML document containing the markup data.

Return type

XMLDocument

getComments

BCFMarkup.getComments()

Gets a map of GUIDs and corresponding comments.

Return type

Map <string, BCFComment>

getFilename

BCFMarkup.getFilename()

Gets the Markup filename.

Return type

string

getMarkupHeaderFiles

BCFMarkup.getMarkupHeaderFiles()
Returns

a list of [[BCFMarkupHeaderFile]] containing data related to IFC files.

Return type

[BCFMarkupHeaderFile]

getProjectGuid

BCFMarkup.getProjectGuid()
Returns

the project GUID.

Return type

null | string

getTopicAssignedTo

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

null | string

getTopicCreationAuthor

BCFMarkup.getTopicCreationAuthor()

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

Return type

string

getTopicCreationDate

BCFMarkup.getTopicCreationDate()

Gets the creation date of the markup topic.

Return type

Date

getTopicDescription

BCFMarkup.getTopicDescription()

Description of the topic.

Return type

null | string

getTopicDueDate

BCFMarkup.getTopicDueDate()

Date when the issue needs to be resolved by.

Return type

null | Date

getTopicId

BCFMarkup.getTopicId()

Gets the topic id.

Return type

string

getTopicIndex

BCFMarkup.getTopicIndex()

Number to maintain the order of the topics.

Return type

null | number

getTopicLabels

BCFMarkup.getTopicLabels()

Tags for grouping Topics.

Return type

[string]

getTopicModifiedAuthor

BCFMarkup.getTopicModifiedAuthor()

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

Return type

null | string

getTopicModifiedDate

BCFMarkup.getTopicModifiedDate()

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

Return type

null | Date

getTopicPriority

BCFMarkup.getTopicPriority()

Gets the topic priority.

Return type

null | string

getTopicStage

BCFMarkup.getTopicStage()

Stage this topic is part of.

Return type

null | string

getTopicStatus

BCFMarkup.getTopicStatus()

Gets the topic status.

Return type

null | string

getTopicTitle

BCFMarkup.getTopicTitle()

Gets the title of the markup topic.

Return type

string

getTopicType

BCFMarkup.getTopicType()

Gets the topic type.

Return type

null | string

getViewpoints

BCFMarkup.getViewpoints()

Gets a map of GUIDs and corresponding viewpoints.

Return type

Map <string, BCFMarkupViewpoint>

setTopicAssignedTo

BCFMarkup.setTopicAssignedTo(assignedTo)
Arguments

  • assignedTo (null | string()) – None

Sets the user that the topic is assigned to.

Return type

void

setTopicCreationAuthor

BCFMarkup.setTopicCreationAuthor(author)
Arguments

  • author (string()) – None

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

Return type

void

setTopicCreationDate

BCFMarkup.setTopicCreationDate(date)
Arguments

  • date (Date()) – None

Sets the creation date of the markup topic;

Return type

void

setTopicDescription

BCFMarkup.setTopicDescription(description)
Arguments

  • description (null | string()) – None

Sets the topic description;

Return type

void

setTopicDueDate

BCFMarkup.setTopicDueDate(date)
Arguments

  • date (null | Date()) – None

Sets the topic due date.

Return type

void

setTopicId

BCFMarkup.setTopicId(guid)
Arguments

  • guid (string()) – None

Sets the topic id.

Return type

void

setTopicIndex

BCFMarkup.setTopicIndex(index)
Arguments

  • index (null | number()) – None

Sets the topic index.

Return type

void

setTopicLabels

BCFMarkup.setTopicLabels(labels)
Arguments

  • labels ([string]()) – None

Sets the topic labels.

Return type

void

setTopicModifiedAuthor

BCFMarkup.setTopicModifiedAuthor(modifiedAuthor)
Arguments

  • modifiedAuthor (null | string()) – None

Sets the author that last modified the topic.

Return type

void

setTopicModifiedDate

BCFMarkup.setTopicModifiedDate(date)
Arguments

  • date (null | Date()) – None

Sets the topic modified date.

Return type

void

setTopicPriority

BCFMarkup.setTopicPriority(priority)
Arguments

  • priority (null | string()) – None

Sets the topic priority.

Return type

void

setTopicState

BCFMarkup.setTopicState(stage)
Arguments

  • stage (null | string()) – None

Sets the topic stage;

Return type

void

setTopicStatus

BCFMarkup.setTopicStatus(topicStatus)
Arguments

  • topicStatus (null | string()) – None

Sets the topic status.

Return type

void

setTopicTitle

BCFMarkup.setTopicTitle(title)
Arguments

  • title (string()) – None

Sets the title of the markup topic.

Return type

void

setTopicType

BCFMarkup.setTopicType(topicType)
Arguments

  • topicType (null | string()) – None

Sets the topic type.

Return type

void

updateComment

BCFMarkup.updateComment(comment)
Arguments

Updates a topic comment.

Return type

void