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.
364 lines
12 KiB
364 lines
12 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, Item
|
|
Filename: Item.hxx
|
|
Module: tccore
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__ITEM__HXX
|
|
#define TEAMCENTER__ITEM__HXX
|
|
|
|
#include <vector>
|
|
#include <unidefs.h>
|
|
#include <string>
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <tccore/WorkspaceObject.hxx>
|
|
|
|
#include <tccore/libtccore_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class Item;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class ItemImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class ItemDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class ItemDispatch;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class ItemGenImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class RootObjectImpl;
|
|
}
|
|
|
|
class TCCORE_API Teamcenter::Item
|
|
: public ::Teamcenter::WorkspaceObject
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Get the Interface Name
|
|
* @return - return desc for getInterfaceName
|
|
*/
|
|
static const std::string& getInterfaceName();
|
|
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Tc 8
|
|
/// @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 getBom_view_tags( std::vector< tag_t > &values, std::vector< int > &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 getConfiguration_object_tag( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 8.2
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getCurrent_id_context( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Ifail code, ITK_ok if successful.
|
|
///
|
|
int getFnd0Configurator( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 9
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0OriginalLocationCode( 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 getFnd0PartIdentifier( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Boolean 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 getFnd0PosBiasedVariantAvail( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10
|
|
/// @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 getFnd0StructureAuditLogs( std::vector< tag_t > &values, std::vector< int > &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 getFnd0VariantNamespace( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Tc 8
|
|
/// @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 getGlobal_alt_list( 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 getHas_variant_module( bool &value, bool &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 getIs_configuration_item( bool &value, bool &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 getIs_vi( 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 getItem_id( 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 getPreferred_global_alt( tag_t &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 getUom_tag( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Tc 8
|
|
/// @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 setBom_view_tags( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setConfiguration_object_tag( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 9
|
|
/// @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 setFnd0OriginalLocationCode( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Tc 8
|
|
/// @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 setGlobal_alt_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setHas_variant_module( bool 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 setIs_configuration_item( bool 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 setIs_vi( 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 setItem_id( 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 setPreferred_global_alt( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 11.2
|
|
/// @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 setRevision_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setUom_tag( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// The operation determines the maturity of latest revision of the otherside Item. It returns true if the status of the object matches with one of the values in MaturityStatuses constant for this business object otherwise it returns false.
|
|
/// @version Tc 8
|
|
/// @param result - Returns the result as true if the business object is matured, otherwise returns the result as false.
|
|
/// @return - Return error code.
|
|
///
|
|
int isLatestRevisionMature( bool *result );
|
|
protected:
|
|
// Method to initialize
|
|
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
Item();
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~Item();
|
|
|
|
private:
|
|
// Getter method for the Implementation Object
|
|
ItemImpl* getItemImpl() const;
|
|
// Setter method for the Implementation Object
|
|
::Teamcenter::RootObjectImpl* setItemImpl( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
// Method to set the delete impl boolean
|
|
void setDeleteImpl( bool del );
|
|
|
|
// Pointer to the Implementation object
|
|
ItemImpl* m_itemImpl;
|
|
|
|
// 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 Item - desc for Item parameter
|
|
*/
|
|
Item( const Item& );
|
|
Item& operator=( const Item& );
|
|
|
|
friend class ItemDelegate;
|
|
friend class ItemDispatch;
|
|
friend class ItemGenImpl;
|
|
friend class ItemImpl;
|
|
};
|
|
|
|
#include <tccore/libtccore_undef.h>
|
|
#endif // TEAMCENTER__ITEM__HXX
|