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.

352 lines
11 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, CPFinishProductRevision
Filename: CPFinishProductRevision.hxx
Module: fpmgmt
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__FPMGMT__CPFINISHPRODUCTREVISION__HXX
#define TEAMCENTER__FPMGMT__CPFINISHPRODUCTREVISION__HXX
#include <string>
#include <vector>
#include <unidefs.h>
#include <common/tc_deprecation_macros.h>
#include <tccore/ItemRevision.hxx>
#include <fpmgmt/libfpmgmt_exports.h>
namespace Teamcenter
{
namespace FPMGMT
{
class CPFinishProductRevision;
}
}
namespace Teamcenter
{
namespace FPMGMT
{
class CPFinishProductRevisionImpl;
}
}
namespace Teamcenter
{
namespace FPMGMT
{
class CPFinishProductRevisionDelegate;
}
}
namespace Teamcenter
{
namespace FPMGMT
{
class CPFinishProductRevisionDispatch;
}
}
namespace Teamcenter
{
namespace FPMGMT
{
class CPFinishProductRevisionGenImpl;
}
}
namespace Teamcenter
{
class RootObjectImpl;
}
class FPMGMT_API Teamcenter::FPMGMT::CPFinishProductRevision
: public ::Teamcenter::ItemRevision
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getChannel( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.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 getCP_trade_item( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getCurrency( std::string &value, bool &isNull ) const;
///
/// Getter for a Double Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDepth( double &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDimension_unit( tag_t &value, bool &isNull ) const;
///
/// Getter for a Double Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getGross_weight( double &value, bool &isNull ) const;
///
/// Getter for a Double Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getHeight( double &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMarket_clearance_no( std::string &value, bool &isNull ) const;
///
/// Getter for a Double Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getPrice( double &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getShelf_life( std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getStorage_conditions( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getWeight_unit( tag_t &value, bool &isNull ) const;
///
/// Getter for a Double Property
/// @version Tc 8
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getWidth( double &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setChannel( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setCurrency( const std::string &value, bool isNull=false );
///
/// Setter for a Double Property
/// @version Tc 8
/// @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 setDepth( double value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setDimension_unit( const tag_t &value, bool isNull=false );
///
/// Setter for a Double Property
/// @version Tc 8
/// @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 setGross_weight( double value, bool isNull=false );
///
/// Setter for a Double Property
/// @version Tc 8
/// @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 setHeight( double value, bool isNull=false );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setMarket_clearance_no( const std::string &value, bool isNull=false );
///
/// Setter for a Double Property
/// @version Tc 8
/// @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 setPrice( double value, bool isNull=false );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setShelf_life( const std::string &value, bool isNull=false );
///
/// Setter for a string Property
/// @version Tc 8
/// @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 setStorage_conditions( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Tc 8
/// @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 setWeight_unit( const tag_t &value, bool isNull=false );
///
/// Setter for a Double Property
/// @version Tc 8
/// @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 setWidth( double value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
CPFinishProductRevision();
/**
* Destructor
*/
virtual ~CPFinishProductRevision();
private:
// Getter method for the Implementation Object
CPFinishProductRevisionImpl* getCPFinishProductRevisionImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setCPFinishProductRevisionImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
CPFinishProductRevisionImpl* m_cpfinishproductrevisionImpl;
// 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 CPFinishProductRevision - desc for CPFinishProductRevision parameter
*/
CPFinishProductRevision( const CPFinishProductRevision& );
CPFinishProductRevision& operator=( const CPFinishProductRevision& );
friend class CPFinishProductRevisionDelegate;
friend class CPFinishProductRevisionDispatch;
friend class CPFinishProductRevisionGenImpl;
};
#include <fpmgmt/libfpmgmt_undef.h>
#endif // TEAMCENTER__FPMGMT__CPFINISHPRODUCTREVISION__HXX