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.
346 lines
13 KiB
346 lines
13 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, Mdl0ConditionalElement
|
|
Filename: Mdl0ConditionalElement.hxx
|
|
Module: mdl0model
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__APPMODEL__MDL0CONDITIONALELEMENT__HXX
|
|
#define TEAMCENTER__APPMODEL__MDL0CONDITIONALELEMENT__HXX
|
|
|
|
#include <metaframework/ReviseInput.hxx>
|
|
#include <metaframework/DeepCopyData.hxx>
|
|
#include <metaframework/BulkInput.hxx>
|
|
#include <metaframework/BulkData.hxx>
|
|
#include <metaframework/SaveAsInput.hxx>
|
|
#include <unidefs.h>
|
|
#include <string>
|
|
#include <vector>
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <mdl0model/Mdl0ModelElement.hxx>
|
|
|
|
#include <mdl0model/libmdl0model_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
namespace AppModel
|
|
{
|
|
class Mdl0ConditionalElement;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace AppModel
|
|
{
|
|
class Mdl0ConditionalElementImpl;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace AppModel
|
|
{
|
|
class Mdl0ConditionalElementDelegate;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace AppModel
|
|
{
|
|
class Mdl0ConditionalElementDispatch;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace AppModel
|
|
{
|
|
class Mdl0ConditionalElementGenImpl;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class RootObjectImpl;
|
|
}
|
|
|
|
class MDL0MODEL_API Teamcenter::AppModel::Mdl0ConditionalElement
|
|
: public ::Teamcenter::AppModel::Mdl0ModelElement
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Get the Interface Name
|
|
* @return - return desc for getInterfaceName
|
|
*/
|
|
static const std::string& getInterfaceName();
|
|
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 9
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getMdl0allowed_eff_formula( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string 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 getMdl0allowed_var_formula( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 9
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getMdl0effectivity_formula( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Teamcenter 9
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getMdl0is_revisable( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Teamcenter 11.2
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getMdl0IsConfigured( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 9
|
|
/// @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 getMdl0sibling_revisions( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string 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 getMdl0variant_formula( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 9
|
|
/// @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 setMdl0effectivity_formula( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 10.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 setMdl0variant_formula( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Finalize operation input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Desc
|
|
/// @param vecDeepCopyData - Desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int finalizeReviseInput( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.3
|
|
/// @param inputs - A vector of data that contains reference information to the objects to be revised
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return -
|
|
///
|
|
static int fnd0FinalizeReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.3
|
|
/// @param inputs - A vector of data that contains reference information to the objects to be revised
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return -
|
|
///
|
|
static int fnd0Revise( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.3
|
|
/// @param inputs - A vector of data that contains reference information to the objects to be revised
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return -
|
|
///
|
|
static int fnd0RevisePost( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.3
|
|
/// @param inputs - A vector of data that contains reference information to the objects to be revised
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return -
|
|
///
|
|
static int fnd0SetPropertiesFromReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
///
|
|
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
|
|
/// @version Teamcenter 11.2.3
|
|
/// @param inputs - A vector of data that contains reference information to the objects to be revised
|
|
/// @param bd - A data structure to store objects and other information relevant for set-based operation
|
|
/// @return -
|
|
///
|
|
static int fnd0ValidateReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
|
|
|
|
///
|
|
/// similar to finalizeSaveAsInputBase, this method allows for final changes to the revise descriptor before actually performing the revise
|
|
/// @version Teamcenter 9
|
|
/// @param pSavAsInput - saveAs input
|
|
/// @param vecDeepCopyData - vector of deep copy data for revise
|
|
/// @deprecated #Teamcenter::AppModel::Mdl0ConditionalElement::mdl0finalizeReviseInput deprecated in Teamcenter 11.2
|
|
/// @return - SaveAsInput is updated
|
|
///
|
|
TC_DEPRECATED_WITH_DEPRECATION_INFO("Teamcenter 11.2","Teamcenter::AppModel::Mdl0ConditionalElement::mdl0finalizeReviseInput","This operation is deprecated in Teamcenter 11.2 and will be removed in Teamcenter 13. Please use finalizeReviseInput operation instead.")
|
|
int mdl0finalizeReviseInput( ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
///
|
|
/// major revise in CPD
|
|
/// @version Teamcenter 9
|
|
/// @param pReviseInput - saveAs descriptor
|
|
/// @param vecDeepCopyData - list of deep copy datas
|
|
/// @param newObjTag - resulting tag of revised object
|
|
/// @deprecated #Teamcenter::AppModel::Mdl0ConditionalElement::mdl0Revise deprecated in Teamcenter 11.2
|
|
/// @return - returns status
|
|
///
|
|
TC_DEPRECATED_WITH_DEPRECATION_INFO("Teamcenter 11.2","Teamcenter::AppModel::Mdl0ConditionalElement::mdl0Revise","This operation is deprecated in Teamcenter 11.2 and will be removed in Teamcenter 13. Please use revise operation instead.")
|
|
int mdl0Revise( ::Teamcenter::SaveAsInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag );
|
|
|
|
///
|
|
/// post for major revise in CPD
|
|
/// @version Teamcenter 9
|
|
/// @param pReviseInput - saveAs descriptor
|
|
/// @param vecDeepCopyData - list of deep copy datas
|
|
/// @deprecated #Teamcenter::AppModel::Mdl0ConditionalElement::mdl0RevisePost deprecated in Teamcenter 11.2
|
|
/// @return - returns status
|
|
///
|
|
TC_DEPRECATED_WITH_DEPRECATION_INFO("Teamcenter 11.2","Teamcenter::AppModel::Mdl0ConditionalElement::mdl0RevisePost","This operation is deprecated in Teamcenter 11.2 and will be removed in Teamcenter 13. Please use revisePost operation instead.")
|
|
int mdl0RevisePost( ::Teamcenter::SaveAsInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
///
|
|
/// operation for creating/setting values to shadow object during revise
|
|
/// @version Teamcenter 11.1
|
|
/// @param pReviseInput - Revise Input
|
|
/// @param newShObjTag - new shadow object created during revise
|
|
/// @return - error number
|
|
///
|
|
int mdl0ReviseShadowObject( ::Teamcenter::ReviseInput *pReviseInput, tag_t *newShObjTag );
|
|
|
|
///
|
|
/// Revise operation.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Desc
|
|
/// @param vecDeepCopyData - Desc
|
|
/// @param newObjTag - Desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int revise( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag );
|
|
|
|
///
|
|
/// Generic revisePost operation.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Desc
|
|
/// @param vecDeepCopyData - Desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int revisePost( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
|
|
///
|
|
/// Set properties from revise input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int setPropertiesFromReviseInput( ::Teamcenter::ReviseInput *pReviseInput );
|
|
|
|
///
|
|
/// Validate revise input.
|
|
/// @version Teamcenter 10.1
|
|
/// @param pReviseInput - Desc
|
|
/// @param vecDeepCopyData - Desc
|
|
/// @return - Returns an int.
|
|
///
|
|
int validateReviseInput( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
|
|
protected:
|
|
// Method to initialize
|
|
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
Mdl0ConditionalElement();
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~Mdl0ConditionalElement();
|
|
|
|
private:
|
|
// Getter method for the Implementation Object
|
|
Mdl0ConditionalElementImpl* getMdl0ConditionalElementImpl() const;
|
|
// Setter method for the Implementation Object
|
|
::Teamcenter::RootObjectImpl* setMdl0ConditionalElementImpl( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
// Method to set the delete impl boolean
|
|
void setDeleteImpl( bool del );
|
|
|
|
// Pointer to the Implementation object
|
|
Mdl0ConditionalElementImpl* m_mdl0conditionalelementImpl;
|
|
|
|
// 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 Mdl0ConditionalElement - desc for Mdl0ConditionalElement parameter
|
|
*/
|
|
Mdl0ConditionalElement( const Mdl0ConditionalElement& );
|
|
Mdl0ConditionalElement& operator=( const Mdl0ConditionalElement& );
|
|
|
|
friend class Mdl0ConditionalElementDelegate;
|
|
friend class Mdl0ConditionalElementDispatch;
|
|
friend class Mdl0ConditionalElementGenImpl;
|
|
};
|
|
|
|
#include <mdl0model/libmdl0model_undef.h>
|
|
#endif // TEAMCENTER__APPMODEL__MDL0CONDITIONALELEMENT__HXX
|