All Frameworks  Class Hierarchy  This Framework  Indexes   

ENOVIAPlugIn Class ENOVPublishedBy

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


public class ENOVPublishedBy

Object used as start-up to generate this publishing stream.
Role:
Tags define on "Publishing by" object:


Constructor and Destructor Index


o ~ENOVPublishedBy()
o ENOVPublishedBy(ENOVPublishObject*)
Constructs a Publish By object.
o ENOVPublishedBy(ENOVPublishedBy&)
Copy constructor.

Method Index


o GetOid(unsigned char*&,int&)
Returns the internal id (Oid) of the object instance.
o GetPrimaryType(char*&)
Returns the name of object base type.
o GetSecondaryType(char*&)
Returns the name of final object type.
o GetTimeStamp(char*&)
Returns date & time of the Object node.
o GetTypeId(unsigned char*&,int&)
Returns the internal id (Oid) of the object type.
o Print(int)
Print a report on standard output.
o operator=(ENOVPublishedBy&)
Assignment operator from another object node.

Constructor and Destructor


o ~ENOVPublishedBy
public virtual ~ENOVPublishedBy()
o ENOVPublishedBy
public ENOVPublishedBy( ixFather)
Constructs a Publish By object.
Parameters:
ixFather
Points to the father node for this object.
o ENOVPublishedBy
public ENOVPublishedBy( const ixPublishBy)
Copy constructor.
Parameters:
ixPublishBy
Object to be duplicated.

Methods


o GetOid
public GetOid( const obOid,
onLenOid)
Returns the internal id (Oid) of the object instance.
Role: Returns the binary value corresponding internal id (Oid) of the object instance.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
obOid
Binary string value.
onLenOid
Binary string length.
o GetPrimaryType
public GetPrimaryType( const ocPrimaryType)
Returns the name of object base type.
Role: Returns the name of object base type, ie the ENOVIA standard object class that will be customized on site.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocPrimaryType
Type Name of the base object.
o GetSecondaryType
public GetSecondaryType( const ocSecondaryType)
Returns the name of final object type.
Role: Returns the name of object type, ie the real name of ENOVIA object.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocSecondaryType
Type Name of the object.
o GetTimeStamp
public GetTimeStamp( const ocTimeStamp)
Returns date & time of the Object node.
Role: Enables to know object timestamp at time information has been extracted.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocTimeStamp
Date & time information.
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)
CCYY-MM-DDThh:mm:ss "2000-00-01T00:00:01"
CCYY-MM-DDThh:mm "2000-00-01T00:00"
CCYY-MM-DD "2000-00-01" No time information set to 00:00:00
hh:mm:ss "12:00:00" means today at noon
hh:mm "14:00" means today at 2 pm

Where:
CC represents the century component
YY represents the year within century
MM represents months starting with January [1, 12]
DD represents the day in the month [1, 31]
hh represents hours from beginning of days
mm represents minutes
ss represents seconds
o GetTypeId
public GetTypeId( const ocSecondaryTypeOid,
onLength)
Returns the internal id (Oid) of the object type.
Role: Returns the binary value corresponding internal id (Oid) of the object type.
Returns:
Method return code
Legal values: Returns 0 if operation runs well.
Parameters:
ocSecondaryTypeOid
Binary string value.
onLength
Binary string length.
o Print
public virtual Print( nLevel= 0 )
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 operator=
public operator=( const ixNode)
Assignment operator from another object node.
Parameters:
ixNode
Object used as reference for the assignment.

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

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