You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
285 lines
9.2 KiB
285 lines
9.2 KiB
//Copyright 2020 Siemens Digital Industries Software
|
|
//==================================================
|
|
//Copyright $2020.
|
|
//Siemens Product Lifecycle Management Software Inc.
|
|
//All Rights Reserved.
|
|
//==================================================
|
|
//Copyright 2020 Siemens Digital Industries Software
|
|
|
|
/*==================================================================================================
|
|
File description:
|
|
This file contains the declaration for the Business Object, Dataset
|
|
Filename: Dataset.hxx
|
|
Module: ae
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__DATASET__HXX
|
|
#define TEAMCENTER__DATASET__HXX
|
|
|
|
#include <vector>
|
|
#include <metaframework/BulkInput.hxx>
|
|
#include <metaframework/BulkData.hxx>
|
|
#include <unidefs.h>
|
|
#include <string>
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <tccore/WorkspaceObject.hxx>
|
|
|
|
#include <ae/libae_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class Dataset;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class DatasetImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class DatasetDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class DatasetDispatch;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class DatasetGenImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class RootObjectImpl;
|
|
}
|
|
|
|
class AE_API Teamcenter::Dataset
|
|
: public ::Teamcenter::WorkspaceObject
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Get the Interface Name
|
|
* @return - return desc for getInterfaceName
|
|
*/
|
|
static const std::string& getInterfaceName();
|
|
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getDataset_type( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10
|
|
/// @param values - Parameter value
|
|
/// @param isNull - Returns true for an array element if the parameter value at that location is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0FileAccessAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0IsCheckOutForSign( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFormat_used( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Parameter value
|
|
/// @param isNull - Returns true for an array element if the parameter value at that location is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getRef_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Parameter value
|
|
/// @param isNull - Returns true for an array element if the parameter value at that location is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getRef_names( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an Integer Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Parameter value
|
|
/// @param isNull - Returns true for an array element if the parameter value at that location is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getRef_types( std::vector< int > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getRev_chain_anchor( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getTool_used( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getUser_class( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Setter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setDataset_type( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setFormat_used( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Values to be set for the parameter
|
|
/// @param isNull - If array element is true, set the parameter value at that location as null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setRef_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for an string Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Values to be set for the parameter
|
|
/// @param isNull - If array element is true, set the parameter value at that location as null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setRef_names( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for an Integer Array Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param values - Values to be set for the paramter
|
|
/// @param isNull - If array element is true, set the parameter value at that location as null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setRef_types( const std::vector< int > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setRev_chain_anchor( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setTool_used( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 8.0.1
|
|
/// @param value - Value to be set for the parameter
|
|
/// @param isNull - If true, set the parameter value to null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int setUser_class( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// This operation saves the datasets without creating new dataset version.
|
|
/// @version Teamcenter 13.1
|
|
/// @param input - A vector of data that contains reference information to the object to be saved
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return - This operation returns ITK_ok if there is no error; otherwise, any error caught during the operation.
|
|
///
|
|
static int fnd0SaveMyself( std::vector< ::Teamcenter::BulkInput* > *input, ::Teamcenter::BulkData *bd );
|
|
protected:
|
|
// Method to initialize
|
|
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
Dataset();
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~Dataset();
|
|
|
|
private:
|
|
// Getter method for the Implementation Object
|
|
DatasetImpl* getDatasetImpl() const;
|
|
// Setter method for the Implementation Object
|
|
::Teamcenter::RootObjectImpl* setDatasetImpl( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
// Method to set the delete impl boolean
|
|
void setDeleteImpl( bool del );
|
|
|
|
// Pointer to the Implementation object
|
|
DatasetImpl* m_datasetImpl;
|
|
|
|
// Flag to indicate if Implementation object needs to be deleted
|
|
bool m_deleteImpl;
|
|
|
|
/**
|
|
* Name of the Business Object
|
|
*/
|
|
static std::string name;
|
|
|
|
/**
|
|
* Private default constructor. We do not want this class instantiated without the business object passed in.
|
|
* @param Dataset - desc for Dataset parameter
|
|
*/
|
|
Dataset( const Dataset& );
|
|
Dataset& operator=( const Dataset& );
|
|
|
|
friend class DatasetDelegate;
|
|
friend class DatasetDispatch;
|
|
friend class DatasetGenImpl;
|
|
};
|
|
|
|
#include <ae/libae_undef.h>
|
|
#endif // TEAMCENTER__DATASET__HXX
|