#include <CreateInput.hxx>

Inheritance diagram for Teamcenter::CreateInput:

Public Member Functions
int	getBusinessObjectName (std::string &busObjName)

int	getChar (const std::string &charName, char &charRetValue, bool &isNull)

int	getCharArray (const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals)

int	getCompoundObjectArrayTags (std::string &compoundObjectName, std::vector< tag_t > &compoundObjectTags)

int	getCompoundObjectTag (std::string &compoundObjectName, tag_t &compoundObjectTag)

int	getCompoundObjectTags (std::vector< tag_t > &compoundObjectTags)

int	getDate (const std::string &dateName, date_t &dateRetValue, bool &isNull)

int	getDateArray (const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull)

int	getDisplayValues (const std::string stringName, std::vector< std::string > vectorDispVals, std::vector< int > *vectorIsNullVals)

int	getDouble (const std::string &doubleName, double &doubleRetValue, bool &isNull)

int	getDoubleArray (const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals)

int	getInt (const std::string &intName, int &intRetValue, bool &isNull)

int	getIntArray (const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals)

int	getLogical (const std::string &logicalName, bool &boolRetValue, bool &isNull)

int	getLogicalArray (const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals)

virtual RuntimeBusinessObjectImpl *	getRuntimeBusinessObjectImpl () const

int	getString (const std::string &stringName, std::string &stringRetValue, bool &isNull)

int	getStringArray (const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals)

tag_t	getTag () const

int	getTag (const std::string &tagName, tag_t &tagRetValue, bool &isNull)

int	getTagArray (const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals)

const std::string &	getTypeName () const

tag_t	getTypeTag () const

int	invokeOperation (const std::string *operationId,...)

int	invokeOperation (const std::string &operationId, va_list args)

int	invokeOperation (int operationIdInt, va_list args)

int	invokeOperation (const std::string &operationId, std::vector< void * > &args)

int	invokeOperation (int operationIdInt, std::vector< void * > &args)

int	setBusinessObjectName (const std::string &busObjName)

int	setChar (const std::string &charName, const char &charValue, bool isNull)

int	setCharArray (const std::string &charArrayName, const std::vector< char > &vectorCharVals, const std::vector< int > *vectorIsNullVals)

int	setCompoundObjectArrayTags (std::string &compoundObjectName, std::vector< tag_t > &compoundObjectTags)

int	setCompoundObjectTag (std::string &compoundObjectName, tag_t compoundObjectTag)

int	setDate (const std::string &dateName, const date_t &dateValue, bool isNull)

int	setDateArray (const std::string &dateArrayName, const std::vector< date_t > &vectorDateVals, const std::vector< int > *vectorIsNullVals)

int	setDisplayValue (const std::string &stringName, const std::string &stringValue)

int	setDouble (const std::string &doubleName, const double &doubleValue, bool isNull)

int	setDoubleArray (const std::string &doubleArrayName, const std::vector< double > &vectorDoubleVals, const std::vector< int > *vectorIsNullVals)

int	setInt (const std::string &intName, const int &intValue, bool isNull)

int	setIntArray (const std::string &intArrayName, const std::vector< int > &vectorIntVals, const std::vector< int > *vectorIsNullVals)

int	setLogical (const std::string &logicalName, const bool logicalValue, bool isNull)

int	setLogicalArray (const std::string &boolArrayName, const std::vector< int > &vectorboolVals, const std::vector< int > *vectorIsNullVals)

int	setString (const std::string &stringName, const std::string &stringValue, bool isNull)

int	setStringArray (const std::string &stringArrayName, const std::vector< std::string > &vectorStringVals, const std::vector< int > *vectorIsNullVals)

int	setTag (const std::string &tagName, const tag_t &tagValue, bool isNull)

int	setTagArray (const std::string &tagArrayName, const std::vector< tag_t > &vectorTagVals, const std::vector< int > *vectorIsNullVals)

Static Public Member Functions
static const std::string &	getInterfaceName ()

Protected Member Functions
	CreateInput ()

virtual void	initialize (RootObjectImpl *impl=0)

virtual void	initialize (::Teamcenter::RootObjectImpl *impl)

void	setTag (tag_t tag)

virtual	~CreateInput ()

Private Member Functions
	CreateInput (const CreateInput &)

CreateInputImpl *	getCreateInputImpl () const

CreateInput &	operator= (const CreateInput &)

::Teamcenter::RootObjectImpl *	setCreateInputImpl (::Teamcenter::RootObjectImpl *impl)

void	setDeleteImpl (bool del)

Private Attributes
CreateInputImpl *	m_createinputImpl

bool	m_deleteImpl

Static Private Attributes
static std::string	name

Friends
class	CreateInputDelegate

class	CreateInputGenImpl

Detailed Description

Definition at line 53 of file CreateInput.hxx.

Constructor & Destructor Documentation

Teamcenter::CreateInput::CreateInput ( )

protected

Constructor

virtual Teamcenter::CreateInput::~CreateInput ( )

protectedvirtual

Destructor

Teamcenter::CreateInput::CreateInput ( const CreateInput & )

private

Private default constructor. We do not want this class instantiated without the business object passed in.

Parameters

CreateInput - desc for CreateInput parameter

Member Function Documentation

int Teamcenter::OperationInput::getBusinessObjectName ( std::string & busObjName )

inherited

Returns the Business Object Name

Version: Tc 8

Parameters

busObjName - The name of the business object

Returns: - Returns an Integer

int Teamcenter::OperationInput::getChar	(	const std::string &	charName,
		char &	charRetValue,
		bool &	isNull
	)

inherited

To Return the Character

Version: Tc 8

Parameters

charName	- To return the character Name
charRetValue	- The value of the Character
isNull	- Is the Value Null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getCharArray	(	const std::string &	charArrayName,
		std::vector< char > &	vectorCharVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

The array of Character

Version: Tc 8

Parameters

charArrayName	- The Char array Name
vectorCharVals	- vector of char values
vectorIsNullVals	- Is the Values Null

Returns: - Returns the Status as Integer

int Teamcenter::CreateInput::getCompoundObjectArrayTags	(	std::string &	compoundObjectName,
		std::vector< tag_t > &	compoundObjectTags
	)

gets the compound object tags

Version: Teamcenter 10

Parameters

compoundObjectName	- compound object's name
compoundObjectTags	- compound object tags

Returns: - exit status

int Teamcenter::CreateInput::getCompoundObjectTag	(	std::string &	compoundObjectName,
		tag_t &	compoundObjectTag
	)

The method getCompoundObjectTag is used retrieve the tag of any newly-created object listed as a Compound property on the CreateInput Descriptor. Please note: the "revision" property of Item is treated as a compound property by the system despite the Compound column not appearing checked in BMIDE.

Version: Tc 8

Parameters

compoundObjectName	- compound object's name
compoundObjectTag	- compound objects tag

Returns: - exit status

int Teamcenter::CreateInput::getCompoundObjectTags ( std::vector< tag_t > & compoundObjectTags )

The method getCompoundObjectTags is used to retrieve all the child objects tags created during the creation of the main object. For example, this function will return tags of ItemRevision, Item Master Form, ItemRevision Master Form for the newly-created Item.

Version: Tc 8

Parameters

compoundObjectTags - vector of compound object tag_ts

Returns: - exit status

CreateInputImpl* Teamcenter::CreateInput::getCreateInputImpl ( ) const

private

int Teamcenter::OperationInput::getDate	(	const std::string &	dateName,
		date_t &	dateRetValue,
		bool &	isNull
	)

inherited

get date value

Version: Tc 8

Parameters

dateName	- Name of the date property
dateRetValue	- Value of the date property
isNull	- is value Null

Returns: - status

int Teamcenter::OperationInput::getDateArray	(	const std::string &	dateArrayName,
		std::vector< date_t > &	dateArrayRetValue,
		std::vector< int > &	isNull
	)

inherited

get array of Date Values for a property

Version: Tc 8

Parameters

dateArrayName	- Name of the date array property
dateArrayRetValue	- Value of the date array
isNull	- is null values

Returns: - status

int Teamcenter::OperationInput::getDisplayValues	(	const std::string *	stringName,
		std::vector< std::string > *	vectorDispVals,
		std::vector< int > *	vectorIsNullVals
	)

inherited

Returns the Display Values for the input property

Version: Teamcenter 11.1

Parameters

stringName	- The name of the property
vectorDispVals	- The display values for the property
vectorIsNullVals	- vector of isNull Values

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getDouble	(	const std::string &	doubleName,
		double &	doubleRetValue,
		bool &	isNull
	)

inherited

To get the double value

Version: Tc 8

Parameters

doubleName	- The name of the double variable
doubleRetValue	- The value of the double variable
isNull	- Is the value Null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getDoubleArray	(	const std::string &	doubleArrayName,
		std::vector< double > &	vectorDoubleVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

Array of Doubles

Version: Tc 8

Parameters

doubleArrayName	- The Array Name
vectorDoubleVals	- Array of Doubles
vectorIsNullVals	- Is the Value Null

Returns: - Return the status as Integer

int Teamcenter::OperationInput::getInt	(	const std::string &	intName,
		int &	intRetValue,
		bool &	isNull
	)

inherited

To get the Integer

Version: Tc 8

Parameters

intName	- The name of the Integer
intRetValue	- The value of the Integer
isNull	- Is the value null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getIntArray	(	const std::string &	intArrayName,
		std::vector< int > &	vectorIntVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

Array of Integers

Version: Tc 8

Parameters

intArrayName	- The array name of integers
vectorIntVals	- The Vector of Integer values
vectorIsNullVals	- are the Values Null

Returns: - Returns the status as Integers

static const std::string& Teamcenter::CreateInput::getInterfaceName ( )

static

Get the Interface Name

Returns: - return desc for getInterfaceName

int Teamcenter::OperationInput::getLogical	(	const std::string &	logicalName,
		bool &	boolRetValue,
		bool &	isNull
	)

inherited

To get the Logical Value

Version: Tc 8

Parameters

logicalName	- The name of the Logical Variable
boolRetValue	- The logical value
isNull	- Is the value null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getLogicalArray	(	const std::string &	logicalArrayName,
		std::vector< int > &	vectorLogicalVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

Array of Logical Values

Version: Tc 8

Parameters

logicalArrayName	- Array of Logical Names
vectorLogicalVals	- Vector of Logical Values
vectorIsNullVals	- are the Value Null

Returns: - Returns the status as Integer

virtual RuntimeBusinessObjectImpl* Teamcenter::RootObject::getRuntimeBusinessObjectImpl ( ) const

virtualinherited

Reimplemented in Teamcenter::RuntimeBusinessObject.

int Teamcenter::OperationInput::getString	(	const std::string &	stringName,
		std::string &	stringRetValue,
		bool &	isNull
	)

inherited

Returns the String

Version: Tc 8

Parameters

stringName	- The name of the String
stringRetValue	- The value of the string
isNull	- Is the String Null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getStringArray	(	const std::string &	stringArrayName,
		std::vector< std::string > &	vectorStringVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

To get the StringArray

Version: Tc 8

Parameters

stringArrayName	- The String name
vectorStringVals	- Vector of Strings
vectorIsNullVals	- vector of booleans

Returns: - Returns the status as Integer

tag_t Teamcenter::RootObject::getTag ( ) const

inherited

int Teamcenter::OperationInput::getTag	(	const std::string &	tagName,
		tag_t &	tagRetValue,
		bool &	isNull
	)

inherited

Returns the Tag

Version: Tc 8

Parameters

tagName	- The name of the Tag
tagRetValue	- The value of the Tag
isNull	- Is the Value Null

Returns: - Returns the status as Integer

int Teamcenter::OperationInput::getTagArray	(	const std::string &	tagArrayName,
		std::vector< tag_t > &	vectorTagVals,
		std::vector< int > &	vectorIsNullVals
	)

inherited

Array of Tags

Version: Tc 8

Parameters

tagArrayName	- Nameof the Tag Array
vectorTagVals	- Vector of Tags
vectorIsNullVals	- are the Value Null

Returns: - Returns the status as Integer

const std::string& Teamcenter::RootObject::getTypeName ( ) const

inherited

tag_t Teamcenter::RootObject::getTypeTag ( ) const

inherited

virtual void Teamcenter::RootObject::initialize ( RootObjectImpl * impl = 0 )

protectedvirtualinherited

virtual void Teamcenter::CreateInput::initialize ( ::Teamcenter::RootObjectImpl * impl )

protectedvirtual

Reimplemented from Teamcenter::OperationInput.

int Teamcenter::RootObject::invokeOperation	(	const std::string *	operationId,
			...
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	const std::string &	operationId,
		va_list	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	int	operationIdInt,
		va_list	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	const std::string &	operationId,
		std::vector< void * > &	args
	)

inherited

int Teamcenter::RootObject::invokeOperation	(	int	operationIdInt,
		std::vector< void * > &	args
	)

inherited

CreateInput& Teamcenter::CreateInput::operator= ( const CreateInput & )

private

int Teamcenter::OperationInput::setBusinessObjectName ( const std::string & busObjName )

inherited

Sets the Business Object Name

Version: Tc 8

Parameters

busObjName - The name of the business object

Returns: - Returns the String name of the Business Object

int Teamcenter::OperationInput::setChar	(	const std::string &	charName,
		const char &	charValue,
		bool	isNull
	)

inherited

To set the character

Version: Tc 8

Parameters

charName	- The Name
charValue	- The Character Value
isNull	- Is the Value Null

Returns: - Returns an Integer

int Teamcenter::OperationInput::setCharArray	(	const std::string &	charArrayName,
		const std::vector< char > &	vectorCharVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set the character array

Version: Tc 8

Parameters

charArrayName	- charArrayName
vectorCharVals	- vectorCharVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::CreateInput::setCompoundObjectArrayTags	(	std::string &	compoundObjectName,
		std::vector< tag_t > &	compoundObjectTags
	)

sets the compound object tags on the map with CreateInput

Version: Teamcenter 10

Parameters

compoundObjectName	- Name of the compound object
compoundObjectTags	- compound object tags

Returns: - exit status

int Teamcenter::CreateInput::setCompoundObjectTag	(	std::string &	compoundObjectName,
		tag_t	compoundObjectTag
	)

sets the compound object tag on the map with CreateInput

Version: Tc 8

Parameters

compoundObjectName	- Name of the compound object
compoundObjectTag	- compound object's tag

Returns: - exit status

::Teamcenter::RootObjectImpl* Teamcenter::CreateInput::setCreateInputImpl ( ::Teamcenter::RootObjectImpl * impl )

private

int Teamcenter::OperationInput::setDate	(	const std::string &	dateName,
		const date_t &	dateValue,
		bool	isNull
	)

inherited

To set the Date

Version: Tc 8

Parameters

dateName	- dateName
dateValue	- dateValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::OperationInput::setDateArray	(	const std::string &	dateArrayName,
		const std::vector< date_t > &	vectorDateVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set the Date Array

Version: Tc 8

Parameters

dateArrayName	- dateArrayName
vectorDateVals	- vectorDateVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

void Teamcenter::CreateInput::setDeleteImpl ( bool del )

private

int Teamcenter::OperationInput::setDisplayValue	(	const std::string &	stringName,
		const std::string &	stringValue
	)

inherited

To set the Display Value

Version: Tc 8

Parameters

stringName	- name of the string
stringValue	- value of the string

Returns: - success or failure

int Teamcenter::OperationInput::setDouble	(	const std::string &	doubleName,
		const double &	doubleValue,
		bool	isNull
	)

inherited

To set the Double Value

Version: Tc 8

Parameters

doubleName	- doubleName
doubleValue	- doubleValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::OperationInput::setDoubleArray	(	const std::string &	doubleArrayName,
		const std::vector< double > &	vectorDoubleVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set the double array

Version: Tc 8

Parameters

doubleArrayName	- doubleArrayName
vectorDoubleVals	- vectorDoubleVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::OperationInput::setInt	(	const std::string &	intName,
		const int &	intValue,
		bool	isNull
	)

inherited

To set an Integer

Version: Tc 8

Parameters

intName	- The name of the integer
intValue	- The Integer Value
isNull	- Is the value Null

Returns: - Returns status as Integer

int Teamcenter::OperationInput::setIntArray	(	const std::string &	intArrayName,
		const std::vector< int > &	vectorIntVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To the the Array of Integer type data on OperationInput

Version: Tc 8

Parameters

intArrayName	- name of the integer array
vectorIntVals	- vector or array of integer values
vectorIsNullVals	- vector of isNulls

Returns: - success or failure

int Teamcenter::OperationInput::setLogical	(	const std::string &	logicalName,
		const bool	logicalValue,
		bool	isNull
	)

inherited

To set the Logical Value

Version: Tc 8

Parameters

logicalName	- logicalName
logicalValue	- logicalValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::OperationInput::setLogicalArray	(	const std::string &	boolArrayName,
		const std::vector< int > &	vectorboolVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set Logical Array

Version: Tc 8

Parameters

boolArrayName	- boolArrayName
vectorboolVals	- vectorboolVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

int Teamcenter::OperationInput::setString	(	const std::string &	stringName,
		const std::string &	stringValue,
		bool	isNull
	)

inherited

To set the String

Version: Tc 8

Parameters

stringName	- stringName
stringValue	- stringValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::OperationInput::setStringArray	(	const std::string &	stringArrayName,
		const std::vector< std::string > &	vectorStringVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set the string array

Version: Tc 8

Parameters

stringArrayName	- stringArrayName
vectorStringVals	- vectorStringVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an integer

void Teamcenter::RootObject::setTag ( tag_t tag )

protectedinherited

int Teamcenter::OperationInput::setTag	(	const std::string &	tagName,
		const tag_t &	tagValue,
		bool	isNull
	)

inherited

To set the tag

Version: Tc 8

Parameters

tagName	- tagName
tagValue	- tagValue
isNull	- isNull

Returns: - Returns an Integer

int Teamcenter::OperationInput::setTagArray	(	const std::string &	tagArrayName,
		const std::vector< tag_t > &	vectorTagVals,
		const std::vector< int > *	vectorIsNullVals
	)

inherited

To set the Tag Array

Version: Tc 8

Parameters

tagArrayName	- tagArrayName
vectorTagVals	- vectorTagVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

Friends And Related Function Documentation

friend class CreateInputDelegate

friend

Definition at line 149 of file CreateInput.hxx.

friend class CreateInputGenImpl

friend

Definition at line 150 of file CreateInput.hxx.

Member Data Documentation

CreateInputImpl* Teamcenter::CreateInput::m_createinputImpl

private

Definition at line 132 of file CreateInput.hxx.

bool Teamcenter::CreateInput::m_deleteImpl

private

Definition at line 135 of file CreateInput.hxx.

std::string Teamcenter::CreateInput::name

staticprivate

Name of the Business Object

Definition at line 140 of file CreateInput.hxx.

The documentation for this class was generated from the following file:

CreateInput.hxx

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation