All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ENOVIAPlugIn Class ENOVPublishAttributeValue

ENOVIAPlugIn.ENOVPublishObject
  |
  +---ENOVPublishAttributeValue
 

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


public class ENOVPublishAttributeValue

Class enabling to manage value node for a Multi-valuated Attribute node.
Role: This class enables to manage attribute values for a Multi-valuated Attribute node.

No Tag is defined on Attribute Value

See also:
ENOVPublishAttributeNode


Constructor and Destructor Index


o ENOVPublishAttributeValue(ENOVPublishAttributeValue&)
Copy constructor.
o ENOVPublishAttributeValue(ENOVPublishObject*,int)
Constructs an Attribute value node.
o ~ENOVPublishAttributeValue()

Method Index


o EncodeValue(char*)
Enables to encode attribute value.
o GetTimeValue(time_t&)
Returns attribute value for a date & time value Attribute.
o GetValue(CATUnicodeString&)
Returns attribute value for string.
o GetValue(char*&)
Returns attribute value for string or date & time.
o GetValue(double&)
Returns attribute value for a floating point value.
o GetValue(int&)
Returns attribute value for an integer value.
o GetValue(unsigned char*&,int&)
Returns attribute value for a binary value.
o GetValueType(int&)
Returns the type value for this attribute.
o IsModificationAuthorized()
Returns if attribute modification is authorized.
o Print(int)
Print a report on standard output.
o SetTimeValue(time_t)
Sets attribute value for an date & time value.
o SetValue(CATUnicodeString&)
Sets attribute value for a string.
o SetValue(char*)
Sets attribute value for a string or date & time value.
o SetValue(double)
Sets attribute value for a floating point value.
o SetValue(int)
Sets attribute value for an integer value.
o SetValue(unsigned char*,int)
Sets attribute value for a binary value.
o operator=(ENOVPublishAttributeValue&)
Copy constructor.

Constructor and Destructor


o ENOVPublishAttributeValue
public ENOVPublishAttributeValue( const ENOVPublishAttributeValue& ixNode)
Copy constructor.
Parameters:
ixNode
Object to be duplicated.
o ENOVPublishAttributeValue
public ENOVPublishAttributeValue(ENOVPublishObject* ixFather,
int inValueType= ENOVPublishUnknown )
Constructs an Attribute value node.
Parameters:
ixFather
Points to the father attribute node (
ENOVPublishAttributeNode ) for this value node.
inValueType
Attribute value type
Legal values: It can be set to either:
  • ENOVPublishTypeInteger For integer value
  • ENOVPublishTypeReal For real value
  • ENOVPublishTypeString For character string value
  • ENOVPublishTypeBinary For binary value
  • ENOVPublishTypeOid For Object id value (an hexa-decimal string)
  • ENOVPublishTypeUid For symbolic link value
  • ENOVPublishTypeTimestamp For timestamp value
  • ENOVPublishTypeVaultReference For Vault reference value
o ~ENOVPublishAttributeValue
public virtual ~ENOVPublishAttributeValue()

Methods


o EncodeValue
public int EncodeValue(char* ocValue)const
Enables to encode attribute value.
Role: Enables to encode current attribute value. (This method could be usefull when an Attribute is search by its value)
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocValue
A character string long enough to get the result.
  • 10 characters for ENOVPublishTypeInteger
  • 16 characters for ENOVPublishTypeReal
  • 4 times the number of characters for ENOVPublishTypeString
  • Twice the number of bytes plus 2 ENOVPublishTypeBinary
  • 34 characters for ENOVPublishTypeOid or ENOVPublishTypeUid
  • 18 characters for ENOVPublishTypeTimestamp
  • Twice the number of bytes plus 2 ENOVPublishTypeVaultReference
o GetTimeValue
public int GetTimeValue(time_t& otValue)const
Returns attribute value for a date & time value Attribute.
Role: Enables to read date & time value of the Attribute value node.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
otValue
Attribute value.
o GetValue
public int GetValue(CATUnicodeString& ocValue)const
Returns attribute value for string.
Role: Enables to read value of the Attribute node for string.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocValue
Attribute value.
o GetValue
public int GetValue( const char*& ocValue)const
Returns attribute value for string or date & time.
Role: Enables to read value of the Attribute node for string or date & time.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocValue
Attribute value.
Legal values: Date is expressed using one ISO 8601 format called Extended format for ordinal date and time of the day (Application will used Coordinated Universal Time UTC) (cf
ENOVPublishAttributeNode )
o GetValue
public int GetValue(double& odValue)const
Returns attribute value for a floating point value.
Role: Enables to read floating point value of the Attribute value.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
odValue
Attribute value.
o GetValue
public int GetValue(int& onValue)const
Returns attribute value for an integer value.
Role: Enables to read integer value of the Attribute value node.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
onValue
Attribute value.
o GetValue
public int GetValue( const unsigned char*& obValue,
int& onValueLength)const
Returns attribute value for a binary value.
Role: Enables to read binary value of the Attribute value node. (This method needs to be invoked for ENOVPublishTypeOid, ENOVPublishTypeUid and ENOVPublishTypeVaultReference attributes.)
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
obValue
Binary string value.
onValueLength
Binary string length.
o GetValueType
public int GetValueType(int& nAttributeType)const
Returns the type value for this attribute.
Role: Enables to access to Attribute name information.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
onValueType
Attribute value type
Legal values: It can be set to either:
  • ENOVPublishTypeInteger For integer value
  • ENOVPublishTypeReal For real value
  • ENOVPublishTypeString For character string value
  • ENOVPublishTypeBinary For binary value
  • ENOVPublishTypeOid For Object id value (an hexa-decimal string)
  • ENOVPublishTypeUid For symbolic link value
  • ENOVPublishTypeTimestamp For timestamp value
  • ENOVPublishTypeVaultReference For Vault reference value
o IsModificationAuthorized
public int IsModificationAuthorized()const
Returns if attribute modification is authorized.
Role: Returns if attribute modification is authorized.
Returns:
Define the access mode for this attribute
Legal values: It can be set to either:
  • ENOVPublishNoAccess To forbid any access
  • ENOVPublishReadOnly To authorize read only access
  • ENOVPublishReadWrite To autorize read and write access
o Print
public virtual void Print(int inLevel= 0 )const
Print a report on standard output.
Role: Print the content of this node and its children.
Parameters:
inLevel
Enable to have an indented presentation according to the tree depth of the node.
o SetTimeValue
public int SetTimeValue(time_t itValue)
Sets attribute value for an date & time value.
Role: Sets date & time value of the Attribute node in case of mono-valuated attribute.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
itValue
Attribute value.
o SetValue
public int SetValue( const CATUnicodeString& icValue)
Sets attribute value for a string.
Role: Sets string of the Attribute value node.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
inValue
Attribute value.
o SetValue
public int SetValue( const char* icValue)
Sets attribute value for a string or date & time value.
Role: Sets string or date & time value of the Attribute value node.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
inValue
Attribute value.
o SetValue
public int SetValue(double idValue)
Sets attribute value for a floating point value.
Role: Sets floating point value of the Attribute value.
Returns:
Method return code
Legal values:
  • Returns 0 if operation runs well.
  • Returns 1 if attribute has not a requested type.
  • Returns 4 if attribute modification not authorized.
Parameters:
idValue
Attribute value.
o SetValue
public int SetValue(int inValue)
Sets attribute value for an integer value.
Role: Sets value of the integer Attribute value node.
Returns:
Method return code
Legal values:
  • Returns 0 if operation runs well.
  • Returns 1 if attribute has not a requested type.
  • Returns 4 if attribute modification not authorized.
Parameters:
inValue
Attribute value.
o SetValue
public int SetValue( const unsigned char* ibValue,
int inValueLength)
Sets attribute value for a binary value.
Role: Sets binary value of the Attribute value node. (This method needs to be invoked for ENOVPublishTypeOid, ENOVPublishTypeUid and ENOVPublishTypeVaultReference attributes.)
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ibValue
Attribute value.
inValueLength
Binary string length.
o operator=
public const ENOVPublishAttributeValue & operator=( const ENOVPublishAttributeValue& ixNode)
Copy constructor.
Parameters:
ixNode
Object to be duplicated.

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

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