|
CFx SDK Documentation 2024 SP0
|
#include <BcfSession.h>
Public Types | |
| enum | eSortParameter { kSortParameter_Guid = 0 , kSortParameter_CreationDate , kSortParameter_ModifiedDate , kSortParameter_Index } |
| typedef std::pair< OdArray< OdString >, OdString > | ComponentColoring |
| typedef OdArray< ComponentColoring > | ComponentColoringArray |
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdBcfSession) | |
| void | setAuthor (const OdString &author) |
| OdResult | setProgressMeter (OdDbHostAppProgressMeter *pMeter) |
| void | saveProject (const OdString &projectId, const OdString &fileName=OdString(), OdBcfDataAccessorPtr pDataAccessor=OdBcfDataAccessorPtr(), OdResult *result=NULL) |
| OdString | loadProject (const OdString &fileName, OdBcfDataAccessorPtr pDataAccessor=OdBcfDataAccessorPtr(), OdResult *result=NULL) |
| OdString | addArchive (const OdBcfArchivePtr &pArchive, OdResult *result=NULL) |
| OdBcfArchivePtr | getArchive (const OdString &projectId, OdResult *result=NULL) |
| bool | validateArchive (const OdString &projectId, OdResult *result=NULL) const |
| OdBcfArchivePtr | removeArchive (const OdString &projectId, OdResult *result=NULL) |
| OdBcfTopicFolderArray | getTopics (const OdString &projectId, eSortParameter sortParameter=kSortParameter_Guid, OdResult *result=NULL) |
| OdGUID | addTopicFolder (const OdString &projectId, const OdBcfTopicFolderPtr &pTopicFolder, OdResult *result=NULL) |
| OdBcfTopicFolderPtr | getTopicFolder (const OdString &projectId, const OdGUID &topicId, OdResult *result=NULL) |
| void | removeTopicFolder (const OdString &projectId, const OdGUID &topicId, OdResult *result=NULL) |
| void | addComment (const OdString &projectId, const OdGUID &topicId, const OdString &comment, OdResult *result=NULL) |
| void | editComment (const OdString &projectId, const OdGUID &topicId, const OdGUID &commentId, const OdString &comment, OdResult *result=NULL) |
| void | deleteComment (const OdString &projectId, const OdGUID &topicId, const OdGUID &commentId, OdResult *result=NULL) |
| void | addScreenshot (const OdString &projectId, const OdGUID &topicId, const OdString &fileName, const char *data, unsigned int size, OdResult *result=NULL) |
| OdString | getScreenshot (const OdString &projectId, const OdGUID &topicId, const OdString &fileName=OdString(), OdResult *result=NULL) |
| OdBcfProjectPtr | createProject (const OdBcfProjectData *pProjectData, OdResult *result=NULL) const |
| OdBcfProjectExtensionPtr | createProjectExtension (const OdBcfProjectExtensionData *pProjectExtensionData, OdResult *result=NULL) const |
| OdBcfVersionPtr | createVersion (OdResult *result=NULL) const |
| OdBcfTopicPtr | createTopic (const OdBcfTopicData *pTopicData, OdResult *result=NULL) const |
| OdBcfViewSetupHintsPtr | createViewSetupHints (OdResult *result=NULL) const |
| OdBcfComponentSelectionPtr | createComponentSelection (const OdArray< OdString > &ifcGuids, OdResult *result=NULL) const |
| OdBcfComponentVisibilityPtr | createComponentVisibility (const OdArray< OdString > &ifcGuids, bool defaultVisibility=false, OdResult *result=NULL) const |
| OdBcfComponentColoringPtr | createComponentColoring (const ComponentColoringArray &componentColoring, OdResult *result=NULL) const |
| OdBcfBitmapPtr | createBitmap (const OdBcfBitmapData *pBitmapData, OdResult *result=NULL) const |
| OdBcfVisualizationInfoPtr | createVisualizationInfo (const OdBcfVisualizationInfoData *pVisualizationInfoData, const OdString &visInfoFileName, const OdString &screenshotFileName, OdBcfMarkupPtr pMarkup, OdInt32 viewPointIndex=OdBcf::Utils::getUnset< OdInt32 >(), OdResult *result=NULL) const |
| void | deleteViewpoint (const OdString &projectId, const OdGUID &topicId, const OdGUID &viewpointId, OdResult *result=NULL) |
Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () const |
| virtual void | addRef ()=0 |
| virtual void | release ()=0 |
| virtual long | numRefs () const |
| bool | isKindOf (const OdRxClass *pClass) const |
| virtual OdRxObjectPtr | clone () const |
| virtual void | copyFrom (const OdRxObject *pSource) |
| virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
| virtual bool | isEqualTo (const OdRxObject *pOther) const |
Static Public Member Functions | |
| static OdSmartPtr< OdBcfSession > | createObject (const OdString &author, const OdString &authoringToolId, const OdBcfDataAccessorPtr &pDataAccessor=OdBcfDataAccessorPtr()) |
| static OdGUID | getTopicId (const OdBcfTopicFolderPtr &pTopicFolder, OdResult *result=NULL) |
Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Protected Member Functions | |
| const OdBcfComponentPtr | createComponent (const OdString &ifcGuid) const |
| OdBcfComponentArray | createComponents (const OdArray< OdString > &ifcGuids) const |
| OdBcfColorPtr | createColor (const OdArray< OdString > &ifcGuids, const OdString &color) const |
Protected Attributes | |
| OdString | m_author |
| OdString | m_authoringToolId |
| OdBcfDataAccessorPtr | m_pDataAccessor |
| OdBcfArchiveMap | m_archives |
| OdDbHostAppProgressMeter * | m_pMeter |
A class that provides functionality for managing a session for work with BCF data.
Definition at line 124 of file BcfSession.h.
| typedef std::pair<OdArray<OdString>, OdString> OdBcf::OdBcfSession::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.
Definition at line 398 of file BcfSession.h.
A data type that represents an ODA array of <link OdBcf::OdBcfSession::ComponentColoring, ComponentColoring> objects.
Definition at line 403 of file BcfSession.h.
Enumerates supported sort orders within the session.
Definition at line 219 of file BcfSession.h.
| OdString OdBcf::OdBcfSession::addArchive | ( | const OdBcfArchivePtr & | pArchive, |
| OdResult * | result = NULL |
||
| ) |
Adds an existing archive object to the session collection.
| pArchive | [in] A smart pointer to the archive object. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::addComment | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdString & | comment, | ||
| OdResult * | result = NULL |
||
| ) |
Adds comment to a topic with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| comment | [in] A string that contains comment text. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::addScreenshot | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdString & | fileName, | ||
| const char * | data, | ||
| unsigned int | size, | ||
| OdResult * | result = NULL |
||
| ) |
Adds a screenshot to a specified topic folder object.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| fileName | [in] A string that contains the file name to use for the saving operation. |
| data | [in] A pointer to a data buffer that contains the file data. |
| size | [in] A length of the data buffer that contains the file data. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdGUID OdBcf::OdBcfSession::addTopicFolder | ( | const OdString & | projectId, |
| const OdBcfTopicFolderPtr & | pTopicFolder, | ||
| OdResult * | result = NULL |
||
| ) |
Adds an existing topic folder object to a specified project.
| projectId | [in] A string that contains the project identifier. |
| pTopicFolder | [in] A smart pointer to the topic folder object. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfBitmapPtr OdBcf::OdBcfSession::createBitmap | ( | const OdBcfBitmapData * | pBitmapData, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new bitmap instance.
| pBitmapData | [in] A pointer to a variable containing initial values for instance initialization. |
| result | [out] A pointer to variable containing result of operation. |
|
protected |
|
protected |
| OdBcfComponentColoringPtr OdBcf::OdBcfSession::createComponentColoring | ( | const ComponentColoringArray & | componentColoring, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new component coloring instance.
| componentColoring | [in] An array of ComponentColoring objects for instance initialization. |
| result | [out] A pointer to variable containing result of operation. |
|
protected |
| OdBcfComponentSelectionPtr OdBcf::OdBcfSession::createComponentSelection | ( | const OdArray< OdString > & | ifcGuids, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new component selection instance.
| ifcGuids | [in] An array of strings that contains GUIDs for the instance initialization. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfComponentVisibilityPtr OdBcf::OdBcfSession::createComponentVisibility | ( | const OdArray< OdString > & | ifcGuids, |
| bool | defaultVisibility = false, |
||
| OdResult * | result = NULL |
||
| ) | const |
Creates a new component visibility instance.
| ifcGuids | [in] An array of strings that contains GUIDs for the instance initialization. |
| defaultVisibility | [in] A flag that determines whether the components are visible by default (if it is equal to true) or hidden (if it is equal to false). |
| result | [out] A raw pointer to a value that contains the result of the operation. |
|
static |
Creates a new session object.
| author | [in] A string that contains the session author. |
| authoringToolId | [in] A string that contains the identifier of the authoring application used by the author. |
| pDataAccessor | [in] A smart pointer to a data accessor object. |
| OdBcfProjectPtr OdBcf::OdBcfSession::createProject | ( | const OdBcfProjectData * | pProjectData, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new project instance.
| pProjectData | [in] A aw pointer to an object that contains values for the instance initialization. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfProjectExtensionPtr OdBcf::OdBcfSession::createProjectExtension | ( | const OdBcfProjectExtensionData * | pProjectExtensionData, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new project extension instance.
| pProjectExtensionData | [in] A raw pointer to an object that contains values for the instance initialization. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfTopicPtr OdBcf::OdBcfSession::createTopic | ( | const OdBcfTopicData * | pTopicData, |
| OdResult * | result = NULL |
||
| ) | const |
Creates a new topic instance.
| pTopicData | [in] A raw pointer to an object that contains values for the instance initialization. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfVersionPtr OdBcf::OdBcfSession::createVersion | ( | OdResult * | result = NULL | ) | const |
Creates a new version instance.
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfViewSetupHintsPtr OdBcf::OdBcfSession::createViewSetupHints | ( | OdResult * | result = NULL | ) | const |
Creates a new view setup hints instance.
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfVisualizationInfoPtr OdBcf::OdBcfSession::createVisualizationInfo | ( | const OdBcfVisualizationInfoData * | pVisualizationInfoData, |
| const OdString & | visInfoFileName, | ||
| const OdString & | screenshotFileName, | ||
| OdBcfMarkupPtr | pMarkup, | ||
| OdInt32 | viewPointIndex = OdBcf::Utils::getUnset< OdInt32 >(), |
||
| OdResult * | result = NULL |
||
| ) | const |
Creates a new visualization info instance.
| pVisualizationInfoData | [in] A pointer to a variable containing initial values for instance initialization. |
| visInfoFileName | [in] A string containing visualization information file name. |
| screenshotFileName | [in] A string containing screenshot file name. |
| pMarkup | [out] A pointer to a existing markup data for visualization information initialization. |
| result | [out] A pointer to variable containing result of operation. |
| void OdBcf::OdBcfSession::deleteComment | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdGUID & | commentId, | ||
| OdResult * | result = NULL |
||
| ) |
Delete the comment from the topic with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| commentId | [in] A GUID of the comment. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::deleteViewpoint | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdGUID & | viewpointId, | ||
| OdResult * | result = NULL |
||
| ) |
Delete the viewpoint from the topic with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| viewpointId | [in] A GUID of the viewpoint. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::editComment | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdGUID & | commentId, | ||
| const OdString & | comment, | ||
| OdResult * | result = NULL |
||
| ) |
Edit the comment from the topic with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| commentId | [in] A GUID of the comment. |
| comment | [in] A string that contains the new comment text. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfArchivePtr OdBcf::OdBcfSession::getArchive | ( | const OdString & | projectId, |
| OdResult * | result = NULL |
||
| ) |
Retrieves an archive with the specified identifier.
| projectId | [in] A string that contains the project identifier. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdString OdBcf::OdBcfSession::getScreenshot | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| const OdString & | fileName = OdString(), |
||
| OdResult * | result = NULL |
||
| ) |
Constructs the path to the screenshot of a specified topic.
| projectId | [in] A string containing project Id. |
| topicId | [in] A GUID of the topic folder. |
| fileName | [in] A string that contains the full file name of the screenshot. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfTopicFolderPtr OdBcf::OdBcfSession::getTopicFolder | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| OdResult * | result = NULL |
||
| ) |
Retrieves the topic folder object with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
|
static |
Returns an OdGUID of topic folder.
| pTopicFolder | [in] A smart pointer to the topic folder object. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcfTopicFolderArray OdBcf::OdBcfSession::getTopics | ( | const OdString & | projectId, |
| eSortParameter | sortParameter = kSortParameter_Guid, |
||
| OdResult * | result = NULL |
||
| ) |
Retrieves the topic folders of a specified project.
| projectId | [in] A string that contains the project identifier. |
| sortParameter | [in] A sort type for the output topic folders list. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdString OdBcf::OdBcfSession::loadProject | ( | const OdString & | fileName, |
| OdBcfDataAccessorPtr | pDataAccessor = OdBcfDataAccessorPtr(), |
||
| OdResult * | result = NULL |
||
| ) |
Loads an archive using a specified data accessor.
| fileName | [in] A string that contains the full file name to load. |
| pDataAccessor | [in] A smart pointer to the data accessor to use for loading. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| OdBcf::OdBcfSession::ODRX_DECLARE_MEMBERS | ( | OdBcfSession | ) |
| OdBcfArchivePtr OdBcf::OdBcfSession::removeArchive | ( | const OdString & | projectId, |
| OdResult * | result = NULL |
||
| ) |
Removes the archive with a specified identifier.
| projectId | [in] A string that contains the project identifier. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::removeTopicFolder | ( | const OdString & | projectId, |
| const OdGUID & | topicId, | ||
| OdResult * | result = NULL |
||
| ) |
Removes a topic folder object with a specified GUID from a specified project.
| projectId | [in] A string that contains the project identifier. |
| topicId | [in] A GUID of the topic folder object. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
| void OdBcf::OdBcfSession::saveProject | ( | const OdString & | projectId, |
| const OdString & | fileName = OdString(), |
||
| OdBcfDataAccessorPtr | pDataAccessor = OdBcfDataAccessorPtr(), |
||
| OdResult * | result = NULL |
||
| ) |
Saves the archive using a specified data accessor object.
| projectId | [in] A string that contains the project Id. |
| fileName | [in] A string that contains the file name to use for the saving. |
| pDataAccessor | [in] A smart pointer to the data accessor object that should be used for the saving. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
Sets a new session author.
| author | [in] A string that contains the session author. |
| OdResult OdBcf::OdBcfSession::setProgressMeter | ( | OdDbHostAppProgressMeter * | pMeter | ) |
Sets a progress meter.
| pMeter | [in] A pointer to progress meter. |
| bool OdBcf::OdBcfSession::validateArchive | ( | const OdString & | projectId, |
| OdResult * | result = NULL |
||
| ) | const |
Validates the archive with a specified identifier.
| projectId | [in] A string that contains the project Id. |
| result | [out] A raw pointer to a value that contains the result of the operation. |
|
protected |
Definition at line 455 of file BcfSession.h.
|
protected |
Definition at line 452 of file BcfSession.h.
|
protected |
Definition at line 453 of file BcfSession.h.
|
protected |
Definition at line 454 of file BcfSession.h.
|
protected |
Definition at line 456 of file BcfSession.h.