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.
586 lines
18 KiB
586 lines
18 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, CPGFormulaMaterRevision
|
|
Filename: CPGFormulaMaterRevision.hxx
|
|
Module: cpgmaterials
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__CPGMATERIALS__CPGFORMULAMATERREVISION__HXX
|
|
#define TEAMCENTER__CPGMATERIALS__CPGFORMULAMATERREVISION__HXX
|
|
|
|
#include <string>
|
|
#include <unidefs.h>
|
|
#include <vector>
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <tccore/ItemRevision.hxx>
|
|
|
|
#include <cpgmaterials/libcpgmaterials_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
namespace CPGMATERIALS
|
|
{
|
|
class CPGFormulaMaterRevision;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace CPGMATERIALS
|
|
{
|
|
class CPGFormulaMaterRevisionImpl;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace CPGMATERIALS
|
|
{
|
|
class CPGFormulaMaterRevisionDelegate;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace CPGMATERIALS
|
|
{
|
|
class CPGFormulaMaterRevisionDispatch;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
namespace CPGMATERIALS
|
|
{
|
|
class CPGFormulaMaterRevisionGenImpl;
|
|
}
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class RootObjectImpl;
|
|
}
|
|
|
|
class CPGMATERIALS_API Teamcenter::CPGMATERIALS::CPGFormulaMaterRevision
|
|
: public ::Teamcenter::ItemRevision
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Get the Interface Name
|
|
* @return - return desc for getInterfaceName
|
|
*/
|
|
static const std::string& getInterfaceName();
|
|
|
|
|
|
///
|
|
/// 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 getBoiling_point( 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 getCost( 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 getExperimental_id( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Date Property
|
|
/// @version Tc 8
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getExpiry_date( date_t &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 getFeedstock_origin( 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 getFlash_point( double &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 getFND_Tracelink_reverse( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Tc 8
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getKosher( bool &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 getMaterial_characteristic( 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 getMaterial_function( 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 getMax_ingredient_level( 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 getMolecular_formula( 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 getMolecular_structure( 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 getMolecular_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 getOil_water_ratio( 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 getPH_value( 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 getProjected_volume( 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 getREACH_number( 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 getRegulatory_restrictions( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an Integer 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( int &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 getSpecific_gravity( 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 getState( 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 getSupplier_transport( 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 getTransport_information( 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 getVapor_pressure( 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 getWater_solubility( double &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// 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 setBoiling_point( 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 setCost( 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 setExperimental_id( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Date 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 setExpiry_date( const date_t &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 setFeedstock_origin( 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 setFlash_point( double value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Boolean 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 setKosher( bool 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 setMaterial_characteristic( 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 setMaterial_function( 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 setMax_ingredient_level( 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 setMolecular_formula( 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 setMolecular_structure( 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 setMolecular_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 setOil_water_ratio( 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 setPH_value( 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 setProjected_volume( 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 setREACH_number( 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 setRegulatory_restrictions( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for an Integer 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( int 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 setSpecific_gravity( 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 setState( 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 setSupplier_transport( 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 setTransport_information( 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 setVapor_pressure( 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 setWater_solubility( double value, bool isNull=false );
|
|
protected:
|
|
// Method to initialize
|
|
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
CPGFormulaMaterRevision();
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~CPGFormulaMaterRevision();
|
|
|
|
private:
|
|
// Getter method for the Implementation Object
|
|
CPGFormulaMaterRevisionImpl* getCPGFormulaMaterRevisionImpl() const;
|
|
// Setter method for the Implementation Object
|
|
::Teamcenter::RootObjectImpl* setCPGFormulaMaterRevisionImpl( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
// Method to set the delete impl boolean
|
|
void setDeleteImpl( bool del );
|
|
|
|
// Pointer to the Implementation object
|
|
CPGFormulaMaterRevisionImpl* m_cpgformulamaterrevisionImpl;
|
|
|
|
// 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 CPGFormulaMaterRevision - desc for CPGFormulaMaterRevision parameter
|
|
*/
|
|
CPGFormulaMaterRevision( const CPGFormulaMaterRevision& );
|
|
CPGFormulaMaterRevision& operator=( const CPGFormulaMaterRevision& );
|
|
|
|
friend class CPGFormulaMaterRevisionDelegate;
|
|
friend class CPGFormulaMaterRevisionDispatch;
|
|
friend class CPGFormulaMaterRevisionGenImpl;
|
|
};
|
|
|
|
#include <cpgmaterials/libcpgmaterials_undef.h>
|
|
#endif // TEAMCENTER__CPGMATERIALS__CPGFORMULAMATERREVISION__HXX
|