All Frameworks Class Hierarchy This Framework Indexes
ENOVIAPlugIn Class ENOVPublishStream
Usage: you must use this class as is. You should never derive it.
public class ENOVPublishStream
Class enabling to manage publishing stream.
Role: This class enables to manage the publishing stream. The
publishing stream is a technique that enables, for an external application,
to view, modify and keep an extract of some ENOVIA Objects.
For example, we use this technique in CATIA V4 integration in which
we expose, at CATIA model load time, information relative to document management
(such as Document Master, Revision and iteration). This enables the application to
use this information as input for their design (for instance for title block)
and potentially to update it at any save time.
Information is exposed as a tree structure of information where each node is typed
and on which you can valuate some tags.
Publishing Stream node is a root of this tree structure.
Tags define on Publishing stream:
- Version Software level used to generate the stream ("1" for the current version).
- Localization ENOVIA repository location (For future use).
- TimeStamp Date & time of the publishing stream.
This Publishing stream will also enable to expose back information to ENOVIA LCA.
Constructor and Destructor Index
- o
ENOVPublishStream(char*)
- Constructs a Publishing stream.
- o
~ENOVPublishStream()
-
- o
ENOVPublishStream(ENOVPublishStream&)
- Copy constructor.
Method Index
- o
GetStream(char*&,int&)
- Builds a stream from published information.
- o
GetTimeStamp(char*&)
- Returns date & time of the publishing stream.
- o
GetVersion(int&)
- Returns software level used to generate this publishing stream.
- o
LoadStreamFromFile(char*,int)
- Loads a stream from a file.
- o
LoadStream(char*,int)
- Loads a stream from a buffer.
- o
Print(int)
- Print a report on standard output.
- o
SaveStreamAsFile(char*)
- Builds a stream from published information.
- o
operator=(ENOVPublishStream&)
- Assignment operator from another object node.
Constructor and Destructor
o ENOVPublishStream
| public ENOVPublishStream( | const | icLocalization | = NULL ) |
-
Constructs a Publishing stream.
- Parameters:
-
- icLocalization
- Define ENOVIA repository name (this information is optional and not
used in current version).
o ~ENOVPublishStream
| public virtual ~ENOVPublishStream( | ) |
-
o ENOVPublishStream
| public ENOVPublishStream( | const | ixStream) |
-
Copy constructor.
- Parameters:
-
- ixStream
- Object to be duplicated.
Methods
o GetStream
| public GetStream( | const | ocContent, |
| | onLengthContent) |
-
Builds a stream from published information.
Role: Builds a stream from published information.
Postcondition: If operation does not succeed, the output text
will be unallocated and set to NULL.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- ocContent
- Memory area allocated by this method and that contains a XML stream equivalent
to information defined in the Publishing Stream object.
- onLengthContent
- Length in byte of the XML publishing stream.
o GetTimeStamp
| public GetTimeStamp( | const | ocTimeStamp) |
-
Returns date & time of the publishing stream.
Role: Enables to know at what date this information has been
generated.
- 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 GetVersion
| public GetVersion( | | onVersion) |
-
Returns software level used to generate this publishing stream.
Role: Returns level of software used to build this object.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- onVersion
- Define software version of this Publishing stream (Current value is 1).
o LoadStreamFromFile
| public LoadStreamFromFile( | const | icFilePath, |
| | ilReplace | = 1 ) |
-
Loads a stream from a file.
Role: Loads a stream from a file.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- icFilePath
- XML File to be read to load information of the publishing stream.
- ilReplace
- Define what happens against previous information in this Publishing stream
Legal values: If lReplace is true, all children previously load are deleted.
o LoadStream
| public LoadStream( | const | icContent, |
| | ilReplace | = 1 ) |
-
Loads a stream from a buffer.
Role: Loads a stream from a buffer.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- icContent
- XML stream that contains information of the publishing stream.
- ilReplace
- Define what happens against previous information in this Publishing stream
Legal values: If lReplace is true, all children previously load are deleted.
o Print
| public virtual Print( | | inLevel | = 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 SaveStreamAsFile
| public SaveStreamAsFile( | const | icFilePath) |
-
Builds a stream from published information.
Role: Builds a stream from published information.
- Returns:
- Method return code
Legal values: Returns 0 if operation runs well.
- Parameters:
-
- icFilePath
- File name where to store information of the publishing stream as
an XML stream.
o operator=
| public operator=( | const | ixStream) |
-
Assignment operator from another object node.
- Parameters:
-
- ixStream
- Object used as reference for the assignment.
This object is included in the file: ENOVPublishStream.h
If needed, your Imakefile.mk should include the module: ENOVIAPubStream