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.

381 lines
14 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, Cpd0DesignModelElementDelegate
Filename: Cpd0DesignModelElementDelegate.hxx
Module: cpd0cd
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__CPD__CPD0DESIGNMODELELEMENTDELEGATE_HXX
#define TEAMCENTER__CPD__CPD0DESIGNMODELELEMENTDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <cpd0cd/Cpd0DesignModelElement.hxx>
#include <cpd0cd/libcpd0cd_exports.h>
namespace Teamcenter
{
namespace Cpd
{
class Cpd0DesignModelElementDelegate;
}
}
namespace Teamcenter
{
namespace Cpd
{
class Cpd0DesignModelElementImpl;
}
}
namespace Teamcenter
{
namespace Cpd
{
class Cpd0DesignModelElement;
}
}
namespace Teamcenter
{
namespace Cpd
{
class Cpd0DesignModelElementGenImpl;
}
}
namespace Teamcenter_alias = ::Teamcenter;
class CPD0CD_API Teamcenter_alias::Cpd::Cpd0DesignModelElementDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the Cpd0DesignModelElementDelegate instance
static Cpd0DesignModelElementDelegate& getInstance();
// Method to create the Cpd0DesignModelElementImpl pointer
static Cpd0DesignModelElementImpl* createImpl( Cpd0DesignModelElement& ifObj );
// Method to delete the Cpd0DesignModelElementImpl pointer
static void deleteImpl( Cpd0DesignModelElementImpl* impl );
///
/// 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 getCpd0categoryBase(const Cpd0DesignModelElement &ifObj, std::string &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 getCpd0connected_featuresBase(const Cpd0DesignModelElement &ifObj, std::vector< tag_t > &values, std::vector< int > &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 getCpd0design_element_idBase(const Cpd0DesignModelElement &ifObj, 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 getCpd0id_in_parentBase(const Cpd0DesignModelElement &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 9
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCpd0instanceBase(const Cpd0DesignModelElement &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 11.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCpd0is_leafBase(const Cpd0DesignModelElement &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 9
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCpd0presented_parentBase(const Cpd0DesignModelElement &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 11.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCpd0source_objectBase(const Cpd0DesignModelElement &ifObj, tag_t &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 setCpd0categoryBase(Cpd0DesignModelElement &ifObj, const std::string &value, bool isNull );
///
/// 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 setCpd0design_element_idBase(Cpd0DesignModelElement &ifObj, const std::string &value, bool isNull );
///
/// 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 setCpd0id_in_parentBase(Cpd0DesignModelElement &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Teamcenter 11.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 setCpd0is_leafBase(Cpd0DesignModelElement &ifObj, bool value, bool isNull );
///
/// Setter for a Tag 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 setCpd0presented_parentBase(Cpd0DesignModelElement &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a Tag Property
/// @version Teamcenter 11.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 setCpd0source_objectBase(Cpd0DesignModelElement &ifObj, const tag_t &value, bool isNull );
///
/// desc for createPost
/// @version Tc 8
/// @param creInput - Description for the Create Input
/// @return - return desc for createPost
///
int createPostBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// Description for the Finalize Create Input
/// @version Tc 8
/// @param creInput - desc for creInput parameter
/// @return - Return desc for Initialize for Create
///
int finalizeCreateInputBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// Finalize operation input.
/// @version Teamcenter 10.1
/// @param pReviseInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns n int.
///
int finalizeReviseInputBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// finalize operation input
/// @version Teamcenter 9
/// @param pSavAsInput - desc
/// @param vecDeepCopyData - desc
/// @return - returns an int
///
int finalizeSaveAsInputBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, 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.4
/// @param inputs - 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 -
///
int fnd0CreatePostBase( 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.4
/// @param inputs - A vector of data that contains reference information to the object to be created
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0FinalizeCreateInputBase( 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 -
///
int fnd0FinalizeReviseInputBase( 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 object to be saved
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0FinalizeSaveAsInputBase( 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 -
///
int fnd0RevisePostBase( 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.2
/// @param inputs - 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 on success. Otherwise, it will return specific error code.
///
int fnd0SaveBase( 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.4
/// @param inputs - A vector of data that contains reference information to the object to be created
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return -
///
int fnd0ValidateCreateInputBase( 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 mdl0finalizeReviseInputBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::SaveAsInput *pSavAsInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// 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 mdl0RevisePostBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::SaveAsInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// Generic revisePost operation.
/// @version Teamcenter 10.1
/// @param pReviseInput - Input ReviseInput object.
/// @param vecDeepCopyData - Vector of deep copy data.
/// @return - Returns an integer value.
///
int revisePostBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData );
///
/// desc for validate for create
/// @version Tc 8
/// @param creInput - desc for creInput parameter
/// @return - ret desc for validate for create
///
int validateCreateInputBase(const Cpd0DesignModelElement &ifObj, ::Teamcenter::CreateInput *creInput );
protected:
// Pointer to the instance
static Cpd0DesignModelElementDelegate* m_pInstance;
Cpd0DesignModelElementDelegate();
virtual ~Cpd0DesignModelElementDelegate();
static void setInstance( Cpd0DesignModelElementDelegate* instance );
private:
friend class ::Teamcenter::Cpd::Cpd0DesignModelElementGenImpl;
};
#include <cpd0cd/libcpd0cd_undef.h>
#endif // TEAMCENTER__CPD__CPD0DESIGNMODELELEMENTDELEGATE_HXX