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.

237 lines
7.0 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, ParmDefRevision
Filename: ParmDefRevision.hxx
Module: ccdm
@BMIDE autogenerated
==================================================================================================*/
#ifndef CCDM__PARMDEFREVISION__HXX
#define CCDM__PARMDEFREVISION__HXX
#include <unidefs.h>
#include <string>
#include <common/tc_deprecation_macros.h>
#include <tccore/ItemRevision.hxx>
#include <ccdm/libccdm_exports.h>
namespace ccdm
{
class ParmDefRevision;
}
namespace ccdm
{
class ParmDefRevisionImpl;
}
namespace ccdm
{
class ParmDefRevisionDelegate;
}
namespace ccdm
{
class ParmDefRevisionDispatch;
}
namespace ccdm
{
class ParmDefRevisionGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class CCDM_API ccdm::ParmDefRevision
: public ::Teamcenter::ItemRevision
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// Getter for a Tag Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCcd0ConversionRule( tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getComment( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 8.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getControlEngineer( tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getParmDescriptor( std::string &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 8.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getSize( int &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getSizeUnits( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 8.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getUserData( tag_t &value, bool &isNull ) const;
///
/// Setter for a Tag Property
/// @version Teamcenter 9.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 setCcd0ConversionRule( const tag_t &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.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 setComment( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Teamcenter 8.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 setControlEngineer( const tag_t &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.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 setParmDescriptor( const std::string &value, bool isNull=false );
///
/// Setter for an Integer Property
/// @version Teamcenter 8.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 setSize( int value, bool isNull=false );
///
/// Setter for a string Property
/// @version Teamcenter 8.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 setSizeUnits( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Teamcenter 8.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 setUserData( const tag_t &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
ParmDefRevision();
/**
* Destructor
*/
virtual ~ParmDefRevision();
private:
// Getter method for the Implementation Object
ParmDefRevisionImpl* getParmDefRevisionImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setParmDefRevisionImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
ParmDefRevisionImpl* m_parmdefrevisionImpl;
// 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 ParmDefRevision - desc for ParmDefRevision parameter
*/
ParmDefRevision( const ParmDefRevision& );
ParmDefRevision& operator=( const ParmDefRevision& );
friend class ParmDefRevisionDelegate;
friend class ParmDefRevisionDispatch;
friend class ParmDefRevisionGenImpl;
};
#include <ccdm/libccdm_undef.h>
#endif // CCDM__PARMDEFREVISION__HXX