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.

238 lines
7.5 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, ConfigurationFamilyDelegate
Filename: ConfigurationFamilyDelegate.hxx
Module: fnd0booleansolve
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__CONFIGURATIONFAMILYDELEGATE_HXX
#define TEAMCENTER__CONFIGURATIONFAMILYDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <fnd0booleansolve/ConfigurationFamily.hxx>
#include <fnd0booleansolve/libfnd0booleansolve_exports.h>
namespace Teamcenter
{
class ConfigurationFamilyDelegate;
}
namespace Teamcenter
{
class ConfigurationFamilyImpl;
}
namespace Teamcenter
{
class ConfigurationFamily;
}
namespace Teamcenter
{
class ConfigurationFamilyGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class FND0BOOLEANSOLVE_API Teamcenter_alias::ConfigurationFamilyDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the ConfigurationFamilyDelegate instance
static ConfigurationFamilyDelegate& getInstance();
// Method to create the ConfigurationFamilyImpl pointer
static ConfigurationFamilyImpl* createImpl( ConfigurationFamily& ifObj );
// Method to delete the ConfigurationFamilyImpl pointer
static void deleteImpl( ConfigurationFamilyImpl* impl );
///
/// Getter for a string Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getDescriptionBase(const ConfigurationFamily &ifObj, 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 getFnd0valueScopeBase(const ConfigurationFamily &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.3
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getIsMandatoryBase(const ConfigurationFamily &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.3
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getIsModelFamilyBase(const ConfigurationFamily &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 8.3
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getModeBase(const ConfigurationFamily &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getNameBase(const ConfigurationFamily &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getNamespaceBase(const ConfigurationFamily &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getUomBase(const ConfigurationFamily &ifObj, tag_t &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setDescriptionBase(ConfigurationFamily &ifObj, const std::string &value, bool isNull );
///
/// 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 setFnd0valueScopeBase(ConfigurationFamily &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Teamcenter 8.3
/// @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 setIsMandatoryBase(ConfigurationFamily &ifObj, bool value, bool isNull );
///
/// Setter for a Boolean Property
/// @version Teamcenter 8.3
/// @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 setIsModelFamilyBase(ConfigurationFamily &ifObj, bool value, bool isNull );
///
/// Setter for an Integer Property
/// @version Teamcenter 8.3
/// @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 setModeBase(ConfigurationFamily &ifObj, int value, bool isNull );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setNameBase(ConfigurationFamily &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @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 setNamespaceBase(ConfigurationFamily &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag Property
/// @version Teamcenter 8.3
/// @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 setUomBase(ConfigurationFamily &ifObj, const tag_t &value, bool isNull );
protected:
// Pointer to the instance
static ConfigurationFamilyDelegate* m_pInstance;
ConfigurationFamilyDelegate();
virtual ~ConfigurationFamilyDelegate();
static void setInstance( ConfigurationFamilyDelegate* instance );
private:
friend class ::Teamcenter::ConfigurationFamilyGenImpl;
};
#include <fnd0booleansolve/libfnd0booleansolve_undef.h>
#endif // TEAMCENTER__CONFIGURATIONFAMILYDELEGATE_HXX