#include <OperationInput.hxx>

Inheritance diagram for Teamcenter::OperationInput:

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	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	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
virtual void	initialize (RootObjectImpl *impl=0)

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

	OperationInput ()

void	setTag (tag_t tag)

virtual	~OperationInput ()

Private Member Functions
OperationInputImpl *	getOperationInputImpl () const

	OperationInput (const OperationInput &)

OperationInput &	operator= (const OperationInput &)

void	setDeleteImpl (bool del)

::Teamcenter::RootObjectImpl *	setOperationInputImpl (::Teamcenter::RootObjectImpl *impl)

Private Attributes
bool	m_deleteImpl

OperationInputImpl *	m_operationinputImpl

Static Private Attributes
static std::string	name

Friends
class	OperationInputDelegate

class	OperationInputGenImpl

Detailed Description

Definition at line 53 of file OperationInput.hxx.

Constructor & Destructor Documentation

Teamcenter::OperationInput::OperationInput ( )

protected

Constructor

virtual Teamcenter::OperationInput::~OperationInput ( )

protectedvirtual

Destructor

Teamcenter::OperationInput::OperationInput ( const OperationInput & )

private

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

Parameters

OperationInput - desc for OperationInput parameter

Member Function Documentation

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

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
	)

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
	)

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::OperationInput::getDate	(	const std::string &	dateName,
		date_t &	dateRetValue,
		bool &	isNull
	)

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
	)

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
	)

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
	)

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
	)

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
	)

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
	)

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::OperationInput::getInterfaceName ( )

static

Get the Interface Name

Returns: - return desc for getInterfaceName

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

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
	)

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

OperationInputImpl* Teamcenter::OperationInput::getOperationInputImpl ( ) const

private

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

virtualinherited

Reimplemented in Teamcenter::RuntimeBusinessObject.

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

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
	)

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
	)

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
	)

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::OperationInput::initialize ( ::Teamcenter::RootObjectImpl * impl )

protectedvirtual

Reimplemented in Teamcenter::CreateInput, Teamcenter::BulkData, Teamcenter::BulkInput, Teamcenter::BulkCopyInput, Teamcenter::Fnd0CreateInput, Teamcenter::Fnd0DeepCopyData, Teamcenter::Bom0bommanagement::Bom0MarkPrimaryDesignInput, Teamcenter::Bom0bommanagement::Bom0PartDesignAlgnmtInput, Teamcenter::Bom0bommanagement::Bom0PartDesignUnAlgnmtInput, Teamcenter::Bom0bommanagement::Bom0PartOccAlgnmtInputOp, Teamcenter::Bom0bommanagement::Bom0PartOccUnAlgnmtInput, Teamcenter::Bom0bommanagement::Bom0PUDEAlgnmtInput, Teamcenter::CloneStructureCADDependencyData, Teamcenter::CloneStructureTopLineData, Teamcenter::BulkSaveInput, Teamcenter::DeepCopyData, Teamcenter::ReviseInput, and Teamcenter::SaveAsInput.

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

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

private

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

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
	)

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
	)

To set the character array

Version: Tc 8

Parameters

charArrayName	- charArrayName
vectorCharVals	- vectorCharVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

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

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
	)

To set the Date Array

Version: Tc 8

Parameters

dateArrayName	- dateArrayName
vectorDateVals	- vectorDateVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

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

private

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

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
	)

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
	)

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
	)

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
	)

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
	)

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
	)

To set Logical Array

Version: Tc 8

Parameters

boolArrayName	- boolArrayName
vectorboolVals	- vectorboolVals
vectorIsNullVals	- vectorIsNullVals

Returns: - Returns an Integer

::Teamcenter::RootObjectImpl* Teamcenter::OperationInput::setOperationInputImpl ( ::Teamcenter::RootObjectImpl * impl )

private

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

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
	)

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
	)

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
	)

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 OperationInputDelegate

friend

Definition at line 423 of file OperationInput.hxx.

friend class OperationInputGenImpl

friend

Definition at line 424 of file OperationInput.hxx.

Member Data Documentation

bool Teamcenter::OperationInput::m_deleteImpl

private

Definition at line 409 of file OperationInput.hxx.

OperationInputImpl* Teamcenter::OperationInput::m_operationinputImpl

private

Definition at line 406 of file OperationInput.hxx.

std::string Teamcenter::OperationInput::name

staticprivate

Name of the Business Object

Definition at line 414 of file OperationInput.hxx.

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

OperationInput.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