OdBcfSession Class

Syntax

C++

class OdBcfSession : public OdRxObject;

Description

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

Class Hierarchy

File: Bcf_3_0Session.h

Namespace: OdBcf_3_0

Classes

ComponentColoring

A data type that represents a class containing arrays of strings with component GUIDs, originatingSystems and uthoringToolIds with a string that represents a color value.

Enumerations

eSortParameter

Enumerates supported sort orders within the session.

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.
createComment	Creates a new comment 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.
createProjectInfo	Creates a new project info 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.
setAuthoringToolId	Sets a new session authoring tool id.
setProgressMeter	Sets a progress meter.
validateArchive	Validates the archive with a specified identifier.

Nested Types

ComponentColoringArray

A data type that represents an ODA array of ComponentColoring objects.

Links

OdBcfSession Classes
OdBcfSession Enumerations
OdBcfSession Methods
OdBcfSession Nested Types

Relief for ODA Team in Ukraine