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.

220 lines
6.8 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, Mem0MemoryBlock
Filename: Mem0MemoryBlock.hxx
Module: Mem0memmgt
@BMIDE autogenerated
==================================================================================================*/
#ifndef CCDM__MEM0MEMORYBLOCK__HXX
#define CCDM__MEM0MEMORYBLOCK__HXX
#include <string>
#include <unidefs.h>
#include <vector>
#include <common/tc_deprecation_macros.h>
#include <tccore/POM_application_object.hxx>
#include <Mem0memmgt/libmem0memmgt_exports.h>
namespace ccdm
{
class Mem0MemoryBlock;
}
namespace ccdm
{
class Mem0MemoryBlockImpl;
}
namespace ccdm
{
class Mem0MemoryBlockDelegate;
}
namespace ccdm
{
class Mem0MemoryBlockDispatch;
}
namespace ccdm
{
class Mem0MemoryBlockGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class MEM0MEMMGT_API ccdm::Mem0MemoryBlock
: public ::Teamcenter::POM_application_object
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// Getter for a string Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMem0BlockName( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMem0HeaderObject( tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 9.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 getMem0MemoryBlocks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 9.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 getMem0MemoryRecords( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMem0StartAddress( std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 9.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getMem0TrailerObject( tag_t &value, bool &isNull ) const;
///
/// Setter for a string Property
/// @version Teamcenter 9.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 setMem0BlockName( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Teamcenter 9.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 setMem0HeaderObject( const tag_t &value, bool isNull=false );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 9.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 setMem0MemoryBlocks( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 9.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 setMem0MemoryRecords( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// Setter for a string Property
/// @version Teamcenter 9.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 setMem0StartAddress( const std::string &value, bool isNull=false );
///
/// Setter for a Tag Property
/// @version Teamcenter 9.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 setMem0TrailerObject( const tag_t &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
Mem0MemoryBlock();
/**
* Destructor
*/
virtual ~Mem0MemoryBlock();
private:
// Getter method for the Implementation Object
Mem0MemoryBlockImpl* getMem0MemoryBlockImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setMem0MemoryBlockImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
Mem0MemoryBlockImpl* m_mem0memoryblockImpl;
// 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 Mem0MemoryBlock - desc for Mem0MemoryBlock parameter
*/
Mem0MemoryBlock( const Mem0MemoryBlock& );
Mem0MemoryBlock& operator=( const Mem0MemoryBlock& );
friend class Mem0MemoryBlockDelegate;
friend class Mem0MemoryBlockDispatch;
friend class Mem0MemoryBlockGenImpl;
};
#include <Mem0memmgt/libmem0memmgt_undef.h>
#endif // CCDM__MEM0MEMORYBLOCK__HXX