OdBcfSession Class

Class Hierarchy

Syntax

C++

class OdBcfSession : public OdRxObject;

File

BcfSession.h

Description

A class that provides functionality for managing a session for work with BCF data.

Group

Classes

OdBcfSession Enumerations

eSortParameter

Enumerates supported sort orders within the session.

OdBcfSession Methods

addArchive	Adds an existing archive object to the session collection.
addComment	Adds comment to a topic with a specified GUID from a specified project.
addScreenshot	Adds a screenshot to a specified topic folder object.
addTopicFolder	Adds an existing topic folder object to a specified project.
createBitmap	Creates a new bitmap instance.
createComponentColoring	Creates a new component coloring instance.
createComponentSelection	Creates a new component selection instance.
createComponentVisibility	Creates a new component visibility instance.
createObject	Creates a new session object.
createProject	Creates a new project instance.
createProjectExtension	Creates a new project extension instance.
createTopic	Creates a new topic instance.
createVersion	Creates a new version instance.
createViewSetupHints	Creates a new view setup hints instance.
createVisualizationInfo	Creates a new visualization info instance.
deleteComment	Delete the comment from the topic with a specified GUID from a specified project.
deleteViewpoint	Delete the viewpoint from the topic with a specified GUID from a specified project.
editComment	Edit the comment from the topic with a specified GUID from a specified project.
getArchive	Retrieves an archive with the specified identifier.
getScreenshot	Constructs the path to the screenshot of a specified topic.
getTopicFolder	Retrieves the topic folder object with a specified GUID from a specified project.
getTopicId	Returns an OdGUID of topic folder.
getTopics	Retrieves the topic folders of a specified project.
loadProject	Loads an archive using a specified data accessor.
removeArchive	Removes the archive with a specified identifier.
removeTopicFolder	Removes a topic folder object with a specified GUID from a specified project.
saveProject	Saves the archive using a specified data accessor object.
setAuthor	Sets a new session author.
setProgressMeter	Sets a progress meter.
validateArchive	Validates the archive with a specified identifier.

OdBcfSession Nested Types

ComponentColoring	A data type that represents an STD pair containing an array of strings with component GUIDs and a string that represents a color value.
ComponentColoringArray	A data type that represents an ODA array of ComponentColoring objects.

Send feedback about this topic