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.

291 lines
9.6 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, PrintConfiguration
Filename: PrintConfiguration.hxx
Module: docmgt
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__PRINTCONFIGURATION__HXX
#define TEAMCENTER__PRINTCONFIGURATION__HXX
#include <vector>
#include <string>
#include <common/tc_deprecation_macros.h>
#include <rbf/BusinessElement.hxx>
#include <docmgt/libdocmgt_exports.h>
namespace Teamcenter
{
class PrintConfiguration;
}
namespace Teamcenter
{
class PrintConfigurationImpl;
}
namespace Teamcenter
{
class PrintConfigurationDelegate;
}
namespace Teamcenter
{
class PrintConfigurationDispatch;
}
namespace Teamcenter
{
class PrintConfigurationGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class DOCMGT_API Teamcenter::PrintConfiguration
: public ::Teamcenter::BusinessElement
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// 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 getDispatcher_svc_arguments( std::vector< tag_t > &values, std::vector< int > &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 getDispatcher_svc_display_name( std::string &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 getDispatcher_svc_name( std::string &value, bool &isNull ) const;
///
/// Getter for an String 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 getPaper_sizes( std::vector< std::string > &values, std::vector< int > &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 getPrinter_name( std::string &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 getProvider_display_name( std::string &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 getProvider_name( 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 getSupp_dataset_types( std::vector< tag_t > &values, std::vector< int > &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 getSupp_mk_apps( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Boolean 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 getSupport_stamp( bool &value, bool &isNull ) const;
///
/// Setter for a Tag Array Property
/// @version Teamcenter 8.1
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setDispatcher_svc_arguments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// 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 setDispatcher_svc_display_name( const std::string &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 setDispatcher_svc_name( const std::string &value, bool isNull=false );
///
/// Setter for an string Array Property
/// @version Teamcenter 8.1
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setPaper_sizes( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
///
/// 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 setPrinter_name( const std::string &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 setProvider_display_name( const std::string &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 setProvider_name( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 8.1
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setSupp_dataset_types( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 8.1
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setSupp_mk_apps( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a Boolean 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 setSupport_stamp( bool value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
PrintConfiguration();
/**
* Destructor
*/
virtual ~PrintConfiguration();
private:
// Getter method for the Implementation Object
PrintConfigurationImpl* getPrintConfigurationImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setPrintConfigurationImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
PrintConfigurationImpl* m_printconfigurationImpl;
// 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 PrintConfiguration - desc for PrintConfiguration parameter
*/
PrintConfiguration( const PrintConfiguration& );
PrintConfiguration& operator=( const PrintConfiguration& );
friend class PrintConfigurationDelegate;
friend class PrintConfigurationDispatch;
friend class PrintConfigurationGenImpl;
};
#include <docmgt/libdocmgt_undef.h>
#endif // TEAMCENTER__PRINTCONFIGURATION__HXX