All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMDesktopObjects Class ENOVCustoCommandUtils

Usage: you must use this class as is. You should never derive it.


public class ENOVCustoCommandUtils

Class ENOVCustoCommandUtils.
Role : This class contains utilities to get and set parameters involved in the client communication.


Constructor and Destructor Index


o ~ENOVCustoCommandUtils()
o ENOVCustoCommandUtils(CustomCommadDispatcher&)
nodoc

Method Index


o GetBooleanParameter(CATUnicodeString,boolean&)
Get a boolean values sent from the client.
o GetByteListParameter(CATUnicodeString,SEQUENCE(octet)*&)
Get a byte Array sent from the client.
o GetDoubleParameter(CATUnicodeString,double&)
Get a double values sent from the client.
o GetIntParameter(CATUnicodeString,int&)
Get an Integer value sent from the client.
o GetObjAttrAccessParameter(CATUnicodeString&,ENOVIObjectAttrAccess*&)
Get a object sent from the client.
o GetObjListParameter(CATUnicodeString,CATLISTV(CATIVpmFactoryObject_var)&)
Get a list of objects sent from the client.
o GetObjParameter(CATUnicodeString,CATIVpmFactoryObject_var&)
Get an object value sent from the client.
o GetStringParameter(CATUnicodeString&,CATUnicodeString&)
Get a CATUnicodeString values sent from the client.
o setResult(CATUnicodeString,CATUnicodeString)
Set a double value in the stream to return to the client.
o setResult(CATUnicodeString,SEQUENCE(octet)&)
Set a byte List to return to the client.
o setResult(CATUnicodeString,CATIVpmFactoryObject_var)
Set a object the stream to return to the client.
o setResult(CATUnicodeString,CATLISTV(CATIVpmFactoryObject_var)&)
Set a list of objects the stream to return to the client.
o setResult(CATUnicodeString,int)
Set a int value in the stream to return to the client.
o setResult(CATUnicodeString,double)
Set a double value in the stream to return to the client.
o setResult(CATUnicodeString,boolean)
Set a boolean value in the stream to return to the client.

Constructor and Destructor


o ~ENOVCustoCommandUtils
public ~ENOVCustoCommandUtils()
o ENOVCustoCommandUtils
public ENOVCustoCommandUtils( currentCMD)
nodoc

Methods


o GetBooleanParameter
public GetBooleanParameter( outName,
outVal)
Get a boolean values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetByteListParameter
public GetByteListParameter( inName,
outVal)
Get a byte Array sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetDoubleParameter
public GetDoubleParameter( outName,
outVal)
Get a double values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetIntParameter
public GetIntParameter( outName,
outVal)
Get an Integer value sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetObjAttrAccessParameter
public GetObjAttrAccessParameter( const iParmName,
oAttrAccess)
Get a object sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the object sent from the client. Be sure to delete the returned value.
o GetObjListParameter
public GetObjListParameter( inName,
oFactObjList)
Get a list of objects sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetObjParameter
public GetObjParameter( outName,
oFactObj)
Get an object value sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o GetStringParameter
public GetStringParameter( const outName,
outVal)
Get a CATUnicodeString values sent from the client.
Parameters:
outName
- the name of the parameter
outVal
- the value sent from the client
o setResult
public setResult( inName,
inValue)
Set a double value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
inValue)
Set a byte List to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
inValue)
Set a object the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
oFactObjList)
Set a list of objects the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
inValue)
Set a int value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
inValue)
Set a double value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return
o setResult
public setResult( inName,
inValue)
Set a boolean value in the stream to return to the client.
Parameters:
inName
- the name of the parameter
inValue
- the value to return

This object is included in the file: ENOVCustoCommandUtils.h
If needed, your Imakefile.mk should include the module: VDO0VPMSession

Copyright © 2003, Dassault Systèmes. All rights reserved.